Ships.tbl

From FreeSpace Wiki
Revision as of 00:24, 13 November 2005 by Black Wolf (talk | contribs)
Jump to: navigation, search

Made following the older guide (originally written by GE) by Wanderer

Contents

Retail FS2 Table Options

$Name:

  • Model name that is used also in game. It is also used as name for the whole ship entry.
  • Syntax: name,
    • Example: Ulysses

$Short name:

  • Shortened model name, for FRED, Usually more descriptive than the real name.
  • Syntax: name,
    • Example: TFight

$Species:

  • Defines species (Terran, Vasudan or Shivan). Determines many things, including the color of the engine glow, the flyby sound effects, the briefing icon and the support ship
  • Syntax: Terran, Shivan or Vasudan
    • Example: Terran

Technical description

List of discriptive terms for techroom and ship selection screens

  +Type:                     XSTR("", -1)
  +Maneuverability:          XSTR("", -1)
  +Armor:                    XSTR("", -1)
  +Manufacturer:             XSTR("", -1)
  +Description:              XSTR("", -1)
  $end_multi_text
  +Tech Description:         XSTR("", -1)
  $end_multi_text
  +Length:                   20 m
  +Gun Mounts:               4
  +Missile Banks:            1

$POF file:

  • filename of the model file (.pof) at data/models folder
  • Syntax: Filename.pof
    • Example: fighter01.pof

$Detail distance:

  • Definies the distance where the change between different Levels-Of-Details (LODs) occurs
  • Syntax: (Value, Value, ...) (distances from the model in meters)
    • Example: (0, 80, 300, 900)

$ND:

  • No Dim field field was used in FS1 for ship lights. Nowadays we use glowmaps.
  • Syntax: "Value, Value, Value (Red, Green, Blue respectively, value from 0 to 255)
    • Example: 42, 42, 224

$Show damage:

  • ?????
  • Syntax: YES or NO

$Density:

  • ?????
  • Syntax: Value, usually 1

$Damp:

  • Damp affects how quickly you will accel/decel to your target velocity. Higher damp means slow acceleration and deceleration. The lower this number, the faster the ship responds. For example, specifying a value of 0.0 means there is no damping, in other words, people would say, "this has no physics, like Wing Commander." The more damping, the harder to control, but the more smoothly it moves.
  • Syntax: Value

$Rotdamp:

  • Same thing, but for rotational movement.
  • Syntax: Value

$Max Velocity:

  • Defines maximum velocities with standard energy settings on x (left/right), y (up/down), and z (forward) -axis (respectively). z -axis velocity defines the maximum forward velocity
  • Syntax: Value, Value, Value, (meters per second) x-axis, y-axis, z-axis
    • Example: 0.0, 0.0, 80.0

$Rotation time:

  • Defines rotation times around the x, y, and z -axis. Number is seconds it takes to complete rotate a ship (360 degrees) around the given axis
  • Syntax: Value, Value, Value, (seconds per 360 degree turn) x-axis, y-axis, z-axis
    • Example: 3.0, 2.6, 5.0

$Rear Velocity:

  • Defines rear velocity
  • Syntax: Value, (meters per second) usually zero

$Forward accel:

  • Number of seconds needed from full stop to maximum velocity
  • Syntax: Value, (seconds)

$Forward decel:

  • Number of seconds needed from maxumum velocity to full stop
  • Syntax: Value, (seconds)

$Slide accel: and $Slide decel:

  • Same for sliding as the $Forward accel: and $Forward decel: for normal movement.
  • Syntax: Value, (seconds) for both

$Expl inner rad:

  • Radius at which the full explosion damage is done
  • Syntax: Value, (meters)

$Expl outer rad:

  • Maximum radius at which any damage is done
  • Syntax: Value, (meters)

$Expl damage:

  • Amount of damage done inside the inner radius
  • Syntax: Value, (damage value)

$Expl blast:

  • The intensity of the blast effect when you're within the outer radius
  • Syntax: Value, (blast effect)

$Expl Propagates:

  • This decides whether the ship explodes into debris immediately, or whether it has the many small explosions before breaking apart slowly
  • Syntax: YES or NO

$Shockwave Speed:

  • Speed shockwave expands at, 0 means no shockwave
  • Syntax: Value, (meters per second)

Primary Weapons

$Allowed PBanks:

  • List of allowed primary weapons in brackets (weapon name marked with quotes).
  • Syntax: ( "Flag" "Flag" )
    • Example: ( "Subach HL-7" "Prometheus R")

$Allowed Dogfight PBanks:

  • Primary weapons for multiplayer dogfights
  • Syntax: ( "Flag" "Flag" )
    • Example: ( "Subach HL-D" "Prometheus D")

$Default PBanks:

  • Defines default primary weapons for each of the primary weapon banks
  • Syntax: ( "Flag" "Flag" )
    • Example: ( "Subach HL-7" "Prometheus R")

Secondary Weapons

$Allowed SBanks:

$Allowed Dogfight SBanks:

$Default SBanks:

  • Same for secondary weapons
  • Syntax: ( "Flag" "Flag" )
    • Example: ( "Harpoon" "Hornet")

$SBank Capacity:

  • Defines ammunition capacity of secondary weapon banks. In brackets, different weapon banks separated by commas.
  • Syntax: ( Value, Value )
    • Example: ( 40, 40 )

$Shields:

  • Determines the shield strenght
  • Syntax: Value, (total hitpoints in all quadrants together)

$Shield Color:

  • RGB value for shield color
  • Syntax: "Value, Value, Value (Red, Green, Blue respectively, value from 0 to 255)
    • Example: 100, 100, 255

$Power Output:

  • The amount of energy available. The higher the output, the faster your weapons recharge.
  • Syntax: Value

$Max Oclk Speed:

  • Maximum velocity with all energy diverted to engines
  • Syntax: Value, (meters per second)

$Max Weapon Eng:

  • The maximum amount of energy you can store in your primary weapons bank.
  • Syntax: Value

$Hitpoints:

  • How much damage the ship can take
  • Syntax: Value, (hitpoints)

$Flags:

  • See below
  • Syntax: ( "Flag" "Flag" )
    • Example: ( "fighter" "in tech database" )

$AI Class:

  • Default AI class
  • Syntax: AI name, as defined in AI.tbl

$Afterburner:

  • Defines if the ships has afterburner
  • Syntax: YES or NO
  • +Aburn Max Vel:
    • In same format as in $Max Velocity:
    • Syntax: Value, (meters per second)
  • +Aburn For accel:
    • Defined only as the forward acceleration. In same format as $Forward accel:
    • Syntax: Value, (seconds)
  • +Aburn Fuel:
    • Amount of afterburner fuel the ship has
    • Syntax: Value (fuel units)
  • +Aburn Burn Rate:
    • Rate the fuel is consumed when afterburner is engaged (in units per seconds)
    • Syntax: Value (fuel units per second)
  • +Aburn Rec Rate:
    • Rate the fuel is restored.
    • Syntax: Value (fuel units per second)

$Countermeasures:

  • Number of countermeasures that can be loaded to the ship
  • Syntax: Value

$Scan time:

  • Time it takes to scan the ship
  • Syntax: Value, (milliseconds)

$EngineSnd:

  • Engine sound used for the ship with number referring to sounds.tbl
  • Syntax: Value, identification number of the sound as defined in sounds.tbl

$Closeup_pos:

  • How the model will show at techroom. The position of the camera relative to the model in the tech room and the target box view
  • Syntax: Value, Value, Value, (X, Y and Z values)

$Closeup_zoom:

  • How the model will show at techroom. How far the camera's zoomed in.
  • Syntax: Value

$Shield_icon:

  • This .ani file must be at data/hud and included to the hud.tbl
  • Syntax: Filename
    • Example: shield-f01

$Ship_icon:

  • The icon used in ship selection
  • Syntax: Filename
    • Example: iconfighter01

$Ship_anim:

  • The glowing green grid animation used in ship selection
  • Syntax: Filename
    • Example: ssfighter01

$Ship_overhead:

  • The overhead view used in the weapons loadout
  • Syntax: Filename
    • Example: loadfighter01

$Score:

  • Points awarded for destroying the ship
  • Syntax: Value, (points)

$Trail:

  • These are the origins of the white contrails that appear in the nebula missions. Ship may have multiple trails.
  • +Offset:
    • The position of the contrail's head
    • Syntax: Value, Value, Value, (X, Y, Z values) relative to the centerpoint of the model
  • +Start Width:
    • The width of the contrail's head
    • Syntax: Value, (meters)
  • +End Width:
    • The width of the contrail's tail
    • Syntax: Value, (meters)
  • +Start Alpha:
    • The opacity of the contrail's head
    • Syntax: Value, value between 0 and 1
  • +End Alpha:
    • The opacity of the contrail's tail
    • Syntax: Value, value between 0 and 1
  • +Max Life:
    • How long the contrail remains
    • Syntax: Value, (seconds)
  • +Spew Time:
    • ????
    • Syntax: Value, (seconds)
  • +Bitmap:
    • The image to use for the contrail.
    • Syntax: Filename
      • Example: Contrail01

$Subsystem:

  • The name of the subsystem as defined in .pof file, % of ship's total hitpoints the subsystem has and rotation time (360 degrees) for multipart turrets. Note: Assinging zero to the %-hitpoint entry causes the subsystem to be without hitpoints, like fighterbays on some capital ships.
  • Syntax: Subsystem name , Value, (% of ships hitpoints) Value, (seconds per 360 degree turn) subsystem name must be the same as described in model file (.pof).
    • Example: communications, 5, 0.0

Turret

  • In addition to the previous entry sll turrets require informtion concerning the weapon mounted to the turret. The entry can be either $Default PBanks for turret primaries (including beams) or $Default SBanks for turret secondaries
  • Syntax: ( "Flag" )
    • Example: ( "Subach HL-7" )
    • Combined example for turret entry:
      • $Subsystem: turret01, 1.0, 1.0
        $Default PBanks: ( "Terran Turret" )

Ships.tbl flags

"player_ship"

"default_player_ship"

"in tech database"

"repair_rearm"

"fighter"

"bomber"

"transport"

"freighter"

"cruiser"

"corvette"

"capital"

"supercap"

"cargo"

"gas miner"

"awacs"

"navbuoy"

"sentrygun"

"drydock"

"escapepod"

"dont collide invisible"

"big damage"

"no_collide"

"knossos"

"no_fred"

SCP Table Options

$Species:

  • Location: Same as in retail.
  • Defines species (usually Terran, Vasudan or Shivan). Determines many things, including the color of the engine glow, the flyby sound effects, the briefing icon, the support ship, the default IFF, and also FRED color
  • Syntax: Name of the species, as defined in species_defs.tbl

$Glide:

  • Location: After $Slide decel:
  • Allows gliding in game
  • Syntax: YES or NO

$Warpin speed:

  • Location: After $Glide (if present) or $Slide decel:
  • Sets the speed at which the ship warps in
  • Syntax: Value

$Warpout speed:

  • Location: After $Warpin speed:
  • Sets the speed at which the ship warps out from the game
  • Syntax: Value

$Player warpout speed:

  • Location: After $Warpout speed:
  • Sets the speed at which the player warps out from the game
  • Syntax: Value, can not be greater than $Max Oclk Speed:

Primary Weapons

  • Location: Same as in retail.

$Allowed PBanks:

  • List of allowed primary weapons in brackets (weapon name marked with quotes). Each of the primary weapon banks can be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
  • Syntax: ( "Flag" "Flag" ) ( "Flag" "Flag" )

$Allowed Dogfight PBanks:

  • Primary weapons for multiplayer dogfights
  • Syntax: ( "Flag" "Flag" ) ( "Flag" "Flag" )

$Default PBanks:

  • Defines default primary weapons for each of the primary weapon banks
  • Syntax: ( "Flag" "Flag" )

$PBank Capacity:

  • Defines ammunition capacity of primary weapon banks. In brackets, different weapon banks separated by commas. REQUIRES FLAG "ballistic primaries"
  • Syntax: ( Value, Value ), usually all primary bank capacities are 1.

Secondary Weapons

  • Location: Same as in retail.

$Allowed SBanks:>

  • Same for secondary weapons
  • Syntax: ( "Flag" "Flag" ) ( "Flag" "Flag" )

$Allowed Dogfight SBanks:

  • Same for secondary weapons
  • Syntax: ( "Flag" "Flag" ) ( "Flag" "Flag" )

$Default SBanks:

  • Same for secondary weapons
  • Syntax: ( "Flag" "Flag" )

$SBank Capacity:

  • Defines ammunition capacity of secondary weapon banks. In brackets, different weapon banks separated by commas.
  • Syntax: ( Value, Value )
    • Example: ( 40, 40 )

$Hull Repair Rate:

  • Repair rates for hull at percent per second (default 0.0)
  • Syntax: Value, % of hitpoints repaired per second

$Subsystem Repair Rate:

  • Repair rates for sybsystems percent per second (default 0.2)
  • Syntax: Value, % of hitpoints repaired per second

$Armor Type

  • Location: Right after the $Hitpoinrs:
  • REQUIRES ADDITIONAL TABLE. Defines armor type used for the ship
  • Syntax: Armor name, as defined in armor.tbl

$Afterburner:

  • Location: Same as in retail
  • Defines if the ships has afterburner
  • Syntax: YES or NO
  • +Aburn Max Vel:
    • In same format as in $Max Velocity:
    • Syntax: Value, (meters per second)
  • +Aburn For accel:
    • Defined only as the forward acceleration. In same format as $Forward accel:
    • Syntax: Value, (seconds)
  • +Aburn Fuel:
    • Amount of afterburner fuel the ship has
    • Syntax: Value (fuel units)
  • +Aburn Burn Rate:
    • Rate the fuel is consumed when afterburner is engaged (in units per seconds)
    • Syntax: Value (fuel units per second)
  • +Aburn Rec Rate:
    • Rate the fuel is restored.
    • Syntax: Value (fuel units per second)
  • $Trails:
    • Allows afterburner trails to be used
    • +Bitmap:
      • Texture used to draw the afterburner trail
      • Syntax: Filename
    • +Width:
      • Width of afterburner trail at the beginning of it (ie. the thruster end)
      • Syntax: Value, (in meters)
    • +Alpha:
      • Transparancy of the trail, value from 1 (non-transparent) to 0 (totally transparent)
      • Syntax: Value
    • +Life:
      • How long the trail will last
      • Syntax: Value, (in seconds)

$Shield_icon:

  • Location: Same as in retail
  • This .ani file must be at data/hud. Hud.tbl no longer needs to be altered.
  • Syntax: Filename
    • Example: shield-f01

$Thruster Particles:

  • Defines the alternative particle thruster
  • $Thruster Particle Bitmap:
    • Name of the animation used for particle thrusters, up to three can be defined
    • Syntax: Filename, of ani file used
      • Example: Exp04
  • $Min Radius:
    • Defines the minimum radius of new particles
    • Syntax: Value, (in meters)
  • $Max Radius:
    • Defines the maximum radius of new particles
    • Syntax: Value, (in meters)
  • $Min created:
    • Defines the minimum amount of particles created per second
    • Syntax: Value, (per second)
  • $Max created:
    • Defines the maximum amount of particles created per second
    • Syntax: Value, (per second)
  • $Variance:
    • Value that describes the randomnes or particle generation, valus close to 0 will cause particles to spew very close to the thrusters normal while values close 1 will cause some particles to be spewed enen to opposite direction
    • Syntax: Value, (per second)

$Thruster Particles:

  • Defines the alternative particle afterburners (requires at least 1 particle thruster)
  • $Afterburner Particle Bitmap:
    • Name of the animation used for particle thruster afterburners, up to three can be defined
    • Syntax: Filename, of ani file used
      • Example: Exp04
  • $Min Radius:
    • Defines the minimum radius of new particles
    • Syntax: Value, (in meters)
  • $Max Radius:
    • Defines the maximum radius of new particles
    • Syntax: Value, (in meters)
  • $Min created:
    • Defines the minimum amount of particles created per second
    • Syntax: Value, (per second)
  • $Max created:
    • Defines the maximum amount of particles created per second
    • Syntax: Value, (per second)
  • $Variance:
    • Value that describes the randomnes or particle generation, valus close to 0 will cause particles to spew very close to the thrusters normal while values close 1 will cause some particles to be spewed enen to opposite direction
    • Syntax: Value, (per second)

Ships.tbl flags

Example