Objecttypes.tbl

From FreeSpace Wiki
Revision as of 08:08, 9 October 2010 by Wanderer (talk | contribs) (update)
Jump to: navigation, search
This feature requires SCP

Revision information.....

SVN revision: 6581
Note: Please update the version number when the page is updated. If your edit had nothing to do with new code entries then please do not edit the version numbers



Objecttypes.tbl is a table added by the FSSCP, used to set attributes of different object types. Currently the only section of this table are ship type attributes. A ship 'type' supercedes ship classes defined in ships.tbl. For example, the GTF Perseus and GTF Ulysses belong to the 'fighter' ship type. However, the GTD Orion belongs to the 'capital' ship type.


Note that objecttypes.tbl is fully XMT-compliant, with the suffix *-obt.tbm. In addition, the retail hardcoded types are being ported over to the objecttypes.tbl via an in-code table. So if a mod wishes to expand on the original types rather than replace them entirely, it should use a modular table file rather than a normal .tbl. Otherwise the in-code table will be ignored in favor of the one included in the mod, and the retail types will not be loaded (unless the mod includes them in its .tbl)


Note that a number of aspects of the retail types are still hardcoded, although they may be moved to the objecttypes.tbl if a mod requests it.


General Format

#Target Priorities

All set target priorities function on additive basis. For example setting 'object type' "ship" already includes all the ships in the game.

$Name:

FS2 Open, 3.6.12:
  • Name of target priority group.
  • Syntax: String

+Object Type:

FS2 Open, 3.6.12:
  • The object types which belong to this target priority group.
  • Syntax: String
    • Example: ship
    • Options
"ship"
"asteroid"
"weapon"

+Weapon Class:

FS2 Open, 3.6.12:
  • Name of weapon classes which belong to this target priority group.
  • Syntax: String list, names of the weapons
  • Example: ( "Cyclops" "Tsunami")

+Object Flags:

FS2 Open, 3.6.12:
  • The object flags which make their owners belong to this target priority group.
  • Syntax: String list
    • Options:
"no shields"
"targetable as bomb"

+Ship Class Flags:

FS2 Open, 3.6.12:
  • The ship class flags which make their owners belong to this target priority group.
  • Syntax: String list
    • Valid Options:
"afterburners"
"big damage"
"has awacs"

+Weapon Class Flags:

FS2 Open, 3.6.12:
  • The weapon class flags which make their owners belong to this target priority group.
  • Syntax: String list
    • Valid Options:
"bomb"
"huge damage"
"supercap damage"
"bomber+"
"electronics"
"puncture"
"emp"
"heat seeking"
"aspect seeking"
"engine seeking"
"pierce shields"
"local ssm"
FS2 Open, 3.6.14:
"capital+"


#End

#Weapon Targeting Priorities

$Name:

FS2 Open, 3.6.12:
  • Name of the weapon for which the target priorities are set
  • Syntax: String, name of the weapon


+Target Priority:

FS2 Open, 3.6.12:
  • Names (in order) of the target priorities set for this ship
  • Syntax: String list


#End

#Ship Types

$Name:

FS2 Open 3.6.10:
  • Name of ship type. To assign a ship class to a given type, simply place the name entered here in the ship class's "$Flags:" field.
  • Syntax: String


+nocreate

FS2 Open 3.6.10:


$Target Priority Groups:

FS2 Open, 3.6.12:
  • Defines the target priority groups ships of this objecttype belong to
  • Syntax: String list
  • +Override
    • Replaces the objecttypes existing groupings


$Counts for Alone:

FS2 Open 3.6.10:
  • Whether ship counts for determing whether or not Freespace 2 will play the "No reinforcements are available" message.
  • Syntax: Boolean, Yes or No


$Praise Destruction:

FS2 Open 3.6.10:
  • Whether wingmates will praise destruction of the ship.
  • Syntax: Boolean, Yes or No


$On Hotkey List:

FS2 Open 3.6.10:
  • Whether ship will show up in hotkey screen.
  • Syntax: Boolean, Yes or No


$Target as Threat:

FS2 Open 3.6.10:
  • Whether ship will be targetted with the 'H' key.
  • Syntax: Boolean, Yes or No


$Scannable:

FS2 Open 3.6.10:
  • Toggles whether ship type can be scanned
  • Syntax: Boolean, Yes or No


$Warp Pushes:

FS2 Open 3.6.10:
  • Whether ship will push other (pushable) ships out of the way while warping.
  • Syntax: Boolean, Yes or No


$Warp Pushable:

FS2 Open 3.6.10:
  • Whether ship can be pushed out of the way by ships with Warp Pushes enabled
  • Syntax: Boolean, Yes or No


$Turrets prioritize ship target:

FS2 Open, 3.6.12:
  • Defines that ships turrets prioritize ships current target above normal turret targeting priorities
  • Syntax: Boolean, Yes or No

$Max Debris Speed:

FS2 Open 3.6.10:
  • Defined the maximum speed for debris form this shiptype
  • Syntax: float


$FF Multiplier:

FS2 Open 3.6.10:
  • Friendly-fire damage to ship will be multiplied by this amount
  • Syntax: Float


$EMP Multiplier:

FS2 Open 3.6.10:
  • EMP effect will be multiplied by this amount. Higher values mean more HUD jittering/longer-lasting effect.
  • Syntax: Float


$Beams Easily Hit:

FS2 Open 3.6.10:
  • Whether beams can easily hit ship (eg capship beams rarely hit fighters)
  • Syntax: Boolean, Yes or No


$Protected on cripple:

FS2 Open, 3.6.14:
  • If ship should be protected when its subsystems are being targeted
  • Syntax: Boolean, Yes or No


$No Huge Beam Impact Effects:

FS2 Open, 3.6.12:
  • Defines if the huge beams will generate impact effects on ships of this type
  • Syntax: Boolean


$Don't display class in briefing:

FS2 Open, 3.6.14:
  • Option to prevent ship class data from being shown during the briefings
  • Syntax: Boolean


$Fog:

+Start Dist:

FS2 Open 3.6.10:
  • Distance from camera that fogging effect will start
  • Syntax: Float


+Compl Dist:

FS2 Open 3.6.10:
  • Distance from camera that this object will be completely obscured by the fogging effect
  • Syntax: Float


$AI:

+Valid Goals:

FS2 Open 3.6.10:
  • Valid goals that can be given to this object.
  • Syntax: ( "String" "String" )
  • Goals:
    • attack ship
    • dock
    • waypoints
    • waypoints once
    • depart
    • attack subsys
    • form on wing
    • undock
    • attack wing
    • guard ship
    • disable ship
    • disarm ship
    • attack any
    • ignore ship
    • ignore ship (new)
    • guard wing
    • evade ship
    • stay near ship
    • keep safe dist
    • rearm ship
    • stay still
    • play dead
    • attack weapon
    • fly to ship


+Accept Player Orders:

FS2 Open 3.6.10:
  • Whether or not ship type will accept orders from player
  • Syntax: Yes/No


+Player Orders:

FS2 Open 3.6.10:
  • Orders that ship type will accept from player
  • Syntax: ( "String" "String" )
  • Orders:
    • attack ship
    • disable ship
    • disarm ship
    • disable subsys
    • guard ship
    • ignore ship
    • form on wing
    • cover me
    • attack any
    • depart
    • dock
    • rearm me
    • abort rearm
    • stay near me
    • stay near ship
    • keep safe dist


+Auto Attacks:

FS2 Open 3.6.10:
  • Whether or not ship type will auto attack nearby ships
  • Syntax: Boolean, Yes or No


+Attempt broadside:

FS2 Open 3.6.10:
  • Whether or not ship type will try to use broadside tactics against enemy ships
  • Syntax: Boolean, Yes or No


+Actively Pursues:

FS2 Open 3.6.10:
  • Which ship types the current ship type will actively pursue (rather than simply return to guard position or whatnot)
  • Syntax: ( "String" "String" ), shiptypes


+Guards Attack this:

FS2 Open 3.6.10:
  • Whether ships assigned to guard another ship will attempt to engage ships of the type
  • Syntax: Boolean, Yes or No


+Turrets Attack This:

FS2 Open 3.6.10:
  • Whether or not turrets will target the ships of the type
  • Syntax: Boolean, Yes or No


+Can Form Wing:

FS2 Open 3.6.10:
  • Whether or not ship type can be formed into a wing
  • Syntax: Boolean, Yes or No


+Active Docks:

FS2 Open 3.6.10:
  • Preferred docking bay type for ship when it is initiating the dock with another ship
  • Syntax: ( "String" "String" ), names of the dock bays
  • Dock bays:
    • cargo
    • rearm
    • generic


+Passive Docks:

FS2 Open 3.6.10:
  • Preferred docking bay type for ship when it is receiving a dock from another ship
  • Syntax: ( "String" "String" )
  • Dock bays:
    • cargo
    • rearm
    • generic


+Ignored on cripple by:

FS2 Open, 3.6.14:
  • Defines the ship types which ignore this ship if its has been crippled
  • Syntax: String list, ( "string" "string" )


$Explosion Animations:

FS2 Open 3.6.10:
  • Defines the animations used with the objecttype
  • Syntax: Integer list


$Vaporize Percent Chance:

FS2 Open, 3.6.12:
  • Allows ships to sometimes explode instantly (vaporize) instead of going through a death roll first. This can be overriden on a per-ship basis in ships.tbl.
  • Syntax: Float, percent chance of vaporization

#End

Examples

Part of the Default FreeSpace 2 Table

  • Shiptypes Stealth and Fighter/Bomber do not seem to be used
$Name:                  Navbuoy
$Max Debris Speed:      200
$FF Multiplier:         1.0
$EMP Multiplier:        10.0
$Fog:
   +Start dist:            10.0
   +Compl dist:            500.0
$AI:
   +Actively Pursues:      (  "navbuoy"
                              "sentry gun"
                              "escape pod"
                              "cargo"
                              "support"
                              "stealth"
                              "fighter"
                              "bomber"
                              "fighter/bomber"
                              "transport"
                              "freighter"
                              "awacs"
                              "gas miner"
                              "cruiser"
                              "corvette"
                              "capital"
                              "super cap"
                              "drydock"
                              "knossos device" )
   +Turrets attack this:   YES
$Vaporize Percent Chance: 0.0

$Name:                  Sentry Gun
$Counts for Alone:      YES
$On Hotkey List:        YES
$Target as Threat:      YES
$Show Attack Direction: YES
$Max Debris Speed:      200
$FF Multiplier:         0.10
$EMP Multiplier:        10.0
$Fog:
   +Start dist:            10.0
   +Compl dist:            500.0
   +Disappear factor:      1.5
$AI:
   +Accept Player Orders:  NO
   +Auto attacks:          YES
   +Actively Pursues:      (  "navbuoy"
                              "sentry gun"
                              "escape pod"
                              "cargo"
                              "support"
                              "stealth"
                              "fighter"
                              "bomber"
                              "fighter/bomber"
                              "transport"
                              "freighter"
                              "awacs"
                              "gas miner"
                              "cruiser"
                              "corvette"
                              "capital"
                              "super cap"
                              "drydock"
                              "knossos device" )
   +Guards attack this:    YES
   +Turrets attack this:   YES
$Vaporize Percent Chance: 0.0

$Name:                  Cargo
$Scannable:             YES
$Max Debris Speed:      200
$FF Multiplier:         0.10
$EMP Multiplier:        10.0
$Beams Easily Hit:      YES
$Fog:
   +Start dist:            10.0
   +Compl dist:            500.0
   +Disappear factor:      1.5
$AI:
   +Passive docks:         (  "cargo" )
$Vaporize Percent Chance: 0.0

$Name:                  support
$Counts for Alone:      YES
$Praise Destruction:    YES
$On Hotkey List:        YES
$Target as Threat:      YES
$Show Attack Direction: YES
$Warp Pushable:         YES
$Max Debris Speed:      200
$FF Multiplier:         1.0
$EMP Multiplier:        3.5
$Fog:
   +Start dist:            10.0
   +Compl dist:            500.0
   +Disappear factor:      1.5
$AI:
   +Valid goals:           (  "fly to ship"
                              "dock"
                              "undock"
                              "waypoints"
                              "waypoints once"
                              "stay near ship"
                              "keep safe dist"
                              "stay still"
                              "play dead" )
   +Accept Player Orders:  YES
   +Player orders:         (  "rearm me"
                              "abort rearm"
                              "stay near me"
                              "stay near ship"
                              "keep safe dist"
                              "depart" )
   +Auto attacks:          YES
   +Actively Pursues:      (  "navbuoy"
                              "sentry gun"
                              "escape pod"
                              "cargo"
                              "support"
                              "stealth"
                              "fighter"
                              "bomber"
                              "fighter/bomber"
                              "transport"
                              "freighter"
                              "awacs"
                              "gas miner"
                              "cruiser"
                              "corvette"
                              "capital"
                              "super cap"
                              "drydock"
                              "knossos device" )
   +Guards attack this:    YES
   +Turrets attack this:   YES
   +Active docks:          (  "support" )
$Vaporize Percent Chance: 0.0

$Name:                  Fighter
$Counts for Alone:      YES
$Praise Destruction:    YES
$On Hotkey List:        YES
$Target as Threat:      YES
$Show Attack Direction: YES
$Warp Pushable:         YES
$Max Debris Speed:      200
$FF Multiplier:         1.0
$EMP Multiplier:        4.0
$Fog:
   +Start dist:            10.0
   +Compl dist:            500.0
   +Disappear factor:      1.5
$AI:
   +Valid goals:           (  "fly to ship"
                              "attack ship"
                              "waypoints"
                              "waypoints once"
                              "depart"
                              "attack subsys"
                              "attack wing"
                              "guard ship"
                              "disable ship"
                              "disarm ship"
                              "attack any"
                              "ignore ship"
                              "ignore ship (new)"
                              "guard wing"
                              "evade ship"
                              "stay still"
                              "play dead"
                              "stay near ship"
                              "keep safe dist" )
   +Accept Player Orders:  YES
   +Player Orders:         (  "attack ship"
                              "disable ship"
                              "disarm ship"
                              "guard ship"
                              "ignore ship"
                              "ignore ship (new)"
                              "form on wing"
                              "cover me"
                              "attack any"
                              "depart"
                              "disable subsys" )
   +Auto attacks:       YES
   +Actively Pursues:      (  "navbuoy"
                              "sentry gun"
                              "escape pod"
                              "cargo"
                              "support"
                              "stealth"
                              "fighter"
                              "bomber"
                              "fighter/bomber"
                              "transport"
                              "freighter"
                              "awacs"
                              "gas miner"
                              "cruiser"
                              "corvette"
                              "capital"
                              "super cap"
                              "drydock"
                              "knossos device" )
   +Guards attack this:    YES
   +Turrets attack this:   YES
   +Can Form Wing:         YES
   +Passive docks:         (  "support" )
$Vaporize Percent Chance: 0.0

$Name:                  Bomber
$Counts for Alone:      YES
$Praise Destruction:    YES
$On Hotkey List:        YES
$Target as Threat:      YES
$Show Attack Direction: YES
$Warp Pushable:         YES
$Max Debris Speed:      200
$FF Multiplier:         1.0
$EMP Multiplier:        4.0
$Fog:
   +Start dist:            10.0
   +Compl dist:            500.0
   +Disappear factor:      1.5
$AI:
   +Valid goals:           (  "fly to ship"
                              "attack ship"
                              "waypoints"
                              "waypoints once"
                              "depart"
                              "attack subsys"
                              "attack wing"
                              "guard ship"
                              "disable ship"
                              "disarm ship"
                              "attack any"
                              "ignore ship"
                              "ignore ship (new)"
                              "guard wing"
                              "evade ship"
                              "stay still"
                              "play dead"
                              "stay near ship"
                              "keep safe dist" )
   +Accept Player Orders:  YES
   +Player Orders:         (  "attack ship"
                              "disable ship"
                              "disarm ship"
                              "guard ship"
                              "ignore ship"
                              "ignore ship (new)"
                              "form on wing"
                              "cover me"
                              "attack any"
                              "depart"
                              "disable subsys" )
   +Auto attacks:          YES
   +Actively Pursues:      (  "navbuoy"
                              "sentry gun"
                              "escape pod"
                              "cargo"
                              "support"
                              "stealth"
                              "fighter"
                              "bomber"
                              "fighter/bomber"
                              "transport"
                              "freighter"
                              "awacs"
                              "gas miner"
                              "cruiser"
                              "corvette"
                              "capital"
                              "super cap"
                              "drydock"
                              "knossos device" )
   +Guards attack this:    YES
   +Turrets attack this:   YES
   +Can Form Wing:         YES
   +Passive docks:         (  "support" )
$Vaporize Percent Chance: 0.0

$Name:                  Freighter
$Counts for Alone:      YES
$Praise Destruction:    YES
$On Hotkey List:        YES
$Target as Threat:      YES
$Show Attack Direction: YES
$Scannable:             YES
$Max Debris Speed:      150
$FF Multiplier:         1.0
$EMP Multiplier:        1.75
$Beams Easily Hit:      YES
$Fog:
   +Start dist:            10.0
   +Compl dist:            600.0
   +Disappear factor:      2.0
$AI:
   +Valid goals:           (  "fly to ship"
                              "attack ship"
                              "attack wing"
                              "dock"
                              "waypoints"
                              "waypoints once"
                              "depart"
                              "undock"
                              "stay still"
                              "play dead"
                              "stay near ship" )
   +Accept Player Orders:  YES
   +Player Orders:         (  "attack ship"
                              "dock"
                              "depart" )
   +Auto attacks:          YES
   +Attempt Broadside:     YES
   +Actively Pursues:      (  "transport"
                              "freighter"
                              "awacs"
                              "gas miner"
                              "cruiser"
                              "corvette"
                              "capital"
                              "super cap"
                              "drydock"
                              "knossos device" )
   +Guards attack this:    YES
   +Turrets attack this:   YES
   +Can Form Wing:         YES
   +Active docks:          (  "cargo" )
   +Passive docks:         (  "support" )
$Vaporize Percent Chance: 0.0

$Name:                  Cruiser
$Counts for Alone:      YES
$Praise Destruction:    YES
$On Hotkey List:        YES
$Target as Threat:      YES
$Show Attack Direction: YES
$Max Debris Speed:      150
$FF Multiplier:         1.0
$EMP Multiplier:        0.9
$Beams Easily Hit:      YES
$Fog:
   +Start dist:            10.0
   +Compl dist:            600.0
   +Disappear factor:      2.0
$AI:
   +Valid goals:           (  "fly to ship"
                              "attack ship"
                              "attack wing"
                              "dock"
                              "waypoints"
                              "waypoints once"
                              "depart"
                              "undock"
                              "stay still"
                              "play dead"
                              "stay near ship" )
   +Accept Player Orders:  YES
   +Player Orders:         (  "attack ship"
                              "depart" )
   +Auto attacks:          YES
   +Attempt Broadside:     YES
   +Actively Pursues:      (  "transport"
                              "freighter"
                              "awacs"
                              "gas miner"
                              "cruiser"
                              "corvette"
                              "capital"
                              "supercap"
                              "drydock"
                              "knossos" )
   +Guards attack this:    YES
   +Turrets attack this:   YES
   +Can Form Wing:         YES
   +Passive docks:         (  "support" )
$Vaporize Percent Chance: 0.0