FreeSpace Wiki - User contributions [en]

Weapons.tbl

2005-12-19T04:16:28Z

84.248.195.235:

Made following the older guide (originally written by GE) by
*Wanderer
*Contribute and include yourself here

==Special Case Weapons==
===Beam Cannons===
*'''REQUIRES: "beam" flag'''
*'''REQUIRES: [[weapons.tbl#$BeamInfo:|$BeamInfo:]]'''
===Flak Guns===
*'''REQUIRE: "flak" and "particle spew" flags'''
*Must have inner and outer radius defined to have any effect.
*Does not use any model or weapon effect though model must be defined, usually Hornet.pof. Instead it uses particle spew. Trails can also be added.

==Weapons Table==
*Retail options will look like this


*SCP options are marked with red color
**Most of the entries in ships.tbl are optional (does anyone have the default values?)


===General Format===
*The weapons table consist of several sections
*All sections beginning with <nowiki>#</nowiki> need <nowiki>#</nowiki>'''End''' before the next section.
**<nowiki>#</nowiki>'''Primary Weapons'''
***Defines all '''standard primaries weapons''' as well as '''beam cannons''' and '''flak cannons'''.
**<nowiki>#</nowiki>'''Secondary Weapons'''
***Defines all '''secondary weapons'''.
**<nowiki>#</nowiki>'''Beam Weapons'''
***I haven't got any ideas for this one.
**<nowiki>#</nowiki>'''[[Weapons.tbl#Countermeasures|Countermeasures]]'''
***Defines the used countermeasure.
**'''$Player Weapon Precedence'''
***Player Weapon Precedence is used in weapon selection when a default specified by the mission designer is not available to the player. The next weapon on the list is used in its place (assuming that weapon is allowed for the player).

===Core Table===

====$Name:====
*This is the name of the weapon. If it's going to be used by the player, keep it under 12 characters so it doesn't spill over the HUD box. If the weapon has an @ symbol in front of it, it means it's allowed in the demo. It doesn't really do anything in the retail version.
*Syntax: ''Name''


====$Subtype:====


====+Title:====
*This is the title of the weapon in the Weapons loadout screen. Only needed for player allowed weapons. Title may be anything.
*Syntax: XSTR(''"Title"'', -1)

====+Description:====
*This is the description you see in the weapons loadout screen. Again, these aren't based on any hard numbers, just approximations. Only needed for player allowed weapons.

XSTR(
"''Standard Issue
''Level 3 Hull Damage
''Level 2 Shield Damage''", -1)
$end_multi_text

====+Tech Title:====
*Title of the weapon in the Tech room. Only needed for player allowed weapons.
*Syntax: XSTR(''"Title"'', -1)

====+Tech Anim:====
*Animation used for the weapon in the Tech room. Only needed for player allowed weapons.
*Syntax: ''Filename''
**Example: ''Tech_Subach_HL-7''

====+Tech Description:====
*Descriptive text you see in the tech room. Only needed for player allowed weapons.

XSTR(
"''The Subach-Innes HL-7...''", 3245)
$end_multi_text


====$Tech Model:====

====$HUD Image:====
*Defines the picture used in HUD loadout list
*Syntax: ???


====$Model File:====
*Filename of the model file (.pof) at data/models folder. Additional fields beginning from '''''@Laser Bitmap:''''' and ending to '''''@Laser Tail Radius:''''' are not required if model has been defined.
*Standard primaries and beam cannons do not use specific models so for those the name is 'none'.
*Flak weapons and secondaries use models, though the exact model is not important with the flak weapons.
*Syntax: ''Filename.pof'' or ''none''
**Example: ''none''


====$POF target LOD:====
*Defines the LOD (Level-Of-Detail) of the model used in HUD targetting view
*Syntax: ''Value''

====$External Model File:====

====$Submodel Rotation Speed:====

====$Submodel Rotation Acceleration:====


====@Laser Bitmap:====
**The graphic file to be used as the weapon effect if no model is defined.
**Syntax: ''Filename''

====@Laser Glow:====
**The graphic file that determines the glow of the weapon effect if no model is defined
**Syntax: ''Filename''

====@Laser Color:====
**The color of the weapon effect when you fire it.
**Syntax: ''Value, Value, Value'' (Red, Green, Blue respectively, value from 0 to 255)
***Example: ''250, 0, 0''

====@Laser Color2:====
**The color of the weapon effect at its maximum range.
**Syntax: ''Value, Value, Value'' (Red, Green, Blue respectively, value from 0 to 255)
***Example: ''0, 0, 250''

====@Laser Length:====
**Length of the weapon effect.
**Syntax: ''Value'', (1/10 of a meters)

====@Laser Head Radius:====
**Width of the head of the weapon effect.
**Syntax: ''Value'', (meters ?)

====@Laser Tail Radius:====
**Width of the tail of the weapon effect.
**Syntax: ''Value'' (meters ?)

====$Mass:====
*How much of a kinetic effect this weapon has on its target. 3+ gives you the Flail effect. Set it to 10 and you can knock cruisers around.
*Syntax: ''Value'', (blast effect)

====$Velocity:====
*How fast the weapon travels. Is also used to define the weapon range, $Velocity x $Lifetime = range.
*Beams travel instantly so this field has effect only on weapon range and AI beam targetting with certain beam types.
*Syntax: ''Value'', (meters per second)

====$Fire Wait:====
*Time in seconds between firings
*Syntax: ''Value'', (seconds)

====$Damage:====
*Base damage this weapon does. The actual damage is this number multiplied by the factors below.
*Base damage this beam does is continous damage, damage is 5.5 times the damage value per second. The actual damage is this number multiplied by one of the factors below.
*Syntax: ''Value'', (damage value)


====$Damage Type:====
*Defines the damage type that this weapon uses. All armor effects are applied after shield and have no function against shockwave or subsystem damage. REQUIRES ADDITIONAL TABLE.
*Syntax: ''Name'', of the damage type as defined in armor.tbl

====$Arm time:====
*Defines the time after the launch that is required before the weapon comes hot
*If the time has not been reached when the weapon detonates the Dinky explosion is used
*Syntax: ''Value'', (seconds)

====$Arm distance:====
*Defines the distance from the firing ships that is required before the weapon comes hot
*If the distance has not been reached when the weapon detonates the Dinky explosion is used
*Syntax: ''Value'', (meters)

====$Arm radius:====
*Defines the distance from the target where the weapon detonates
*Syntax: ''Value'', (meters)

====$Shockwave damage:====
*Override for the damage caused by shockwaves
*Syntax: ''Value'', (damage value)

====$Shockwave Damage Type:====
*REQUIRES ADDITIONAL TABLE. Defines the damage type used for the weapon explosions
*Syntax: ''Name'', as defined in armor.tbl


====$Blast Force:====
*The intensity of the blast effect when ship is within the outer radius of the explosion. Comes in effect only if inner and outer radius are defined.
*Syntax: ''Value'', (blast effect)

====$Inner Radius:====
*Radius at which the full explosion damage is done. Marks the line where damage attenuation begins.
*Syntax: ''Value'', (meters)

====$Outer Radius:====
*Maximum radius at which any damage is done
*Syntax: ''Value'', (meters)

====$Shockwave Speed:====
*Speed shockwave expands at. Zero means no shockwave and that damage is applied immediately
*Syntax: ''Value'', (meters per second)


====$Shockwave rotation:====
*Defines how the shockwave is rotated.
*Syntax:

====$Shockwave model:====
*Defines the model file (.pof) used as a shockwave for 3D shockwaves.
*Implemented before FS_Open 3.6.5
*Syntax: ''Name.pof''

====$Shockwave name:====
*Defines the name of the animation used for the shockwave
*Syntax: ''Name''

====$Dinky shockwave:====
*Dinky shockwave are used if the weapon is shot down or if the conditions marked at Arm time and Arm distance are not reached
*It uses exactly same entries as the standard shockwaves
*'''+Shockwave damage:'''
*'''+Shockwave damage type:'''
*'''+Blast Force:'''
*'''+Inner Radius:'''
*'''+Outer Radius:'''
*'''+Shockwave Speed:'''
*'''+Shockwave Rotation:'''
*'''+Shockwave Model:'''
*'''+Shockwave Name:'''


====$Armor Factor:====
*Multiplier for the damage done to armor
*Syntax: ''Value'', (damage multiplier)

====$Shield Factor:====
*Multiplier for the damage done to shields
*Syntax: ''Value'', (damage multiplier)

====$Subsystem Factor:====
*Multiplier for the damage done to subsystems
*Syntax: ''Value'', (damage multiplier)


====$Lifetime Min:====
*Defines the minimum lifetime of the weapon (countermeasure)
*Syntax: ''Value'', (seconds)

====$Lifetime Max:====
*Defines the maximum lifetime of the weapon (countermeasure)
*Syntax: ''Value'', (seconds)


====$Lifetime:====
*Time before the standard primaries fizzle out and secondaries self destruct. Multiply this by the speed to get the range. If values are too low (below framerate) then the collision detection and graphic effects may suffer.
*This field has no effect for the beams apart from weapon range and AI beam targetting with certain beam types
*Syntax: ''Value'', (seconds)

====$Energy Consumed:====
*The amount of energy each bolt drains firing ship. Has no effect on turretted weapons.
*Syntax: ''Value''

====$Cargo Size:====
*Cargo size, is not used with primaries.
*Amount of missiles available = Bank capacity / Cargo Size.
*Syntax: ''Value''

====$Homing:====
*Only for secondaries. You can't have homing primaries. If this is set to YES with primaries, then the bolts turn to face their target but keep moving in the same direction. If the field is set to NO then following fields are not required in the table.
*Defines if the missiles in question is homing
*Syntax: ''YES'' or ''NO''
*'''+Type:'''
**Defines the homing method
**Syntax: ''ASPECT'' or ''HEAT''
*'''+Turn Time:'''
**Defines how well missile manouvers. Number of seconds it takes the missile to do a 360 degree circle
**Syntax: ''Value'', (seconds)
*'''+View Cone:'''
**'''Heat-seeking missiles only''', this is then number of degrees the missile sees. Value / 2 gives the angle from the missiles centerline. Has been enabled also to aspect seekers. 
**Syntax: ''Value'', (degrees)
*'''+Min Lock Time:'''
**'''For aspect missiles only''', the minimum number of seconds to gain target lock
**Syntax: ''Value'', (seconds)
*'''+Lock Pixels/Sec:'''
**'''For aspect missiles only''', pixels the aspect triangle moves per second while attempting lock-on
**Syntax: ''Value'', (pixels per second)
*'''+Catch-up Pixels/Sec:'''
**'''For aspect missiles only''', pixels moved per second while attempting to catch up to the target
**Syntax: ''Value'', (pixels per second)
*'''+Catch-up Penalty:'''
**'''For aspect missiles only''', extra pixels to move after catching up ????
**Syntax: ''Value'', (pixels)

*'''+Seeker Strenght:'''
**Defines the seeking ability of the homing system. Default of heat seekers is 3 and for aspect seekers 2. Spoofing change is defined as '''cm type effectiveness'''/'''seeker strength'''.
**Syntax: ''Value'', (seeker strenght)


====$Swarm:====
*The number of missiles to fire per volley if it's a swarm missile
*Can be issued to Standard primaries also. Causes singlepart turrets to malfunction but causes multipart turrets to fire only on their barrel line. Can be used for 'burst fire weapons'.
*Is incompatible with "Corkscrew" option.
*Syntax: ''Value''

*'''+SwarmWait:'''
**Implemented before FS_Open 3.6.5
**Defines the time between weapons fired in a swarm
**Syntax: ''Value'', (milliseconds)
***Default: 150

====$Free Flight Time:====
*Defines the free flight time of homing weapons. During this time weapon flies at 1/4 of its velocity + firing ships velocity in a straight line.
*Syntax: ''Value'', (seconds)
**Default: 0.25


====$LaunchSnd:====
*Corresponding sound effect when the weapon is launched.
*Syntax: ''Value'', name or identification number of the sound as defined in sounds.tbl

====$ImpactSnd:====
*Sound the weapon makes when it hits a hull.
*Syntax: ''Value'', name or identification number of the sound as defined in sounds.tbl


====$Disarmed ImpactSnd:====
*Sound the weapon makes when it hits a hull before being armed.
*Syntax: ''Value'', identification number of the sound as defined in sounds.tbl


====$FlyBySnd:====
*The sound this weapon makes if it narrowly misses you. -1 is no sound.
*Syntax: ''Value'', name or identification number of the sound as defined in sounds.tbl, usually -1


====$Model:====
*????
*Syntax: ????


====$Rearm Rate:====
*Defines the rate the weapons are loaded to the ship
*Syntax: ''Value'', (missiles per s)

====+Weapon Range:====
*Defines the range to the target where the weapons under AI will start firing.??
*Syntax: ''Value'', (meters)


====+Weapon Min Range:====
*Defines the minimum range to the target where the weapons under AI will still fire.
*Implemented before FS_Open 3.6.5
*Syntax: ''Value'', (meters)


====$Flags:====
*Flags are detailed below, in [[weapons.tbl#Weapon Flags|weapon flags section]].

====$Trail:====
*This is used if you want your weapon to have a trail. Trail is often used only with secondaries though it works with standard primaries as well.
*'''+Start Width:'''
**How wide the head of the trail is.
**Syntax: ''Value'', (meters)
*'''+End Width:'''
**How wide the tail of the trail is.
**Syntax: ''Value'', (meters)
*'''+Start Alpha:'''
**The opacity of the trail head.
**Syntax: ''Value'' value between 0 and 1
*'''+End Alpha:'''
**The opacity of the trail tail.
**Syntax: ''Value'', value between 0 and 1
*'''+Max Life:'''
**How long the trail lasts.
**Syntax: ''Value'', (seconds)
*'''+Bitmap:'''
**The graphic file to use for the trail.
**Syntax: ''Filename''

====$Icon:====
*Loadout icon used in the weapons selection screen.
*Syntax: ''Filename''

====$Anim:====
*Green grid animation used on the weapons screen.
*Syntax: ''Filename''

====$Impact Explosion:====
*Impact explosion used. Must be defined in weapon_expl.tbl,
*Syntax: ''Filename'' or ''none''

====$Impact Explosion Radius:====
*Radius of the defined impact explosion.
*Syntax: ''Value''


====$Dinky impact explosion:====
*Same as Impact explosion but for Dinky explosions

====$Dinky impact explosion radius:====
*Same as Impact explosion radius but for Dinky explosions


====$Muzzleflash:====
*Normally only with flak cannons.
*Defines the muzzle flash the weapon uses
*Syntax: ''Muzzleflash name'', as defined in mflash.tbl

====$EMP Intensity:====
**If it has an EMP effect, how deeply it scrambles your electronics
**Syntax: ''Value''

====$EMP Time:====
**Duration of the EMP effect
**Syntax: ''Value'', (seconds)

====$Leech Weapon:====
**The amount of weapon energy to drain with each hit
**Syntax: ''Value''

====$Leech Afterburner:====
**The amount of afterburner fuel to drain with each hit
**Syntax: ''Value''


====$Corkscrew:====
*Implemented before FS_Open 3.6.5
*Allow corkscrew parameters to be defined
*'''+Num Fired:'''
**Defines the number of weapons fired in sequence. Same as the standard swarm entry but for corkscrew missiles
**Syntax: ''Value''
*'''+Radius:'''
**Defines the radius used in the corkscrew motion
**Syntax: ''Value'', (meters)
*'''+Fire Delay:'''
**Defines the delay between missile firings
**Syntax: ''Value'', (milliseconds)
*'''+Counter rotate:'''
**Defines if every other missile rotates to a different direction (clockwise / anticlockwise)
**Syntax: ''0'' or ''1'', no or yes
*'''+Twist:'''
**Defines the speed of rotation movement on the radius of corkscrew motion.
**Syntax: ''Value'' (radians per second)

====$Electronics:====
*Implemented before FS_Open 3.6.5
*Defines the weapons effect against electronics
*'''+New Style:'''
**Defines that the electronics use the new style
*'''+Old Style:'''
**Defines that the electronics use the old style
*'''+Intensity:'''
*'''+Lifetime:'''
*'''+Engine Multiplier:'''
*'''+Weapon Multiplier:'''
*'''+Beam Turret Multiplier:'''
*'''+Sensors Multiplier:'''
*'''+Randomness Time:'''

====$Spawn Angle:====
*Implemented before FS_Open 3.6.5
*Defines the cone (with an angle) where the spawned weapons appear. Value / 2 gives the angle from the missiles centerline.
*Syntax: ''Value'', (degrees)

====$Local SSM:====
*Implemented before FS_Open 3.6.5
*Defines the local SSM.
*'''+Warpout Delay:'''
*'''+Warpin Delay:'''
*'''+Stage 5 Velocity:'''
*'''+Warpin Radius:'''
*'''+Lock Range:'''

====$Countermeasure:====
*Defines the countermeasure effectiveness and radius
*'''+Heat Effectiveness:'''
**Defines the countermeasures effectiveness against heat seeking missiles
**Syntax: ''Value'', (cm type effectiveness)
***Default: 1
*'''+Aspect Effectiveness:'''
**Defines the countermeasures effectiveness against aspect seeking missiles
**Syntax: ''Value'', (cm type effectiveness)
***Default: 1
*'''+Effective Radius:'''
**Defines the countermeasures effective radius
**Syntax: ''Value'', (meters)
***Default: 300


====$BeamInfo:====
*'''+Type:'''
**Defines the type of beam in question. Beam types: 0 is a standard non-slashing type beam. 1 is a slashing type beam. 3 is a beam type that fires pulses in anti-fighter role and acts like type 0 beam in other roles. 4 is a beam that is restricted to what is directly in front of it, along turrets firepoints normal. Nobody knows what Type 2 beams are.
**Syntax: ''Value'', only values from 0 to 4 are legal
*'''+Life:'''
**How long it lasts once the beam is actually firing.
**Syntax: ''Value'', (seconds)
*'''+Warmup:'''
**Warmup time
**Syntax: ''Value'', (milliseconds)
*'''+Warmdown:'''
**Warmdown time
**Syntax: ''Value'', (milliseconds)
*'''+Radius:'''
**Muzzle glow radius
**Syntax: ''Value'' (meters)
*'''+PCount:'''
**Particles spewed every interval. ??
**Syntax: ''Value''
*'''+PRadius:'''
**Particle radius
**Syntax: ''Value'', (meters)
*'''+PAngle:'''
**Defines the random "cone" where the particles are generated
**Syntax: ''Value'', (angle of the cone)
*'''+PAni:'''
**Animation used to represent the particles
**Syntax: ''Filename''
*'''+Miss Factor:'''
**The higher the numbers, the more likely that this beam will miss. One value for every difficulty level
**Syntax: ''Value Value Value Value Value'', Very Easy, Easy, Moderate, Hard, Very Hard respectively.
***Example: 0.5 0.975 1.35 1.875 2.5
*'''+BeamSound:'''
**Corresponding looping sound effect when the beam is firing.
**Syntax: ''Value'', identification number of the sound as defined in sounds.tbl
*'''+WarmupSound:'''
**Corresponding sound effect when the beam is beam warmed up.
**Syntax: ''Value'', identification number of the sound as defined in sounds.tbl
*'''+WarmdownSound:'''
**Corresponding sound effect when the beam is warming down.
**Syntax: ''Value'', identification number of the sound as defined in sounds.tbl
*'''+Muzzleglow:'''
**Defines the bitmap used t create the muzzle glow
**Syntax: ''Filename''
*'''+Shots:'''
**Defines into how may invidual shots the type 3 (AAA) beams are divided. Note total firing is the same as the +Life:
**Syntax: ''Value''
*'''+ShrinkFactor:'''
**What percentage of lifetime where beam starts shrinking (0.1 == 10% life left)
**Syntax: ''Value''
*'''+ShrinkPct:'''
**What percentage of max width we subtract per second
**Syntax: ''Value''

*'''+Range:'''
**Implemented before FS_Open 3.6.5
**Defines the maximum range where the beam still has any effect.
**Syntax: ''Value'', (meters)
*'''+Attenuation:'''
**Implemented before FS_Open 3.6.5
**Defines the point where the damage caused by the beam starts to attenuate. At maximum range damage is zero.
**Syntax: ''Value'', (from 0 - firing point to 1 - no effect)
***Default: 1

*'''$Section:'''
**Beams are made up of up to five sections layered atop one another to create the effect. Each section has its own parameters.
**'''+Width:'''
***Width of the section
***Syntax: ''Value'' (meters)
**'''+Texture:'''
***Texture for the section
***Syntax: ''Filename''
**'''+RGBA Inner:'''
***Defines the color and transparency of the center of the section
***Syntax: ''Value Value Value Value'', (Red, Green, Blue, and Alpha respectively, value from 0 to 255)
****Example: 255 255 255 255
**'''+RGBA Outer:'''
***Defines the color and transparency of the edges of the section
***Syntax: ''Value Value Value Value'', (Red, Green, Blue, and Alpha respectively, value from 0 to 255)
****Example: 150 150 150 10
**'''+Flicker:'''
***Defines how much the section flickers
***Syntax: ''Value'', value from 0 to 1
**'''+Zadd:'''
***Defines the 'thickness' of the section. The higher the Zadd, the closer the section appears to be.
***Syntax: ''Value'' 
**'''+Tile Factor:'''
***Implemented before FS_Open 3.6.5
***Defines the beam texture tileing factor.
***Syntax: ''Value'', (from 0 to 1)
**'''+Translation:'''
***Implemented before FS_Open 3.6.5
***Defines the beam texture moveing stuff.
***Syntax: ''Value'', (from 0 to 1)

====$Pspew:====
*Implemented before FS_Open 3.6.5
*Defines a particle spew effect for the given weapon
*'''+Count:'''
**Defines???
**Syntax: ''Value''
*'''+Time:'''
**Defines???
**Syntax: ''Value'', (seconds)
*'''+Vel:'''
**Defines the created paricles speed relative to the weapon speed
**Syntax: ''Value'', (meters per second)
*'''+Radius:'''
**Defines the size of the created particles
**Syntax: ''Value'', (meters)
*'''+Life:'''
**Defines???
**Syntax: ''Value'', (seconds)
*'''+Scale:'''
**Defines???
**Syntax: ''Value''
*'''+Bitmap:
**Defines the animation used to create the particle spew effect
**Syntax: ''Filename''


====$Tag:====
*Allowed for secondary weapons
*Location: After $Impact Explosion Radius:
*Sets this weapon as a TAG missile, level 1, 2, or 3. The second number is the duration in seconds.
*Syntax: ''TAG level'' ''Value'', (seconds)


====$SSM:====
*Implemented before FS_Open 3.6.5
*Defines the weapons SSM index number:
*Syntax: ''Value''

====$FOF:====
*Implemented before FS_Open 3.6.5
*Defines the field of fire for the weapon. Causes weapon to fire into a firing cone instead of direct firing line thus causing light inaccuracy
*Syntax: ''Value'', (degrees)

====$Shots:====
*Implemented before FS_Open 3.6.5
*Defines the number of shots every time the weapon is fired.
*Syntax: ''Value'', (number of shots)

====$decal:====
*Implemented before FS_Open 3.6.5
*Defines impact decals if they are in use
*'''+texture:'''
**Defines the texture used for impact decals (can use '''''-burn''''' and '''''-glow''''' textures)
**Syntax: ''Filename''
*'''+backface texture:'''
**Defines ???
**Syntax: ''Filename''
*'''+radius:'''
**Defines the size of the impact decals on target
**Syntax: ''Value'', (meters)
*'''+burn time:'''
**Defines the time the '''''-burn''''' texture appears on the target
**Syntax: ''Value''


==Weapon Flags==

==="Electronics"===
*Will seize up the weapons and engines systems of any ship of cruiser class or below for a short period of time

==="Spawn ''Name'',''Value''"===
*Will spawn the specified number of defined missiles upon detonation.

==="Remote Detonate"===
*Can be triggered remotely via a second press on the trigger

==="Puncture"===
*Reduces hull damage by 25%

==="Big Ship"===
*These weapons cannot be mounted on small ships like fighters, bombers, sentry guns etc.

==="Huge"===
*Allows this weapon to do the final 10% damage to a ship with the "Big Damage" flag

==="Bomber+"===
*The AI will prefer to use this weapon against bombers

==="child"===
*Cannot be set as a weapon on any ship, but is instead a child of a weapon. Usually defined with "Spawn ''Name'',''Value''"

==="Bomb"===
*Makes this weapon targetable with the B key, and the AI prefers to use it against large ships

==="No Dumbfire"===
*Missile will not fire without a lock

==="in tech database"===
*Has the weapon in the tech database at the start of the campaign

==="Player allowed"===
*Allows this weapon as a player weapon

==="Particle Spew"===
*Makes the weapon projectile spew out particles

*Can be defined with [[Weapons.tbl#$Pspew:|Particle Spew parameters]]


==="EMP"===
*This weapon will have an EMP effect on any ship within the blast radius
*Can be defined with [[Weapons.tbl#$EMP_Intensity:|EMP Intensity]] and [[Weapons.tbl#$EMP_Time:|EMP Time]]

==="Esuck"===
*Drains the target's energy banks
*Can be defined with [[Weapons.tbl#$Leech_Weapon:|Leech Weapon]] and [[Weapons.tbl#$Leech_Afterburner:|Leech Afterburner]]

==="Flak"===
*Makes this weapon a [[weapons.tbl#Flak Guns|flak gun]]

==="Corkscrew"===
*Makes this weapon spiral AND swarm 4.

*Can be defined with [[Weapons.tbl#$Corkscrew:|Corkscrew parameters]]


==="Shudder"===
*Makes your ship shudder while you're firing the weapon

==="lockarm"===
*Requires a target lock in order to arm its warhead. In other words weapon causes less damage if it hits the target without target lock.

==="beam"===
*Makes this weapon a [[weapons.tbl#Beam Cannons|beam cannon]]

==="stream"===
*Gives this weapon a streaming effect. In effect weapon keeps firing when firing button is kept pressed.

==="puncture"===
*Reduces hull damage by 25%

==="supercap"===
*MaKes weapon capable of causing real damage against ships with "supercap" flag.


==="countermeasure"===
*Defines the weapon as a countermeasure

==="Ballistic"===
*Implemented before FS_Open 3.6.5
*Defines the weapon as a ballistic weapon that needs ammunition.

==="pierce shields"===
*Implemented before FS_Open 3.6.5
*Causes weapons to penetrate shield without causing damage to it.

==="no pierce shields"===
*Implemented before FS_Open 3.6.5
*Prevents weapons (beams) from piercing shields causing shields to be damaged by weapons first.

==="local ssm"===
*Implemented before FS_Open 3.6.5

==="tagged only"===
*Implemented before FS_Open 3.6.5
*Weapon can only be fired at tagged targets

==="beam no whack"===
*Implemented before FS_Open 3.6.5
*Disables beam whacking. Practically same as setting beam mass to zero.

==="cycle"===
*Implemented before FS_Open 3.6.5
*Causes weapon to alternate between firingpoints

==="small only"===
*Implemented before FS_Open 3.6.5
*Causes AI to use the weapon only on small targets (fighters, bombers etc.)

==="same turret cooldown"===
*Forces the turrets to fire on the designated rate of fire on all difficulty levels


==Countermeasures==
*Usually not altered. Only one can exist

===$Name:===
*Name of the countermeasure
*Syntax: ''Name'', usually Type One

===$Velocity:===
*Defines the spped of the countermeasure, relative to the ship.
*Syntax: ''Value'', (meter per second)

===$Fire Wait:===
*Definies the minumum time between the countermeasure launches
*Syntax: ''Value'', (seconds)

===Lifetime===
*Countermeasure's life time is defined between with minimum and maximum lifetime
*'''$Lifetime Min:'''
**Syntax: ''Value'', (seconds)
*'''$Lifetime Max:'''
**Syntax: ''Value'', (seconds)

===$LaunchSnd:===
*Defines the sound for the countermeasure launch
*Syntax: ''Value'', refers to sounds.tbl

===$Model:===
*Defines the used model file (.pof)
*Syntax: ''Filename.pof'', usually cmeasure01.pof

==Player Weapon Precedence==
*First the primary weapons are defined, from most powerful to least powerful, and then the same for secondaries
*Syntax: ( ''"Name" "Name"'')
*Example:

$Player Weapon Precedence: (
"UD-8 Kayser"
"Prometheus R"
"Subach HL-7"
"Harpoon"
"Tempest"
"Rockeye" )

==Sample==

#Primary Weapons
$Name: @Subach HL-7
+Title: XSTR("GTW Subach HL-7", 3243)
+Description:
XSTR( "Standard Issue
Level 3 Hull Damage
Level 2 Shield Damage", 3244)
$end_multi_text
+Tech Title: XSTR("Subach HL-7", 146)
+Tech Anim: Tech_Subach_HL-7
+Tech Description:
XSTR(
"Descriptive text...", -1)
$end_multi_text
$Model File: none
@Laser Bitmap: newglo9
@Laser Glow: 2_laserglow03
@Laser Color: 250, 0, 0
@Laser Color2: 0, 0, 250
@Laser Length: 10.0
@Laser Head Radius: 0.90
@Laser Tail Radius: 0.90
$Mass: 0.2
$Velocity: 450.0
$Fire Wait: 0.2
$Damage: 15
$Armor Factor: 0.9
$Shield Factor: 0.7
$Subsystem Factor: 0.3
$Lifetime: 2.0
$Energy Consumed: 0.20
$Cargo Size: 0.0
$Homing: NO
$LaunchSnd: 76
$ImpactSnd: 85
$Flags: ( "in tech database"
"player allowed"
"stream")
$Icon: iconSD4
$Anim: SD4
$Impact Explosion: none
#End
#Secondary Weapons
$Name: EMP Adv.
+Title: XSTR("GTM-14 EMP Adv.", 3396)
+Description:
XSTR( "Advanced Missile
Electromagnetic Pulse Weapon
General Purpose Suppression", 3397)
$end_multi_text
+Tech Title: XSTR("GTM-14 EM Pulse Adv.", 3398)
+Tech Anim: Tech_EMP
+Tech Description:
XSTR(
"Descriptive text...", -1)
$end_multi_text
$Model File: EMPulse2.pof
$Mass: 15.0
$Velocity: 275.0
$Fire Wait: 2.0
$Damage: 45
$Blast Force: 20.0
$Inner Radius: 80.0
$Outer Radius: 300.0
$Shockwave Speed: 120.0
$Armor Factor: 1.0
$Shield Factor: 0.8
$Subsystem Factor: 0.5
$Lifetime: 5.0
$Energy Consumed: 0.0
$Cargo Size: 4.0
$Homing: YES
+Type: ASPECT
+Turn Time: 1.0
+Min Lock Time: 2.0
+Lock Pixels/Sec: 70
+Catch-up Pixels/Sec: 100
+Catch-up Penalty: 30
$LaunchSnd: 118
$ImpactSnd: 88
$FlyBySnd: -1
$Rearm Rate: 2.0
$Flags: ( "player allowed"
"EMP")
$Trail:
+Start Width: 0.25
+End Width: 0.75
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.5
+Bitmap: MissileTrail04
$Icon: iconEMPulse
$Anim: ecm
$Impact Explosion: ExpMissileHit1
$Impact Explosion Radius: 10.0
$EMP Intensity: 375.0
$EMP Time: 20.0
#End
$Player Weapon Precedence: (
"Subach HL-7"
"EMP Adv." )

[[Category:Tables]]

Animation Code

2005-11-13T20:20:43Z

84.248.195.235: Small details

Known commonly as Bob's animation code as the code was written by Bobboau. Enables submodels defined in [[ships.tbl]] or in any related modular table to be animated in game. Animation code is included to the subsystem entry in similar manner as with [[Animation_Code#Setting_Turret_Angle|multipart turrets]]

==Animation Class==
*Animation classes are defined in submodels description
*Syntax: $animation=''Class''
*'''Triggered'''
**Currently only supported animation class

===Animation Type===
*Animation type defines when the animation is used
*Currently supported animation types:
**'''"initial"'''
***Animation code is started when the mission begins
**'''"docking"'''
***Animation code is started when ship starts docking
**'''"docked"'''
***Animation code is started when ship is docked
**'''"primary bank"'''
***Animation code is started when a primary bank is fired
**'''"secondary bank"'''
***Animation code is started when a secondary bank is fired
**'''"door"'''
***Animation code starts when something happens???
*Syntax: $type=''Type''

===Animation Sub-Type===
*Optional more accurate descriptor for the animation type
*For example used when defined primary bank is fired
*Syntax: +sub_type:''Value'', (0 = 1st weapon bank, 1 = 2nd weapon bank, etc.)

===Animation Code===
====If Animation Type Is Initial====
*'''+delay:'''
**Defines how long til the trigger starts
**Syntax: ''Value'', (seconds)
*'''+absolute_angle:''' OR '''+relative_angle:'''
**Defines the rotation degrees with three floats that give the x, y, and z. Absolute means in world terms; relative means relative to the ship. So a 90 degree angle on the ship would always be straight up in relative degrees; it would vary depending how the ship was rotated in absolute degrees.
**Syntax: ''Value,Value,Value''
*'''+velocity:'''
**Defines subobject rotation speed, in relative terms. Defined with x, y and z floats.
**Syntax: ''Value,Value,Value''
*'''+acceleration:'''
**Defeines acceleration speed of subobject rotation. Defined with three floats, x, y and z
**Syntax: ''Value,Value,Value''
*'''+time:'''
**Defines time for object to rotate, move, whatever.
**Syntax: ''Value'', (seconds)

====If Animation Type Is Not Initial====
*'''+delay:'''
**Defines how long til the trigger starts
**Syntax: ''Value'', (seconds)
*'''+reverse delay:'''
**
**Syntax: ''Value'', (seconds)
*'''+absolute angle:''' OR '''+relative angle:'''
**Defines the rotation degrees with three floats that give the x, y, and z. Absolute means in world terms; relative means relative to the ship. So a 90 degree angle on the ship would always be straight up in relative degrees; it would vary depending how the ship was rotated in absolute degrees.
**Syntax: ''Value,Value,Value'', (degrees)
*'''+velocity:'''
**Defines subobject rotation speed, in relative terms. Defined with x, y and z floats.
**Syntax: ''Value,Value,Value'', (meters)
*'''+acceleration:'''
**Defeines acceleration speed of subobject rotation. Defined with three floats, x, y and z
**Syntax: ''Value,Value,Value''
*'''+time:'''
**Defines time for object to rotate, move, whatever.
**Syntax: ''Value'', (seconds)
*'''$Sound:'''
**Defines sounds that are played with the animation
**'''+Start:'''
***Defines the sound that is played when animation starts
***Syntax: ????
**'''+Loop:'''
***Defines the sound that is played when animation is going on
***Syntax: ????
**'''+End:'''
***Defines the sound that is played when animation stops
***Syntax: ????
**'''+Radius:'''
***Defines the distance from the submodel where the sound is audible
***Syntax: ''Value'', (meters)

==Animation Examples==
===Setting Turret Angle===
*Animation code can be used to set multipart turrets barrel angle at the beginning of the mission
*'''Animation Class''' = triggered
**The only one available
*'''Animation Type''' = initial
**As we want the barrels to align themselves at the beginning of the mission
*'''Animation Code'''
**+relative_angle: is good for this purpose
**Notes and angles:
***First value is used to determine the turret's barrels deviation from the turrets normal. So barrel elevation in degrees is ( 90 - the first value ).
***Second value is used to determine the turret facing. With ''0'' the turret facing is in the normal setting and with ''180'' turn the turret completely around. Do note that turrets on the underside of the model normally face backward so to get these turrets pointing forward the second value has to be set to 180.

====Example====
$Subsystem: turret02,0.833,1.0
$Default PBanks: ( "Terran Turret" )
$animation=triggered
$type="inital"
+relative_angle: 90,180,0

Weapons.tbl

2005-11-12T14:31:02Z

84.248.195.235:

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

==Retail FS2 - Weapons Table==

===Core Table===

====$Name:====
*This is the name of the weapon. If it's going to be used by the player, keep it under 12 characters so it doesn't spill over the HUD box. If the weapon has an @ symbol in front of it, it means it's allowed in the demo. It doesn't really do anything in the retail version.
*Syntax: ''Name''

====+Title:====
*This is the title of the weapon in the Weapons loadout screen. Only needed for player allowed weapons. Title may be anything.
*Syntax: XSTR(''"Title"'', -1)

====+Description:====
*This is the description you see in the weapons loadout screen. Again, these aren't based on any hard numbers, just approximations. Only needed for player allowed weapons.

XSTR(
"''Standard Issue
''Level 3 Hull Damage
''Level 2 Shield Damage''", -1)
$end_multi_text

====+Tech Title:====
*Title of the weapon in the Tech room. Only needed for player allowed weapons.
*Syntax: XSTR(''"Title"'', -1)

====+Tech Anim:====
*Animation used for the weapon in the Tech room. Only needed for player allowed weapons.
*Syntax: ''Filename''
**Example: Tech_Subach_HL-7

====+Tech Description:====
*Descriptive text you see in the tech room. Only needed for player allowed weapons.

XSTR(
"''The Subach-Innes HL-7...''", 3245)
$end_multi_text

====$Model File:====
*Filename of the model file (.pof) at data/models folder. Additional fields after the $Model file: are not required if model has been defined.
*Standard primaries and beam cannons do not use specific models so for those the name is 'none'.
*Flak weapons and secondaries use models, though the exact model is not important with the flak weapons.
*Syntax: ''Filename''
**Example: none
*'''@Laser Bitmap:'''
**The graphic file to be used as the weapon effect if no model is defined.
**Syntax: ''Filename''
*'''@Laser Glow:'''
**The graphic file that determines the glow of the weapon effect if no model is defined
**Syntax: ''Filename''
*'''@Laser Color:'''
**The color of the weapon effect when you fire it.
**Syntax: "Value, Value, Value'' (Red, Green, Blue respectively, value from 0 to 255)
***Example: 250, 0, 0
*'''@Laser Color2:'''
**The color of the weapon effect at its maximum range.
**Syntax: "Value, Value, Value'' (Red, Green, Blue respectively, value from 0 to 255)
***Example: 0, 0, 250
*'''@Laser Length:'''
**Length of the weapon effect.
**Syntax: ''Value'', (1/10 of a meters)
*'''@Laser Head Radius:'''
**Width of the head of the weapon effect.
**Syntax: ''Value'', (meters ?)
*'''@Laser Tail Radius:'''
**Width of the tail of the weapon effect.
**Syntax: ''Value'' (meters ?)

====$Mass:====
*How much of a kinetic effect this weapon has on its target. 3+ gives you the Flail effect. Set it to 10 and you can knock cruisers around.
*Syntax: ''Value'', (blast effect)

====$Velocity:====
*How fast the weapon travels. Is also used to define the weapon range, $Velocity x $Lifetime = range.
*Beams travel instantly so this field has effect only on weapon range and AI beam targetting with certain beam types.
*Syntax: ''Value'', (meters per second)

====$Fire Wait:====
*Time in seconds between firings
*Syntax: ''Value'', (seconds)

====$Damage:====
*Base damage this weapon does. The actual damage is this number multiplied by the factors below.
*Base damage this beam does is continous damage, damage is 5.5 times the damage value per second. The actual damage is this number multiplied by one of the factors below.
*Syntax: ''Value'', (damage value)

====$Blast Force:====
*The intensity of the blast effect when ship is within the outer radius of the explosion. Comes in effect only if inner and outer radius are defined.
*Syntax: ''Value'', (blast effect)

====$Inner Radius:====
*Radius at which the full explosion damage is done. Marks the line where damage attenuation begins.
*Syntax: ''Value'', (meters)

====$Outer Radius:====
*Maximum radius at which any damage is done
*Syntax: ''Value'', (meters)

====$Shockwave Speed:====
*Speed shockwave expands at. Zero means no shockwave and that damage is applied immediately
*Syntax: ''Value'', (meters per second)

====$Armor Factor:====
*Multiplier for the damage done to armor
*Syntax: ''Value'', (damage multiplier)

====$Shield Factor:====
*Multiplier for the damage done to shields
*Syntax: ''Value'', (damage multiplier)

====$Subsystem Factor:====
*Multiplier for the damage done to subsystems
*Syntax: ''Value'', (damage multiplier)

====$Lifetime:====
*Time before the standard primaries fizzle out and secondaries self destruct. Multiply this by the speed to get the range. If values are too low (below framerate) then the collision detection and graphic effects may suffer.
*This field has no effect for the beams apart from weapon range and AI beam targetting with certain beam types
*Syntax: ''Value'', (seconds)

====$Energy Consumed:====
*The amount of energy each bolt drains firing ship. Has no effect on turretted weapons.
*Syntax: ''Value''

====$Cargo Size:====
*Cargo size, is not used with primaries.
*Amount of missiles available = Bank capacity / Cargo Size.
*Syntax: ''Value''

====$Homing:====
*Only for secondaries. You can't have homing primaries. If this is set to YES with primaries, then the bolts turn to face their target but keep moving in the same direction. If the field is set to NO then following fields are not required in the table.
*Defines if the missiles in question is homing
*Syntax: ''YES'' or ''NO''
*'''+Type:'''
**Defines the homing method
**Syntax: ''ASPECT'' or ''HEAT''
*'''+Turn Time:'''
**Defines how well missile manouvers. Number of seconds it takes the missile to do a 360 degree circle
**Syntax: ''Value'', (seconds)
*'''+View Cone:'''
**'''Heat-seeking missiles only''', this is then number of degrees the missile sees. Value / 2 gives the angle from the missiles centerline.
**Syntax: ''Value'', (degrees)
*'''+Min Lock Time:'''
**'''For aspect missiles only''', the minimum number of seconds to gain target lock
**Syntax: ''Value'', (seconds)
*'''+Lock Pixels/Sec:'''
**'''For aspect missiles only''', pixels the aspect triangle moves per second while attempting lock-on
**Syntax: ''Value'', (pixels per second)
*'''+Catch-up Pixels/Sec:'''
**'''For aspect missiles only''', pixels moved per second while attempting to catch up to the target
**Syntax: ''Value'', (pixels per second)
*'''+Catch-up Penalty:'''
**'''For aspect missiles only''', extra pixels to move after catching up ????
**Syntax: ''Value'', (pixels)
*Syntax: ''YES'' or ''NO'', usually NO

====$Swarm:====
*The number of missiles to fire per volley if it's a swarm missile
*Can be issued to Standard primaries also. Causes singlepart turrets to malfunction and multipart turrets to fire noly on their barrel line. Can be used for 'burst fire weapons'.
*Syntax: ''Value''

====$LaunchSnd:====
*Corresponding sound effect when the weapon is launched.
*Syntax: ''Value'', identification number of the sound as defined in sounds.tbl

====$ImpactSnd:====
*Sound the weapon makes when it hits a hull.
*Syntax: ''Value'', identification number of the sound as defined in sounds.tbl

====$FlyBySnd:====
*The sound this weapon makes if it narrowly misses you. -1 is no sound.
*Syntax: ''Value'', identification number of the sound as defined in sounds.tbl, usually -1

====+Weapon Range:====
*Defines the range to the target where the weapons under AI will start firing.??
*Syntax: ''Value'', (meters)

====$Flags:====
*Flags are detailed below.

====$Trail:====
*This is used if you want your weapon to have a trail. Trail is often used only with secondaries though it works with standard primaries as well.
*'''+Start Width:'''
**How wide the head of the trail is.
**Syntax: ''Value'', (meters)
*'''+End Width:'''
**How wide the tail of the trail is.
**Syntax: ''Value'', (meters)
*'''+Start Alpha:'''
**The opacity of the trail head.
**Syntax: ''Value'' value between 0 and 1
*'''+End Alpha:'''
**The opacity of the trail tail.
**Syntax: ''Value'', value between 0 and 1
*'''+Max Life:'''
**How long the trail lasts.
**Syntax: ''Value'', (seconds)
*'''+Bitmap:'''
**The graphic file to use for the trail.
**Syntax: ''Filename''

====$Icon:====
*Loadout icon used in the weapons selection screen.
*Syntax: ''Filename''

====$Anim:====
*Green grid animation used on the weapons screen.
*Syntax: ''Filename''

====$Impact Explosion:====
*Impact explosion used. Must be defined in weapon_expl.tbl,
*Syntax: ''Filename'' or ''none''

====$Impact Explosion Radius:====
*Radius of the defined impact explosion.
*Syntax: ''Value''

----

===Beam Cannons===
*Special case weapons
*'''REQUIRES: "beam" flag'''

====$BeamInfo:====
*Location: After $Impact Explosion Radius:
*Has special fields for different beam parameters
*'''+Type:'''
**Defines the type of beam in question. Beam types: 0 is a standard non-slashing type beam. 1 is a slashing type beam. 3 is a beam type that fires pulses in anti-fighter role and acts like type 0 beam in other roles. 4 is a beam that is restricted to what is directly in front of it, along turrets firepoints normal. Nobody knows what Type 2 beams are.
**Syntax: ''Value'', only values from 0 to 4 are legal
*'''+Life:'''
**How long it lasts once the beam is actually firing.
**Syntax: ''Value'', (seconds)
*'''+Warmup:'''
**Warmup time
**Syntax: ''Value'', (milliseconds)
*'''+Warmdown:'''
**Warmdown time
**Syntax: ''Value'', (milliseconds)
*'''+Radius:'''
**Muzzle glow radius
**Syntax: ''Value'' (meters)
*'''+PCount:'''
**Particles spewed every interval. ??
**Syntax: ''Value''
*'''+PRadius:'''
**Particle radius
**Syntax: ''Value'', (meters)
*'''+PAngle:'''
**Defines the random "cone" where the particles are generated
**Syntax: ''Value'', (angle of the cone)
*'''+PAni:'''
**Animation used to represent the particles
**Syntax: ''Filename''
*'''+Miss Factor:'''
**The higher the numbers, the more likely that this beam will miss. One value for every difficulty level
**Syntax: ''Value Value Value Value Value'', Very Easy, Easy, Moderate, Hard, Very Hard respectively.
***Example: 0.5 0.975 1.35 1.875 2.5
*'''+BeamSound:'''
**Corresponding looping sound effect when the beam is firing.
**Syntax: ''Value'', identification number of the sound as defined in sounds.tbl
*'''+WarmupSound:'''
**Corresponding sound effect when the beam is beam warmed up.
**Syntax: ''Value'', identification number of the sound as defined in sounds.tbl
*'''+WarmdownSound:'''
**Corresponding sound effect when the beam is warming down.
**Syntax: ''Value'', identification number of the sound as defined in sounds.tbl
*'''+Muzzleglow:'''
**Defines the bitmap used t create the muzzle glow
**Syntax: ''Filename''
*'''+Shots:'''
**Defines into how may invidual shots the type 3 (AAA) beams are divided. Note total firing is the same as the +Life:
**Syntax: ''Value''
*'''+ShrinkFactor:'''
**What percentage of lifetime where beam starts shrinking (0.1 == 10% life left)
**Syntax: ''Value''
*'''+ShrinkPct:'''
**What percentage of max width we subtract per second
**Syntax: ''Value''
*'''$Section:'''
**Beams are made up of up to five sections layered atop one another to create the effect. Each section has its own parameters.
**'''+Width:'''
***Width of the section
***Syntax: ''Value'' (meters)
**'''+Texture:'''
***Texture for the section
***Syntax: ''Filename''
**'''+RGBA Inner:'''
***Defines the color and transparency of the center of the section
***Syntax: ''Value Value Value Value'', (Red, Green, Blue, and Alpha respectively, value from 0 to 255)
****Example: 255 255 255 255
**'''+RGBA Outer:'''
***Defines the color and transparency of the edges of the section
***Syntax: ''Value Value Value Value'', (Red, Green, Blue, and Alpha respectively, value from 0 to 255)
****Example: 150 150 150 10
**'''+Flicker:'''
***Defines how much the section flickers
***Syntax: ''Value'', value from 0 to 1
**'''+Zadd:'''
***Defines the 'thickness' of the section. The higher the Zadd, the closer the section appears to be.
***Syntax: ''Value''

----

===Flak Cannons===
*Special case weapons.
*'''REQUIRE: "flak" and "particle spew" flags'''
*Must have inner and outer radius defined to have any effect.
*Do not use any model or weapon effect. Rather trhese use particle spew

====$Muzzleflash:====
*Location: After $Impact Explosion Radius:
*Defines the muzzle slash the weapon uses
*Syntax: ''Muzzleflash name'', as defined in mflash.tbl

----

===Special Cases===

'''"TAG"'''
*Allowed for secondary weapons
*Location: After $Impact Explosion Radius:
*Sets this weapon as a TAG missile, level 1, 2, or 3. The second number is the duration in seconds.
*Syntax: ''TAG level'' ''Value'', (seconds)

'''"Esuck"'''
*Allowed for primary weapons
*Location: After $Impact Explosion Radius:
*'''$Leech Weapon:'''
**The amount of weapon energy to drain with each hit
**Syntax: ''Value''
*'''$Leech Afterburner:'''
**The amount of afterburner fuel to drain with each hit
**Syntax: ''Value''

'''"EMP"'''
*Allowed for secondary weapons
*Location: After $Impact Explosion Radius:
*'''$EMP Intensity:'''
**If it has an EMP effect, how deeply it scrambles your electronics
**Syntax: ''Value''
*'''$EMP Time:'''
**Duration of the EMP effect
**Syntax: ''Value'', (seconds)

==Retail FS2 - Weapon Flags==

'''"in tech database"'''
*Has the weapon in the tech database at the start of the campaign

'''"player allowed"'''
*Allows this weapon as a player weapon

'''"stream"'''
*Gives this weapon a streaming effect

'''"puncture"'''
*Reduces hull damage by 25%

'''"shudder"'''
*Makes your ship shudder while you're firing it

'''"esuck"'''
*Drains the target's energy banks

'''"particle spew"'''
*Makes the weapon projectile spew out particles

'''"beam"'''
*Makes this weapon a beam cannon

'''"Big Ship"'''
*These weapons cannot be mounted on small ships like fighters, bombers, sentry guns etc.

'''"Huge"'''
*Allows this weapon to do the final 10% damage to a ship with the "Big Damage" flag

'''"Flak"'''
*Makes this weapon a flak gun

'''"Corkscrew"'''
*Makes this weapon spiral AND swarm 4.

'''"Lockarm"'''
*Requires a target lock in order to arm its warhead

'''"Bomber+"'''
*The AI will prefer to use this weapon against bombers.

'''"Spawn Cluster Baby,15"'''
*Will spawn the specified number of missiles upon detonation.

'''"Remote Detonate"'''
*Can be triggered remotely via a second press on the trigger

'''"Bomb"'''
*Makes this weapon targetable with the B key, and the AI prefers to use it against large ships

'''"No Dumbfire"'''
*Missile will not fire without a lock

'''"EMP"'''
*This weapon will have an EMP effect on any ship within the blast radius

'''"Electronics"'''
*Will seize up the weapons and engines systems of any ship of cruiser class or below for a short period of time

'''"child"'''
*Cannot be set as a weapon on any ship, but is instead a child of a cluster weapon like the Piranha or Infyrno

==SCP - Weapons Table==

Weapons.tbl

2005-11-12T08:50:10Z

84.248.195.235:

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

==Retail FS2 - Standard Primaries==

====$Name:====
*This is the name of the weapon. If it's going to be used by the player, keep it under 12 characters so it doesn't spill over the HUD box. If the weapon has an @ symbol in front of it, it means it's allowed in the demo. It doesn't really do anything in the retail version.
*Syntax: ''Name''

====+Title:====
*This is the title of the weapon in the Weapons loadout screen. Only needed for player allowed weapons.
*Syntax: XSTR(''"Title"'', -1)

====+Description:====
*This is the description you see in the weapons loadout screen. Again, these aren't based on any hard numbers, just approximations. Only needed for player allowed weapons.

XSTR(
"Standard Issue
Level 3 Hull Damage
Level 2 Shield Damage", 3244)
$end_multi_text

====+Tech Title:====
*Title of the weapon in the Tech room. Only needed for player allowed weapons.
*Syntax: XSTR(''"Title"'', -1)

====+Tech Anim:====
*Animation used for the weapon in the Tech room. Only needed for player allowed weapons.
*Syntax: ''Filename''
**Example: Tech_Subach_HL-7

====+Tech Description:====
*Descriptive text you see in the tech room. Only needed for player allowed weapons.

XSTR(
"The Subach-Innes HL-7...", 3245)
$end_multi_text

====$Model File:====
*filename of the model file (.pof) at data/models folder
*Syntax: ''Filename'', lasers don't use specific models so usually name is 'none'.
**Example: none
*'''@Laser Bitmap:'''
**The graphic file to be used as the laser.
**Syntax: ''Filename''
*'''@Laser Glow:'''
**The graphic file that determines the glow of the laser.
**Syntax: ''Filename''
*'''@Laser Color:'''
**The color of the laser when you fire it.
**Syntax: "Value, Value, Value'' (Red, Green, Blue respectively, value from 0 to 255)
***Example: 250, 0, 0
*'''@Laser Color2:'''
**The color of the laser at its maximum range.
**Syntax: "Value, Value, Value'' (Red, Green, Blue respectively, value from 0 to 255)
***Example: 0, 0, 250
*'''@Laser Length:'''
**Length of the laser bolt.
**Syntax: ''Value'', (1/10 of a meters)
*'''@Laser Head Radius:'''
**Width of the head of the laser.
**Syntax: ''Value'', (meters ?)
*'''@Laser Tail Radius:'''
**Width of the tail of the laser.
**Syntax: ''Value'' (meters ?)

====$Mass:====
*How much of a kinetic effect this laser has on its target. 3+ gives you the Flail effect. Set it to 10 and you can knock cruisers around.
*Syntax: ''Value'', (blast effect)

====$Velocity:====
*How fast the laser bolt travels.
*Syntax: ''Value'', (meters per second)

====$Fire Wait:====
*Time in seconds between shots
*Syntax: ''Value'', (seconds)

====$Damage:====
*Base damage this laser does. The actual damage is this number multiplied by one of the factors below.
*Syntax: ''Value'', (damage value)

====$Armor Factor:====
*Multiplier for the damage done to armor
*Syntax: ''Value'', (damage multiplier)

====$Shield Factor:====
*Multiplier for the damage done to shields
*Syntax: ''Value'', (damage multiplier)

====$Subsystem Factor:====
*Multiplier for the damage done to subsystems
*Syntax: ''Value'', (damage multiplier)

====$Lifetime:====
*Time before the laser bolt fizzles out. Multiply this by the speed to get the range. If values are too low (below framerate) then the collision detection and graphic effect may suffer.
*Syntax: ''Value'', (seconds)

====$Energy Consumed:====
*The amount of energy each bolt drains firing ship. Has no effect on turretted weapons.
*Syntax: ''Value''

====$Cargo Size:====
*Cargo size, has no effect with primaries.
*Syntax: ''Value'', usually zero

====$Homing: NO====
*You can't have homing primaries. If this is set to YES, then the bolts turn to face their target but keep moving in the same direction.
*Syntax: ''YES'' or ''NO'', usually NO

====$LaunchSnd:====
*Corresponding sound effect when the weapon is launched.
*Syntax: ''Value'', identification number of the sound as defined in sounds.tbl

====$ImpactSnd:====
*Sound the weapon makes when it hits a hull.
*Syntax: ''Value'', identification number of the sound as defined in sounds.tbl

====$FlyBySnd:====
*The sound this weapon makes if it narrowly misses you. -1 is no sound. Is often left out from table parsing by having <nowiki>;</nowiki> symbol in beginning of the line.
*Syntax: ''Value'', identification number of the sound as defined in sounds.tbl, usually -1

====+Weapon Range:====
*Defines the range to the target where the weapons under AI will start firing.??
*Syntax: ''Value'', (meters)

====$Flags:====
*Flags are detailed below.

====$Trail:====
*This is used if you want your weapon to have a trail. Is often left out from table parsing by having <nowiki>;</nowiki> symbol in beginning of the line.
*'''+Start Width:'''
**How wide the head of the trail is.
**Syntax: ''Value'', (meters)
*'''+End Width:'''
**How wide the tail of the trail is.
**Syntax: ''Value'', (meters)
*'''+Start Alpha:'''
**The opacity of the trail head.
**Syntax: ''Value'' value between 0 and 1
*'''+End Alpha:'''
**The opacity of the trail tail.
**Syntax: ''Value'', value between 0 and 1
*'''+Max Life:'''
**How long the trail lasts.
**Syntax: ''Value'', (seconds)
*'''+Bitmap:'''
**The graphic file to use for the trail.
**Syntax: ''Filename''

====$Icon:====
*Loadout icon used in the weapons selection screen.
*Syntax: ''Filename''

====$Anim:====
*Green grid animation used on the weapons screen.
*Syntax: ''Filename''

====$Impact Explosion:====
*Impact explosion used. Must be defined in weapon_expl.tbl
*Syntax: ''Filename'', usually 'none', as often primaries are not given impact explosion.

====$Impact Explosion Radius:====
*Radius of the defined impact explosion. If the impact explosion is not used then this line should be omitted (remove or begin line with <nowiki> ; </nowiki>)
*Syntax: ''Filename''

==Retail FS2 - Beam Cannons==
*Most of the fields here are irrelevant, and included only so as not to break the parser. '''UNUSED''' indicates that the entry has no effect on beam performance but it has to be present so that parser is not broken.

====$Name:====
*This is the name of the weapon. If it's going to be used by the player, keep it under 12 characters so it doesn't spill over the HUD box. If the weapon has an @ symbol in front of it, it means it's allowed in the demo. It doesn't really do anything in the retail version.
*Syntax: ''Name''

====$Model File:====
*filename of the model file (.pof) at data/models folder
*Syntax: ''Filename'', '''UNUSED'''
**Example: none
*'''@Laser Bitmap:'''
**The graphic file to be used as the laser.
**Syntax: ''Filename'', '''UNUSED'''
*'''@Laser Color:'''
**The color of the laser when you fire it.
**Syntax: "Value, Value, Value'' (Red, Green, Blue respectively, value from 0 to 255), '''UNUSED'''
***Example: 250, 0, 0
*'''@Laser Length:'''
**Length of the laser bolt.
**Syntax: ''Value'', (1/10 of a meters), '''UNUSED'''
*'''@Laser Head Radius:'''
**Width of the head of the laser.
**Syntax: ''Value'', (meters ?), '''UNUSED'''
*'''@Laser Tail Radius:'''
**Width of the tail of the laser.
**Syntax: ''Value'', (meters ?), '''UNUSED'''

====$Mass:====
*How much of a kinetic effect this beamr has on its target. 3+ gives you the Flail effect. Set it to 10 and you can knock cruisers around.
*Syntax: ''Value'', (blast effect)

====$Velocity:====
*Beams travel instantly so this field has effect only on weapon range and AI beam targetting with certain beam types.
*Syntax: ''Value'', (meters per second)

====$Fire Wait:====
*Time in seconds between shots
*Syntax: ''Value'', (seconds)

====$Damage:====
*Base damage this beam does is continous damage, damage is 5.5 times the damage value per second. The actual damage is this number multiplied by one of the factors below.
*Syntax: ''Value'', (damage value)

====$Armor Factor:====
*Multiplier for the damage done to armor
*Syntax: ''Value'', (damage multiplier)

====$Shield Factor:====
*Multiplier for the damage done to shields
*Syntax: ''Value'', (damage multiplier)

====$Subsystem Factor:====
*Multiplier for the damage done to subsystems
*Syntax: ''Value'', (damage multiplier)

====$Lifetime:====
*This field has no effect for the beams apart from weapon range and AI beam targetting with certain beam types
*Syntax: ''Value'', (seconds)

====$Energy Consumed:====
*The amount of energy each bolt drains firing ship. Has no effect on turretted weapons.
*Syntax: ''Value'', '''UNUSED'''

====$Cargo Size:====
*Cargo size, has no effect with primaries.
*Syntax: ''Value'', '''UNUSED'''

====$Homing: NO====
*You can't have homing primaries. If this is set to YES, then the bolts turn to face their target but keep moving in the same direction.
*Syntax: ''YES'' or ''NO'', usually NO, '''UNUSED'''

====$LaunchSnd:====
*Corresponding sound effect when the weapon is launched.
*Syntax: ''Value'', identification number of the sound as defined in sounds.tbl, '''UNUSED'''

====$ImpactSnd:====
*Sound the weapon makes when it hits a hull.
*Syntax: ''Value'', identification number of the sound as defined in sounds.tbl, '''UNUSED'''

====+Weapon Range:====
*This is the range at which the beams will acquire a target. Beams will still do damage to anything farther away than this, but they will not fire of their own accord.
*Syntax: ''Value'' (meters)

====$Flags:====
*See below

====$Icon:====
*Loadout icon used in the weapons selection screen.
*Syntax: ''Filename'', '''UNUSED'''

====$Anim:====
*Green grid animation used on the weapons screen.
*Syntax: ''Filename'', '''UNUSED'''

====$Impact Explosion:====
*Impact explosion used. Must be defined in weapon_expl.tbl
*Syntax: ''Filename''

====$Impact Explosion Radius:====
*Radius of the defined impact explosion. If the impact explosion is not used then this line should be omitted (remove or begin line with <nowiki> ; </nowiki>)
*Syntax: ''Filename''

====$BeamInfo:====
*Has special fields for different beam parameters
*'''+Type:'''
**Defines the type of beam in question. Beam types: 0 is a standard non-slashing type beam. 1 is a slashing type beam. 3 is a beam type that fires pulses in anti-fighter role and acts like type 0 beam in other roles. 4 is a beam that is restricted to what is directly in front of it, along turrets firepoints normal. Nobody knows what Type 2 beams are.
**Syntax: ''Value'', only values from 0 to 4 are legal
*'''+Life:'''
**How long it lasts once the beam is actually firing.
**Syntax: ''Value'', (seconds)
*'''+Warmup:'''
**Warmup time
**Syntax: ''Value'', (milliseconds)
*'''+Warmdown:'''
**Warmdown time
**Syntax: ''Value'', (milliseconds)
*'''+Radius:'''
**Muzzle glow radius
**Syntax: ''Value'' (meters)
*'''+PCount:'''
**Particles spewed every interval. ??
**Syntax: ''Value''
*'''+PRadius:'''
**Particle radius
**Syntax: ''Value'', (meters)
*'''+PAngle:'''
**Defines the random "cone" where the particles are generated
**Syntax: ''Value'', (angle of the cone)
*'''+PAni:'''
**Animation used to represent the particles
**Syntax: ''Filename''
*'''+Miss Factor:'''
**The higher the numbers, the more likely that this beam will miss. One value for every difficulty level
**Syntax: ''Value Value Value Value Value'', Very Easy, Easy, Moderate, Hard, Very Hard respectively.
***Example: 0.5 0.975 1.35 1.875 2.5
*'''+BeamSound:'''
**Corresponding looping sound effect when the beam is firing.
**Syntax: ''Value'', identification number of the sound as defined in sounds.tbl
*'''+WarmupSound:'''
**Corresponding sound effect when the beam is beam warmed up.
**Syntax: ''Value'', identification number of the sound as defined in sounds.tbl
*'''+WarmdownSound:'''
**Corresponding sound effect when the beam is warming down.
**Syntax: ''Value'', identification number of the sound as defined in sounds.tbl
*'''+Muzzleglow:'''
**Defines the bitmap used t create the muzzle glow
**Syntax: ''Filename''
*'''+Shots:'''
**Defines into how may invidual shots the type 3 (AAA) beams are divided. Note total firing is the same as the +Life:
**Syntax: ''Value''
*'''+ShrinkFactor:'''
**What percentage of lifetime where beam starts shrinking (0.1 == 10% life left)
**Syntax: ''Value''
*'''+ShrinkPct:'''
**What percentage of max width we subtract per second
**Syntax: ''Value''
*'''$Section:'''
**Beams are made up of up to five sections layered atop one another to create the effect. Each section has its own parameters.
**'''+Width:'''
***Width of the section
***Syntax: ''Value'' (meters)
**'''+Texture:'''
***Texture for the section
***Syntax: ''Filename''
**'''+RGBA Inner:'''
***Defines the color and transparency of the center of the section
***Syntax: ''Value Value Value Value'', (Red, Green, Blue, and Alpha respectively, value from 0 to 255)
****Example: 255 255 255 255
**'''+RGBA Outer:'''
***Defines the color and transparency of the edges of the section
***Syntax: ''Value Value Value Value'', (Red, Green, Blue, and Alpha respectively, value from 0 to 255)
****Example: 150 150 150 10
**'''+Flicker:'''
***Defines how much the section flickers
***Syntax: ''Value'', value from 0 to 1
**'''+Zadd:'''
***Defines the 'thickness' of the section. The higher the Zadd, the closer the section appears to be.
***Syntax: ''Value''

Weapons.tbl

2005-11-12T08:48:33Z

84.248.195.235:

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

==Retail FS2 - Standard Primaries==

====$Name:====
*This is the name of the weapon. If it's going to be used by the player, keep it under 12 characters so it doesn't spill over the HUD box. If the weapon has an @ symbol in front of it, it means it's allowed in the demo. It doesn't really do anything in the retail version.
*Syntax: ''Name''

====+Title:====
*This is the title of the weapon in the Weapons loadout screen. Only needed for player allowed weapons.
*Syntax: XSTR(''"Title"'', -1)

====+Description:====
*This is the description you see in the weapons loadout screen. Again, these aren't based on any hard numbers, just approximations. Only needed for player allowed weapons.

XSTR(
"Standard Issue
Level 3 Hull Damage
Level 2 Shield Damage", 3244)
$end_multi_text

====+Tech Title:====
*Title of the weapon in the Tech room. Only needed for player allowed weapons.
*Syntax: XSTR(''"Title"'', -1)

====+Tech Anim:====
*Animation used for the weapon in the Tech room. Only needed for player allowed weapons.
*Syntax: ''Filename''
**Example: Tech_Subach_HL-7

====+Tech Description:====
*Descriptive text you see in the tech room. Only needed for player allowed weapons.

XSTR(
"The Subach-Innes HL-7 is a xaser weapon, firing an intense, highly focused beam of X-ray emissions. Until the Shivans appeared with their shield technology, these weapons were considered an unnecessary and costly extravagance. But Great War dogfights against Shivan craft taught the Allies that their ships didn't stand a chance unless they could punch through shields. The HL-7 works superbly against shields of all varieties and has become the standing issue primary weapon for all Terran fighters and bombers.", 3245)
$end_multi_text

====$Model File:====
*filename of the model file (.pof) at data/models folder
*Syntax: ''Filename'', lasers don't use specific models so usually name is 'none'.
**Example: none
*'''@Laser Bitmap:'''
**The graphic file to be used as the laser.
**Syntax: ''Filename''
*'''@Laser Glow:'''
**The graphic file that determines the glow of the laser.
**Syntax: ''Filename''
*'''@Laser Color:'''
**The color of the laser when you fire it.
**Syntax: "Value, Value, Value'' (Red, Green, Blue respectively, value from 0 to 255)
***Example: 250, 0, 0
*'''@Laser Color2:'''
**The color of the laser at its maximum range.
**Syntax: "Value, Value, Value'' (Red, Green, Blue respectively, value from 0 to 255)
***Example: 0, 0, 250
*'''@Laser Length:'''
**Length of the laser bolt.
**Syntax: ''Value'', (1/10 of a meters)
*'''@Laser Head Radius:'''
**Width of the head of the laser.
**Syntax: ''Value'', (meters ?)
*'''@Laser Tail Radius:'''
**Width of the tail of the laser.
**Syntax: ''Value'' (meters ?)

====$Mass:====
*How much of a kinetic effect this laser has on its target. 3+ gives you the Flail effect. Set it to 10 and you can knock cruisers around.
*Syntax: ''Value'', (blast effect)

====$Velocity:====
*How fast the laser bolt travels.
*Syntax: ''Value'', (meters per second)

====$Fire Wait:====
*Time in seconds between shots
*Syntax: ''Value'', (seconds)

====$Damage:====
*Base damage this laser does. The actual damage is this number multiplied by one of the factors below.
*Syntax: ''Value'', (damage value)

====$Armor Factor:====
*Multiplier for the damage done to armor
*Syntax: ''Value'', (damage multiplier)

====$Shield Factor:====
*Multiplier for the damage done to shields
*Syntax: ''Value'', (damage multiplier)

====$Subsystem Factor:====
*Multiplier for the damage done to subsystems
*Syntax: ''Value'', (damage multiplier)

====$Lifetime:====
*Time before the laser bolt fizzles out. Multiply this by the speed to get the range. If values are too low (below framerate) then the collision detection and graphic effect may suffer.
*Syntax: ''Value'', (seconds)

====$Energy Consumed:====
*The amount of energy each bolt drains firing ship. Has no effect on turretted weapons.
*Syntax: ''Value''

====$Cargo Size:====
*Cargo size, has no effect with primaries.
*Syntax: ''Value'', usually zero

====$Homing: NO====
*You can't have homing primaries. If this is set to YES, then the bolts turn to face their target but keep moving in the same direction.
*Syntax: ''YES'' or ''NO'', usually NO

====$LaunchSnd:====
*Corresponding sound effect when the weapon is launched.
*Syntax: ''Value'', identification number of the sound as defined in sounds.tbl

====$ImpactSnd:====
*Sound the weapon makes when it hits a hull.
*Syntax: ''Value'', identification number of the sound as defined in sounds.tbl

====$FlyBySnd:====
*The sound this weapon makes if it narrowly misses you. -1 is no sound. Is often left out from table parsing by having <nowiki>;</nowiki> symbol in beginning of the line.
*Syntax: ''Value'', identification number of the sound as defined in sounds.tbl, usually -1

====+Weapon Range:====
*Defines the range to the target where the weapons under AI will start firing.??
*Syntax: ''Value'', (meters)

====$Flags:====
*Flags are detailed below.

====$Trail:====
*This is used if you want your weapon to have a trail. Is often left out from table parsing by having <nowiki>;</nowiki> symbol in beginning of the line.
*'''+Start Width:'''
**How wide the head of the trail is.
**Syntax: ''Value'', (meters)
*'''+End Width:'''
**How wide the tail of the trail is.
**Syntax: ''Value'', (meters)
*'''+Start Alpha:'''
**The opacity of the trail head.
**Syntax: ''Value'' value between 0 and 1
*'''+End Alpha:'''
**The opacity of the trail tail.
**Syntax: ''Value'', value between 0 and 1
*'''+Max Life:'''
**How long the trail lasts.
**Syntax: ''Value'', (seconds)
*'''+Bitmap:'''
**The graphic file to use for the trail.
**Syntax: ''Filename''

====$Icon:====
*Loadout icon used in the weapons selection screen.
*Syntax: ''Filename''

====$Anim:====
*Green grid animation used on the weapons screen.
*Syntax: ''Filename''

====$Impact Explosion:====
*Impact explosion used. Must be defined in weapon_expl.tbl
*Syntax: ''Filename'', usually 'none', as often primaries are not given impact explosion.

====$Impact Explosion Radius:====
*Radius of the defined impact explosion. If the impact explosion is not used then this line should be omitted (remove or begin line with <nowiki> ; </nowiki>)
*Syntax: ''Filename''

==Retail FS2 - Beam Cannons==
*Most of the fields here are irrelevant, and included only so as not to break the parser. '''UNUSED''' indicates that the entry has no effect on beam performance but it has to be present so that parser is not broken.

====$Name:====
*This is the name of the weapon. If it's going to be used by the player, keep it under 12 characters so it doesn't spill over the HUD box. If the weapon has an @ symbol in front of it, it means it's allowed in the demo. It doesn't really do anything in the retail version.
*Syntax: ''Name''

====$Model File:====
*filename of the model file (.pof) at data/models folder
*Syntax: ''Filename'', '''UNUSED'''
**Example: none
*'''@Laser Bitmap:'''
**The graphic file to be used as the laser.
**Syntax: ''Filename'', '''UNUSED'''
*'''@Laser Color:'''
**The color of the laser when you fire it.
**Syntax: "Value, Value, Value'' (Red, Green, Blue respectively, value from 0 to 255), '''UNUSED'''
***Example: 250, 0, 0
*'''@Laser Length:'''
**Length of the laser bolt.
**Syntax: ''Value'', (1/10 of a meters), '''UNUSED'''
*'''@Laser Head Radius:'''
**Width of the head of the laser.
**Syntax: ''Value'', (meters ?), '''UNUSED'''
*'''@Laser Tail Radius:'''
**Width of the tail of the laser.
**Syntax: ''Value'', (meters ?), '''UNUSED'''

====$Mass:====
*How much of a kinetic effect this beamr has on its target. 3+ gives you the Flail effect. Set it to 10 and you can knock cruisers around.
*Syntax: ''Value'', (blast effect)

====$Velocity:====
*Beams travel instantly so this field has effect only on weapon range and AI beam targetting with certain beam types.
*Syntax: ''Value'', (meters per second)

====$Fire Wait:====
*Time in seconds between shots
*Syntax: ''Value'', (seconds)

====$Damage:====
*Base damage this beam does is continous damage, damage is 5.5 times the damage value per second. The actual damage is this number multiplied by one of the factors below.
*Syntax: ''Value'', (damage value)

====$Armor Factor:====
*Multiplier for the damage done to armor
*Syntax: ''Value'', (damage multiplier)

====$Shield Factor:====
*Multiplier for the damage done to shields
*Syntax: ''Value'', (damage multiplier)

====$Subsystem Factor:====
*Multiplier for the damage done to subsystems
*Syntax: ''Value'', (damage multiplier)

====$Lifetime:====
*This field has no effect for the beams apart from weapon range and AI beam targetting with certain beam types
*Syntax: ''Value'', (seconds)

====$Energy Consumed:====
*The amount of energy each bolt drains firing ship. Has no effect on turretted weapons.
*Syntax: ''Value'', '''UNUSED'''

====$Cargo Size:====
*Cargo size, has no effect with primaries.
*Syntax: ''Value'', '''UNUSED'''

====$Homing: NO====
*You can't have homing primaries. If this is set to YES, then the bolts turn to face their target but keep moving in the same direction.
*Syntax: ''YES'' or ''NO'', usually NO, '''UNUSED'''

====$LaunchSnd:====
*Corresponding sound effect when the weapon is launched.
*Syntax: ''Value'', identification number of the sound as defined in sounds.tbl, '''UNUSED'''

====$ImpactSnd:====
*Sound the weapon makes when it hits a hull.
*Syntax: ''Value'', identification number of the sound as defined in sounds.tbl, '''UNUSED'''

====+Weapon Range:====
*This is the range at which the beams will acquire a target. Beams will still do damage to anything farther away than this, but they will not fire of their own accord.
*Syntax: ''Value'' (meters)

====$Flags:====
*See below

====$Icon:====
*Loadout icon used in the weapons selection screen.
*Syntax: ''Filename'', '''UNUSED'''

====$Anim:====
*Green grid animation used on the weapons screen.
*Syntax: ''Filename'', '''UNUSED'''

====$Impact Explosion:====
*Impact explosion used. Must be defined in weapon_expl.tbl
*Syntax: ''Filename''

====$Impact Explosion Radius:====
*Radius of the defined impact explosion. If the impact explosion is not used then this line should be omitted (remove or begin line with <nowiki> ; </nowiki>)
*Syntax: ''Filename''

====$BeamInfo:====
*Has special fields for different beam parameters
*'''+Type:'''
**Defines the type of beam in question. Beam types: 0 is a standard non-slashing type beam. 1 is a slashing type beam. 3 is a beam type that fires pulses in anti-fighter role and acts like type 0 beam in other roles. 4 is a beam that is restricted to what is directly in front of it, along turrets firepoints normal. Nobody knows what Type 2 beams are.
**Syntax: ''Value'', only values from 0 to 4 are legal
*'''+Life:'''
**How long it lasts once the beam is actually firing.
**Syntax: ''Value'', (seconds)
*'''+Warmup:'''
**Warmup time
**Syntax: ''Value'', (milliseconds)
*'''+Warmdown:'''
**Warmdown time
**Syntax: ''Value'', (milliseconds)
*'''+Radius:'''
**Muzzle glow radius
**Syntax: ''Value'' (meters)
*'''+PCount:'''
**Particles spewed every interval. ??
**Syntax: ''Value''
*'''+PRadius:'''
**Particle radius
**Syntax: ''Value'', (meters)
*'''+PAngle:'''
**Defines the random "cone" where the particles are generated
**Syntax: ''Value'', (angle of the cone)
*'''+PAni:'''
**Animation used to represent the particles
**Syntax: ''Filename''
*'''+Miss Factor:'''
**The higher the numbers, the more likely that this beam will miss. One value for every difficulty level
**Syntax: ''Value Value Value Value Value'', Very Easy, Easy, Moderate, Hard, Very Hard respectively.
***Example: 0.5 0.975 1.35 1.875 2.5
*'''+BeamSound:'''
**Corresponding looping sound effect when the beam is firing.
**Syntax: ''Value'', identification number of the sound as defined in sounds.tbl
*'''+WarmupSound:'''
**Corresponding sound effect when the beam is beam warmed up.
**Syntax: ''Value'', identification number of the sound as defined in sounds.tbl
*'''+WarmdownSound:'''
**Corresponding sound effect when the beam is warming down.
**Syntax: ''Value'', identification number of the sound as defined in sounds.tbl
*'''+Muzzleglow:'''
**Defines the bitmap used t create the muzzle glow
**Syntax: ''Filename''
*'''+Shots:'''
**Defines into how may invidual shots the type 3 (AAA) beams are divided. Note total firing is the same as the +Life:
**Syntax: ''Value''
*'''+ShrinkFactor:'''
**What percentage of lifetime where beam starts shrinking (0.1 == 10% life left)
**Syntax: ''Value''
*'''+ShrinkPct:'''
**What percentage of max width we subtract per second
**Syntax: ''Value''
*'''$Section:'''
**Beams are made up of up to five sections layered atop one another to create the effect. Each section has its own parameters.
**'''+Width:'''
***Width of the section
***Syntax: ''Value'' (meters)
**'''+Texture:'''
***Texture for the section
***Syntax: ''Filename''
**'''+RGBA Inner:'''
***Defines the color and transparency of the center of the section
***Syntax: ''Value Value Value Value'', (Red, Green, Blue, and Alpha respectively, value from 0 to 255)
****Example: 255 255 255 255
**'''+RGBA Outer:'''
***Defines the color and transparency of the edges of the section
***Syntax: ''Value Value Value Value'', (Red, Green, Blue, and Alpha respectively, value from 0 to 255)
****Example: 150 150 150 10
**'''+Flicker:'''
***Defines how much the section flickers
***Syntax: ''Value'', value from 0 to 1
**'''+Zadd:'''
***Defines the 'thickness' of the section. The higher the Zadd, the closer the section appears to be.
***Syntax: ''Value''

Ships.tbl

2005-11-12T05:50:53Z

84.248.195.235:

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

==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==

Ships.tbl

2005-11-12T05:49:16Z

84.248.195.235:

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

==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 at percent per second
*Syntax: ''Value'', % of ships hitpoints repaired per second

===$Subsystem Repair Rate:===
*Repair rates at percent per second
*Syntax: ''Value'', % of ships 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==

Ships.tbl

2005-11-12T05:46:31Z

84.248.195.235:

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

==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: ''Numerical value''

===$Warpout speed:===
*Location: After $Warpin speed:
*Sets the speed at which the ship warps out from the game
*Syntax: ''Numerical value''

===$Player warpout speed:===
*Location: After $Warpout speed:
*Sets the speed at which the player warps out from the game
*Syntax: ''Numerical 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 at percent per second
*Syntax: ''Value'', % of ships hitpoints repaired per second

===$Subsystem Repair Rate:===
*Repair rates at percent per second
*Syntax: ''Value'', % of ships 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==

Ships.tbl

2005-11-11T21:48:58Z

84.248.195.235:

Ships.tbl

2005-11-11T21:44:51Z

84.248.195.235:

Ships.tbl

2005-11-11T15:07:44Z

84.248.195.235:

==Ships.tbl==

'''WIP, Please comment, expand and alter'''

'''Includes SCP changes in addition to retail data'''

Made by following the older guide (originally written by GE) by Wanderer I know practically nothing about HTML/Wiki formatting so it ain't gonna look pretty

$Name:
*Model name
*''filename''

$Short name:
*Shortened model name, for FRED
*''????''

$Species:
*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
*''name of the species; as defined in species_defs.tbl''

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 .pof file at data/models
*''Filename''

$Detail distance:
*Definies the distance where the change to different LODs occurs
*''(LOD0, LOD1, ...)''

$Show damage:
*?????
*''YES or NO''

$Density:
*?????
*''Numerical 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.
*''Numerical value''

$Rotdamp:
*Same thing, but for rotational movement.
*''Numerical 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
*''X-axis, Y-axis, Z-axis''

$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
*''X-axis, Y-axis, Z-axis''

$Rear Velocity:
*Defines rear velocity
*''Usually 0''

$Forward accel:
*Number of seconds needed from full stop to maximum velocity
*''Numerical value''

$Forward decel:
*Number of seconds needed from maxumum velocity to full stop
*''Numerical value''

$Slide accel: 
$Slide decel:
*Same for sliding
*''Numerical value; for both''

$Glide:
*Allows gliding in game
*''YES or NO''

$Warpin speed:
*Sets the speed at which the ship warps in
*''Numerical value''

$Warpout speed:
*Sets the speed at which the ship warps out from the game
*''Numerical value''

$Player warpout speed:
*Sets the speed at which the player warps out from the game
*''Numerical value; can not be greater than Max Oclk Speed''

$Expl inner rad:
*Radius at which the full explosion damage is done
*''In meters''

$Expl outer rad:
*Maximum radius at which any damage is done
*''In meters''

$Expl damage:
*Amount of damage done inside the inner radius
*''Damage value''

$Expl blast:
*The intensity of the blast effect when you're within the outer radius
*''Numerical value''

$Expl Propagates:
*This decides whether the ship explodes into debris immediately, or whether it has the many small explosions before breaking apart slowly
*''YES or NO''

$Shockwave Speed:
*Speed shockwave expands at, 0 means no shockwave
*''Speed in meters per s''

$Allowed PBanks:
*List of allowed primary weapons in brackets (weapon name marked with apostrophes). 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.
*''( "Flag" "Flag" ) ( "Flag" "Flag")''

$Allowed Dogfight PBanks:
*Primary weapons for multiplayer
*''( "Flag" "Flag" ) ( "Flag" "Flag")''

$Default PBanks:
*Defines default primary weapons for each of the primary weapon banks
*''( "Flag" "Flag" ) ( "Flag" "Flag")''

$PBank Capacity:
*Defines ammunition capacity of primary weapon banks. In brackets, different weapon banks separated by commas. REQUIRES FLAG "ballistic primaries"
*''( Value, Value )''

$Allowed SBanks: 
$Allowed Dogfight SBanks: 
$Default SBanks:
*Same for secondary weapons
*''( "Flag" "Flag" ) ( "Flag" "Flag")''

$SBank Capacity:
*Defines ammunition capacity of secondary weapon banks. In brackets, different weapon banks separated by commas.
*''( Value, Value )''

$Shields:
*Determines the shield strenght
*''Value''

$Shield Color:
*RGB value for shield color
*''Red, Green, Blue; all values from 0 to 255''

$Power Output:
*The amount of energy available. The higher the output, the faster your weapons recharge.
*''Value''

$Max Oclk Speed:
*Maximum velocity with all energy diverted to engines
*''In meters per s''

$Max Weapon Eng:
*The maximum amount of energy you can store in your primary weapons bank.
*''Value''

$Hitpoints:
*How much damage the ship can take
*''Value''

$Hull Repair Rate: 
$Subsystem Repair Rate:
*Repair rates at percent per second
*''Value; for both''

$Armor Type
*REQUIRES ADDITIONAL TABLE. Defines armor type
*''Armor name; as defined in armor.tbl''

$Flags:
*See below
*''( "Flag" "Flag" )''

$AI Class:
*Default AI class
*''AI name; as defined in AI.tbl''

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

$Countermeasures: 20
*Number of countermeasures that can be loaded to the ship
*''Value''

$Scan time:
*Time it takes to scan the ship
*''Value, in milliseconds''

$EngineSnd:
*Engine sound used for the ship with number referring to sounds.tbl
*''Number of the sound; as defined in sounds.tbl''

$Closeup_pos: 
$Closeup_zoom:
*How the model will show at techroom

$Shield_icon:
*This .ani file should be at data/hud
*''Filename''

$Ship_icon:
*The icon used in ship selection
*''Filename''

$Ship_anim:
*The glowing green grid animation used in ship selection
*''Filename''

$Ship_overhead:
*The overhead view used in the weapons loadout
*''Filename''

$Score:
*Points awarded for destroying the ship
*''Value''

$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
**''X, Y, Z; relative to the centerpoint of the model''
*+Start Width:
**The width of the contrail's head
**''Value; in meters''
*+End Width:
**The width of the contrail's tail
**''Value; in meters''
*+Start Alpha:
**The opacity of the contrail's head
**''Value''
*+End Alpha:
**The opacity of the contrail's tail
**''Value''
*+Max Life:
**How long the contrail remains
**''Value; in seconds''
*+Spew Time:
**????
**''???''
*+Bitmap:
**The image to use for the contrail.
**''Filename''

$Thruster Particles:
*$Thruster Particle Bitmap:
**Name of the animation used for particle thrusters, up to three can be defined
**''Filename''
*$Min Radius:
**''Value; in meters''
*$Max Radius:
**''Value; in meters''
*$Min created:
**''Value; per second''
*$Max created:
**''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
**''Value''

$Thruster Particles:
*$Afterburner Particle Bitmap:
**Name of the animation used for particle thruster afterburners, up to three can be defined
**''Filename''
*$Min Radius:
**''Value; in meters''
*$Max Radius:
**''Value; in meters''
*$Min created:
**''Value; per second''
*$Max created:
**''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
**''Value''

$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.
*''Subsystem name, %-hitpoints, rotation speed''

====Ships.tbl flags====

Talk:Armor.tbl

2005-11-11T13:50:12Z

84.248.195.235:

051111 - All references to Calculation Type changed to Calculation. Wanderer

Talk:Armor.tbl

2005-11-11T13:49:49Z

84.248.195.235:

051105 - All references to Calculation Type changed to Calculation. Wanderer

Armor.tbl

2005-11-11T13:48:08Z

84.248.195.235:

The armor table stores data on FS2's as-of-now-simplistic armor system. It lets you define different damage types per armor.

The reason for defining different damage types per armor is that, realistically, armor may be damaged less by certain types of weapons. For example, a fire-retardant suit may offer excellent protection against a flamethrower, but virtually none against bullets.

It's important to note that the cumbersome +Calculation/+Value system used for defining calculations will, in the future, be deprecated in favor of a more efficient scripting system. However, the current system will be kept for backwards compatibility, if any mods or campaigns choose to make use of the table.

== Example ==
[[armor.tbl]]
#Armor Type
$Name: Reflective
;;This armor is made up of some kind of reflective material,
;;that deflects 1/4 of the energy from laser weapons back into space.
;;However, it is somewhat more fragile than typical hull materials,
;;and takes 1/3 more damage from weapons that use physical projectiles.

$Damage Type: Laser
+Calculation: Multiplicative
+Value: 0.75

$Damage Type: Kinetic
+Calculation: Multiplicative
+Value: 1.33
#End

As you can see above, "Reflective" armor is dealt only 75% of the damage from laser weapons, but 133% of the damage from kinetic weapons. However, in order to activate the armor system, you must assign the armor type to the ships you want it to apply to, and damage types to the weapons you wish to use.

The Thoth fighter seems like a good choice for this armor. Its speed and maneuverability give it the ability to evade missiles, and many direct-fire weapons are energy based. So, to give it this armor, you would add "$Armor Type:" to ships.tbl, under the "Thoth" entry:

'''''[[ships.tbl]]'''''
$Hitpoints: 200
$Armor Type: Reflective
$Flags: ( "player_ship" "fighter" "in tech database")

At this point, the Thoth will be equipped with Reflective armor. However, it will have no effect ''unlesss'' it is hit by a weapon with a "$Damage Type" that is defined in armor.tbl, under the "Reflective" armor entry. Otherwise, Freespace 2 would have no idea how to take into account the defined damage types.

So, in the interests of time, here's how you would assign the "Laser" damage type to the [[Subach HL-7]], and the "Kinetic" damage type to the [[Rockeye]].

Under the Subach entry, you would add "$Damage Type" like so:

'''''[[weapons.tbl]]'''''
$Damage: 15
$Damage Type: Laser
$Armor Factor: 0.9

Under the Rockeye entry, you would add "$Damage Type" like this:

'''''[[weapons.tbl]]'''''
$Damage: 45
$Damage Type: Kinetic
$Armor Factor: 0.1

Now, if you were to start Freespace 2 with these modifications, you would find that the Thoth would take 3/4 as much damage from the [[Subach HL-7]], 1/3 more damage from the [[Rockeye]], but normal damage from everything else. All other ships, not being equipped with any kind of armor, would also be dealt normal damage from all weapons, including the Rockeye and the Subach.