Difference between revisions of "Species.tbl"

From FreeSpace Wiki
Jump to: navigation, search
(initial page commit)
 
(Update documentation)
 
(9 intermediate revisions by 5 users not shown)
Line 1: Line 1:
Species table is ued to define the various '''intelligence''' clips found from tech room.
+
{{TableVersion|5154}}
 +
{{Tables}}
 +
The '''species.tbl''' is used to define the various '''intelligence''' clips found from tech room.
 +
{{Table224| This table can also be called '''intel.tbl'''}}
  
==Format==
 
*Table begins directly with the data entries each starting with '''$Entry:'''.
 
*Table '''''does not''''' have any kind of end marker.
 
  
==Intelligence entry==
+
This table is one of the [[Modular Tables]] and can be extended with xxx-intl.tbm
*The same as the '''$Entry:'''
+
 
 +
==Format and Info==
 +
*Table begins with the intelligence data entries, each one starting with '''$Entry:'''
 +
*Table '''''does not''''' have any kind of end marker
 +
{{Table224|
 +
*Can begin with #Intel and end with #End}}
 +
*Table has a [[Engine_limitations|limit]] of 75 entries in total.
 +
{{Table220|
 +
*Limit removed}}
 +
*'''''Important:''''' Each description text is limited to a maximum length of 5120 characters. Longer entries will not appear in the techroom. Should a text be too long it needs to be shortened or split into multiple ones.
 +
 
 +
==Intelligence Entry==
 +
 
 +
 
 +
===$Entry:===
 +
*Begins the intelligence data entry
 +
 
  
 
===$Name:===
 
===$Name:===
*Defines the name of the intelligence entry. Number refers to the translations found from [[tstrings.tbl]].
+
*Defines the name of the intelligence entry. Number refers to the translations found from [[tstrings.tbl]]
*Syntax: XSTR("'''string'''", '''integer''')
+
*Syntax: XSTR("'''String'''", '''Integer''')
 +
 
 +
 
 +
===+nocreate===
 +
{{Table224|
 +
*Allows editing of an intel entry without creating a new entry}}
 +
 
  
 
===$Anim:===
 
===$Anim:===
 
*Defines the name of the animation used for the intelligence entry
 
*Defines the name of the animation used for the intelligence entry
*Syntax: ''string''
+
*Syntax: '''String'''
 +
{{Table224|
 +
*This field is now optional}}
 +
 
  
 
===$AlwaysInTechRoom:===
 
===$AlwaysInTechRoom:===
*Sets the entry to appear form the beginning of campaings. If set to '0' the entry has to be triggered with sexps during the campaign.
+
*Sets the entry to appear form the beginning of campaigns. If set to '0' or false the entry has to be triggered with sexps during the campaign
*Syntax: ''integer'' (0 or 1)
+
*Syntax: '''Integer''' (0 or 1)
 +
{{Table224|
 +
*Syntax: '''Boolean'''
 +
*This field is now optional, defaults to false}}
 +
 
  
 
===$Description:===
 
===$Description:===
*Sets the description shown when the intelligence entry is viewed in tech room. Number refers to the translations found from [[tstrings.tbl]]. Ends always to '''$end_multi_text'''
+
*Sets the description shown when the intelligence entry is viewed in tech room. Number refers to the translations found from [[tstrings.tbl]].  
*Syntax: XSTR("'''string'''", '''integer''')
+
*Ends with '''$end_multi_text'''
 +
*Syntax: XSTR("'''String'''", '''integer''')
 +
{{Table224|
 +
*This field is now optional}}
 +
 
  
 
==Sample==
 
==Sample==
*Part of and Retail FreeSpace 2 entry
+
*A Retail FreeSpace 2 entry
 +
 
 
<pre>$Entry:
 
<pre>$Entry:
 
$Name: XSTR("The Great War",3184)
 
$Name: XSTR("The Great War",3184)

Latest revision as of 19:54, 18 October 2022

Revision information.....

FSO Revision: 5154
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
Curves.tbl* /math/curves.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
Keywords.tbl* Not In Codebase
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
Options.tbl* Not In Codebase
Particle effects(-part.tbm)** /particle/effects...
Post_processing.tbl /graphics/gropenglpostprocessing.cpp
Rank.tbl* /stats/scoring.cpp
Scpui.tbl* Not In Codebase
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 species.tbl is used to define the various intelligence clips found from tech room.

FS2 Open, 23.0: This table can also be called intel.tbl


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

Format and Info

  • Table begins with the intelligence data entries, each one starting with $Entry:
  • Table does not have any kind of end marker
FS2 Open, 23.0:
  • Can begin with #Intel and end with #End
  • Table has a limit of 75 entries in total.
  • FS2 Open, 22.0:
    • Limit removed
  • Important: Each description text is limited to a maximum length of 5120 characters. Longer entries will not appear in the techroom. Should a text be too long it needs to be shortened or split into multiple ones.
  • Intelligence Entry

    $Entry:

    • Begins the intelligence data entry


    $Name:

    • Defines the name of the intelligence entry. Number refers to the translations found from tstrings.tbl
    • Syntax: XSTR("String", Integer)


    +nocreate

    FS2 Open, 23.0:
    • Allows editing of an intel entry without creating a new entry


    $Anim:

    • Defines the name of the animation used for the intelligence entry
    • Syntax: String
    FS2 Open, 23.0:
    • This field is now optional


    $AlwaysInTechRoom:

    • Sets the entry to appear form the beginning of campaigns. If set to '0' or false the entry has to be triggered with sexps during the campaign
    • Syntax: Integer (0 or 1)
    FS2 Open, 23.0:
    • Syntax: Boolean
    • This field is now optional, defaults to false


    $Description:

    • Sets the description shown when the intelligence entry is viewed in tech room. Number refers to the translations found from tstrings.tbl.
    • Ends with $end_multi_text
    • Syntax: XSTR("String", integer)
    FS2 Open, 23.0:
    • This field is now optional


    Sample

    • A Retail FreeSpace 2 entry
    $Entry:
    $Name: XSTR("The Great War",3184)
    $Anim: Intel_Great_War
    $AlwaysInTechRoom: 1
    $Description:
    XSTR(
    "In 2335, the Terran-Vasudan War entered its fourteenth year...", 3185)
    $end_multi_text