FreeSpace Wiki - User contributions [en]

Objecttypes.tbl

2006-04-23T03:10:18Z

The Trivial Psychic: /* +Compl Dist: */

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==
==#Ship Types==
===$Name:===
* 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.

===$Counts for Alone:===
* Whether ship counts for determing whether or not Freespace 2 will play the "No reinforcements are available" message.
* Syntax: ''Yes/No''

===$Praise Destruction:===
* Whether wingmates will praise destruction of the ship.
* Syntax: ''Yes/No''

===$On Hotkey List:===
* Whether ship will show up in hotkey screen.
* Syntax: ''Yes/No''

===$Target as Threat:===
* Whether ship will be targetted with the 'H' key.
* Syntax: ''Yes/No''

===$Scannable:===
* Toggles whether ship type can be scanned
* Syntax: ''Yes/No''

===$Warp Pushes:===
* Whether ship will push other (pushable) ships out of the way while warping.
* Syntax: ''Yes/No''

===$Warp Pushable:===
* Whether ship can be pushed out of the way by ships with Warp Pushes enabled
* Syntax: ''Yes/No''

===$Max Debris Speed:===
* Maximum speed of debris spawned from ship
* Syntax: ''Number or decimal''

===$FF Multiplier:===
* Friendly-fire damage to ship will be multiplied by this amount
* Syntax: ''Number or decimal''

===$EMP Multiplier:===
* EMP effect will be multiplied by this amount. Higher values mean more HUD jittering/longer-lasting effect.
* Syntax: ''Number or decimal''

===$Beams Easily Hit:===
* Whether beams can easily hit ship (eg capship beams rarely hit fighters)
* Syntax: ''Yes/No''

===$Fog:===
====+Start Dist:====
* Distance from camera that fogging effect will start
* Syntax: ''Number or decimal''

====+Compl Dist:====
* Distance from camera that this object will be completely obscured by the fogging effect
* Syntax: ''Number or decimal''

===$AI:===
====+Valid Goals:====
* Valid goals that can be given to this object.
* Syntax: ''( "goal" "goal" )''
* '''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:====
* Whether or not ship type will accept orders from player
* Syntax: ''Yes/No''

====+Player Orders:====
* Orders that ship type will accept from player
* Syntax: ''( "goal" "goal" )''
* '''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:====
* Whether or not ship type will auto attack nearby ships
* Syntax: ''Yes/No''

====+Attempt Broadsides:====
* Whether or not ship type will try to use broadside tactics against enemy ships
* Syntax: ''Yes/No''

====+Actively Pursues:====
* Whether or not ship type will engage ships that attack it or the ship that is currently being escorted by it.
* Syntax: ''Yes/No''

====+Guards Attack this:====
* Whether ships assigned to guard another ship will attempt to engage ships of the type
* Syntax: ''Yes/No''

====+Turrets Attack This:====
* Whether or not turrets will target the ships of the type
* Syntax: ''Yes/No''

====+Can Form Wing:====
* Whether or not ship type can be formed into a wing
* Syntax: ''Yes/No''

====+Active Docks:====
* Preferred docking bay type for ship when it is initiating the dock with another ship
* Syntax: ''( "bay" "bay" )''
* '''Dock bays:'''
** cargo
** rearm
** generic

====+Passive Docks:====
* Preferred docking bay type for ship when it is receiving a dock from another ship
* Syntax: ''( "bay" "bay" )''
* '''Dock bays:'''
** cargo
** rearm
** generic

==#End==

==Examples==
Examples are taken directly from code
===Ship Type: "Fighter"===
<pre>
$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
$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"
"sentrygun"
"escapepod"
"cargo"
"repair_rearm"
"stealth"
"fighter"
"bomber"
"fighter/bomber"
"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" )</pre>
===Ship Type: "Freighter"===
<pre>
$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
$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"
"supercap"
"drydock"
"knossos" )
+Guards attack this: YES
+Turrets attack this: YES
+Can Form Wing: YES
+Active docks: ( "cargo" )
+Passive docks: ( "support" )</pre>

[[Category: Tables]]

Objecttypes.tbl

2006-04-23T03:08:48Z

The Trivial Psychic: /* +Valid Goals: */

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==
==#Ship Types==
===$Name:===
* 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.

===$Counts for Alone:===
* Whether ship counts for determing whether or not Freespace 2 will play the "No reinforcements are available" message.
* Syntax: ''Yes/No''

===$Praise Destruction:===
* Whether wingmates will praise destruction of the ship.
* Syntax: ''Yes/No''

===$On Hotkey List:===
* Whether ship will show up in hotkey screen.
* Syntax: ''Yes/No''

===$Target as Threat:===
* Whether ship will be targetted with the 'H' key.
* Syntax: ''Yes/No''

===$Scannable:===
* Toggles whether ship type can be scanned
* Syntax: ''Yes/No''

===$Warp Pushes:===
* Whether ship will push other (pushable) ships out of the way while warping.
* Syntax: ''Yes/No''

===$Warp Pushable:===
* Whether ship can be pushed out of the way by ships with Warp Pushes enabled
* Syntax: ''Yes/No''

===$Max Debris Speed:===
* Maximum speed of debris spawned from ship
* Syntax: ''Number or decimal''

===$FF Multiplier:===
* Friendly-fire damage to ship will be multiplied by this amount
* Syntax: ''Number or decimal''

===$EMP Multiplier:===
* EMP effect will be multiplied by this amount. Higher values mean more HUD jittering/longer-lasting effect.
* Syntax: ''Number or decimal''

===$Beams Easily Hit:===
* Whether beams can easily hit ship (eg capship beams rarely hit fighters)
* Syntax: ''Yes/No''

===$Fog:===
====+Start Dist:====
* Distance from camera that fogging effect will start
* Syntax: ''Number or decimal''

====+Compl Dist:====
* Distance from camera that fogging effect will start
* Syntax: ''Number or decimal''

===$AI:===
====+Valid Goals:====
* Valid goals that can be given to this object.
* Syntax: ''( "goal" "goal" )''
* '''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:====
* Whether or not ship type will accept orders from player
* Syntax: ''Yes/No''

====+Player Orders:====
* Orders that ship type will accept from player
* Syntax: ''( "goal" "goal" )''
* '''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:====
* Whether or not ship type will auto attack nearby ships
* Syntax: ''Yes/No''

====+Attempt Broadsides:====
* Whether or not ship type will try to use broadside tactics against enemy ships
* Syntax: ''Yes/No''

====+Actively Pursues:====
* Whether or not ship type will engage ships that attack it or the ship that is currently being escorted by it.
* Syntax: ''Yes/No''

====+Guards Attack this:====
* Whether ships assigned to guard another ship will attempt to engage ships of the type
* Syntax: ''Yes/No''

====+Turrets Attack This:====
* Whether or not turrets will target the ships of the type
* Syntax: ''Yes/No''

====+Can Form Wing:====
* Whether or not ship type can be formed into a wing
* Syntax: ''Yes/No''

====+Active Docks:====
* Preferred docking bay type for ship when it is initiating the dock with another ship
* Syntax: ''( "bay" "bay" )''
* '''Dock bays:'''
** cargo
** rearm
** generic

====+Passive Docks:====
* Preferred docking bay type for ship when it is receiving a dock from another ship
* Syntax: ''( "bay" "bay" )''
* '''Dock bays:'''
** cargo
** rearm
** generic

==#End==

==Examples==
Examples are taken directly from code
===Ship Type: "Fighter"===
<pre>
$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
$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"
"sentrygun"
"escapepod"
"cargo"
"repair_rearm"
"stealth"
"fighter"
"bomber"
"fighter/bomber"
"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" )</pre>
===Ship Type: "Freighter"===
<pre>
$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
$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"
"supercap"
"drydock"
"knossos" )
+Guards attack this: YES
+Turrets attack this: YES
+Can Form Wing: YES
+Active docks: ( "cargo" )
+Passive docks: ( "support" )</pre>

[[Category: Tables]]