Difference between revisions of "Help.tbl"

From FreeSpace Wiki
Jump to: navigation, search
(+pline: clarify what the 1st arg does)
(Replaced link to list of tables with actual list on the right.)
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{TableVersion|4879}}
+
{{TableVersion|10844}}
 
+
{{Tables}}
 
The '''help.tbl''' is a file meant for defining the help texts that can be prompted for example in the mainhall and other such screens by pressing F1.
 
The '''help.tbl''' is a file meant for defining the help texts that can be prompted for example in the mainhall and other such screens by pressing F1.
  
 
+
This table is one of the [[Modular Tables]] and can be extended with xxx-hlp.tbm
[[Tables|List of Tables]]
 
  
 
==Format==
 
==Format==
 
*Table consists of several sections that are each defining their respective screens ingame. Every section starts with the name of the screen preceded with '''$''' ('''''Example:'' $ship''') and ends with '''$end'''
 
*Table consists of several sections that are each defining their respective screens ingame. Every section starts with the name of the screen preceded with '''$''' ('''''Example:'' $ship''') and ends with '''$end'''
**'''Sections:'''  
+
**'''Default sections:'''  
 
***$ship
 
***$ship
 
***$weapon
 
***$weapon
Line 25: Line 24:
 
***$tech
 
***$tech
 
***$command  
 
***$command  
 
+
{{Table371|Sections with names other than those shown above may exist. Such sections are usable only in revision 10739 and later, although they won't break earlier revisions.
 +
}}
  
 
==Sections==
 
==Sections==
Line 31: Line 31:
 
*Text, lines or brackets (left or right)
 
*Text, lines or brackets (left or right)
  
 +
===+resolutions===
 +
{{Table372|
 +
*Defines the number of resolutions in this overlay. May be 1 or greater.
 +
*If this is set to anything other than 2, then all other parameters in this overlay that normally take two sets of values must now have a set of values for each resolution. For example, if an overlay has four resolutions, then any bracket parameter must have four pairs of values instead of two.
 +
*The default value is 2.
 +
**Example: '''+resolutions 4'''}}
 +
 +
===+font===
 +
{{Table372|
 +
*Defines the font used for the text in this overlay. The number here points to a font entry in fonts.tbl, with 0 pointing to the first one.
 +
*Takes one value for each resolution.
 +
*The default value for each resolution is 0 (normally font01.vf).
 +
**Example: '''+font 0 0 0 0'''}}
  
 
===+pline===
 
===+pline===
Line 40: Line 53:
 
**4 = 3 segment lines (4 points)
 
**4 = 3 segment lines (4 points)
 
**6 = 5 segment lines (6 points)
 
**6 = 5 segment lines (6 points)
*Other values are used to define the coordinate locations on screen separately for both '''640 x 480''' and '''1024 x 768''' resolutions. Coordinates are marked as '''x1, y1, x2, y2, x3, y3''' etc - you must have enough co-ordinates to match the number specified in the 1st argument
+
*Other values are used to define the coordinate locations on screen separately for each resolution in the table. Coordinates are marked as '''x1, y1, x2, y2, x3, y3''' etc - you must have enough co-ordinates to match the number specified in the 1st argument and you must have an array for each resolution.
**First for 640 x 480 resolution followed with another array for 1024 x 768 resolution.
+
**First array for the lowest resolution, then the next largest, and so on.
 
**Example: '''+pline 4  170 320 120 320 100 340 60 340  272 512 192 512 160 544 96 544'''
 
**Example: '''+pline 4  170 320 120 320 100 340 60 340  272 512 192 512 160 544 96 544'''
  
 
===+left_bracket===
 
===+left_bracket===
 
*Draws bracket opening to left on the help screen
 
*Draws bracket opening to left on the help screen
*Is defined with two pair of numerical values
+
*Is defined with a pair of numerical values for each resolution
*Location is defined with four values, first x and y coordinates for 640 x 480 followed by x and y for the 1024 x 768.
+
*Location is defined with two values per resolution, starting with the lowest resolution.
 
**Example: '''+left_bracket 257 325 358 517'''
 
**Example: '''+left_bracket 257 325 358 517'''
  
Line 53: Line 66:
 
===+right_bracket===
 
===+right_bracket===
 
*Draws bracket opening to right on the help screen
 
*Draws bracket opening to right on the help screen
*Is defined with two pair of numerical values
+
*Is defined with a pair of numerical values for each resolution
*Location is defined with four values, first x and y coordinates for 640 x 480 followed by x and y for the 1024 x 768.
+
*Location is defined with two values per resolution, starting with the lowest resolution.
 
**Example: '''+right_bracket 257 325 358 517'''
 
**Example: '''+right_bracket 257 325 358 517'''
  
Line 60: Line 73:
 
===+text===
 
===+text===
 
*Draws text on screen
 
*Draws text on screen
*Is defined with two pair of numerical values followed by a string  
+
*Is defined with a pair of numerical values for each resolution, followed by a string  
*Location is defined with four values, first x and y coordinates for 640 x 480 followed by x and y for the 1024 x 768.
+
*Location is defined with two values per resolution, starting with the lowest resolution.
 
*Text string is placed within brackets
 
*Text string is placed within brackets
 
**XSTR("'''text'''", -1)
 
**XSTR("'''text'''", -1)

Latest revision as of 04:29, 13 October 2020

Revision information.....

FSO Revision: 10844
Note: Please update the version when the page is updated. If your edit had nothing to do with new code entries then please do not edit the version


List of Tables and related code files
* Notes Modular Tables
** Notes tables which only use modular tables
Ai.tbl /ai/aicode.cpp
Ai_profiles.tbl* /ai/ai_profiles.cpp
Animation.tbl** /model/modelanimation.cpp
Armor.tbl* /ship/ship.cpp
Asteroid.tbl /asteroid/asteroid.cpp
Autopilot.tbl /autopilot/autopilot.cpp
Cheats.tbl* /cheats_table/cheats_table.cpp
Colors.tbl* /globalincs/alphacolors.cpp
Controlconfigdefaults.tbl /controlconfig/controlsconfigcommon.cpp
Credits.tbl* /menuui/credits.cpp
Cutscenes.tbl* /cutscene/cutscenes.cpp
Decals.tbl** /decals/decals.cpp
Fireball.tbl* /fireball/fireballs.cpp
Fonts.tbl* /graphics/font.cpp
Game_settings.tbl* /mod_table/mod_table.cpp
Glowpoints.tbl* /model/modelread.cpp
Help.tbl* /gamehelp/contexthelp.cpp
Hud_gauges.tbl* /hud/hudparse.cpp
Icons.tbl* /mission/missionbriefcommon.cpp
Iff_defs.tbl* /iff_defs/iff_defs.cpp
Lighting_Profiles.tbl* /lighting/lighting_profiles.cpp
Lightning.tbl* /nebula/neblightning.cpp
Mainhall.tbl* /menuui/mainhallmenu.cpp
Medals.tbl* /stats/medals.cpp
Messages.tbl /mission/missionmessage.cpp
Mflash.tbl* /weapon/muzzleflash.cpp
Music.tbl* /gamesnd/eventmusic.cpp
Nebula.tbl* /nebula/neb.cpp
Objecttypes.tbl* /ship/ship.cpp
Particle effects(-part.tbm)** /particle/effects...
Post_processing.tbl /graphics/gropenglpostprocessing.cpp
Rank.tbl /stats/scoring.cpp
Scripting.tbl* /parse/scripting.cpp
Ships.tbl* /ship/ship.cpp
Sexps.tbl** /parse/sexp/sexp_lookup.cpp
Sounds.tbl* /gamesnd/gamesnd.cpp
Species_defs.tbl* /species_defs/species_defs.cpp
Species.tbl* /menuui/techmenu.cpp
Ssm.tbl* /hud/hudartillery.cpp
Stars.tbl* /starfield/starfield.cpp
Strings.tbl* /localization/localize.cpp
Tips.tbl* /menuui/playermenu.cpp
Traitor.tbl /stats/scoring.cpp
Tstrings.tbl* /localization/localize.cpp
Virtual_pofs.tbl* /model/modelreplace.cpp
Weapon_expl.tbl* /weapon/weapons.cpp
Weapons.tbl* /weapon/weapons.cpp

The help.tbl is a file meant for defining the help texts that can be prompted for example in the mainhall and other such screens by pressing F1.

This table is one of the Modular Tables and can be extended with xxx-hlp.tbm

Format

  • Table consists of several sections that are each defining their respective screens ingame. Every section starts with the name of the screen preceded with $ (Example: $ship) and ends with $end
    • Default sections:
      • $ship
      • $weapon
      • $briefing
      • $main
      • $barracks
      • $control
      • $debrief
      • $multicreate
      • $multistart
      • $multijoin
      • $main2
      • $hotkey
      • $campaign
      • $simulator
      • $tech
      • $command
FS2 Open, 3.7.2: Sections with names other than those shown above may exist. Such sections are usable only in revision 10739 and later, although they won't break earlier revisions.

Sections

  • Sections consist of various drawing objects
  • Text, lines or brackets (left or right)

+resolutions

FS2 Open, 3.7.2:
  • Defines the number of resolutions in this overlay. May be 1 or greater.
  • If this is set to anything other than 2, then all other parameters in this overlay that normally take two sets of values must now have a set of values for each resolution. For example, if an overlay has four resolutions, then any bracket parameter must have four pairs of values instead of two.
  • The default value is 2.
    • Example: +resolutions 4

+font

FS2 Open, 3.7.2:
  • Defines the font used for the text in this overlay. The number here points to a font entry in fonts.tbl, with 0 pointing to the first one.
  • Takes one value for each resolution.
  • The default value for each resolution is 0 (normally font01.vf).
    • Example: +font 0 0 0 0

+pline

  • Draws lines on the help screen.
  • Can be used to draw several connected lines
  • Is defined with an array of values
  • First value defined the number of points used to draw the line
    • 2 = straight line (2 points)
    • 4 = 3 segment lines (4 points)
    • 6 = 5 segment lines (6 points)
  • Other values are used to define the coordinate locations on screen separately for each resolution in the table. Coordinates are marked as x1, y1, x2, y2, x3, y3 etc - you must have enough co-ordinates to match the number specified in the 1st argument and you must have an array for each resolution.
    • First array for the lowest resolution, then the next largest, and so on.
    • Example: +pline 4 170 320 120 320 100 340 60 340 272 512 192 512 160 544 96 544

+left_bracket

  • Draws bracket opening to left on the help screen
  • Is defined with a pair of numerical values for each resolution
  • Location is defined with two values per resolution, starting with the lowest resolution.
    • Example: +left_bracket 257 325 358 517


+right_bracket

  • Draws bracket opening to right on the help screen
  • Is defined with a pair of numerical values for each resolution
  • Location is defined with two values per resolution, starting with the lowest resolution.
    • Example: +right_bracket 257 325 358 517


+text

  • Draws text on screen
  • Is defined with a pair of numerical values for each resolution, followed by a string
  • Location is defined with two values per resolution, starting with the lowest resolution.
  • Text string is placed within brackets
    • XSTR("text", -1)
    • Example: +text 25 280 40 448 XSTR("Choose your ship type.", -1)


Sample

$ship
+text 25 280 40 448 XSTR("Choose your ship type.", -1)

+text 175 304 276 496 XSTR("Choose a new ship type by dragging", -1)
+text 175 317 276 509 XSTR("its icon over one of the available", -1)
+text 175 330 276 522 XSTR("wing slots.", -1)
+pline 4  170 320 120 320 100 340 60 340  272 512 192 512 160 544 96 544
+left_bracket 169 312 270 504
+pline 6  259 335 280 335 300 355 300 377 280 397 183 397  361 527 448 527 480 559 480 603 448 635 293 635
+right_bracket 257 325 358 517

+text 337 370 565 592 XSTR("Revert to the original", -1)
+text 337 383 565 605 XSTR("ship distribution.", -1)
+pline 2  502 374 570 374  730 596 912 596
+right_bracket 499 365 727 587

+text 400 150 636 265 XSTR("When finished outfitting", -1)
+text 400 163 636 278 XSTR("all available wings,", -1)
+text 400 176 636 291 XSTR("you can go to the", -1)
+text 400 189 636 304 XSTR("weapons loadout screen", -1)
+text 400 202 636 317 XSTR("or enter the mission.", -1)
+pline 6  162 43 330 43 350 63 350 173 370 193 395 193  259 69 528 69 560 101 560 277 592 309 632 309
+left_bracket 394 184 630 299
+pline 4  554 206 588 206 608 226 608 424  790 321 941 321 973 353 973 678
+right_bracket 552 197 788 312
$end