FreeSpace Wiki - User contributions [en]

Iff defs.tbl

2008-05-27T03:20:29Z

Backslash: /* $Flags: */

{{SCP_table}}

Revision information.. 
::'''3.6.x branch:''' 1.9.2.5
::'''3.7 branch:''' 1.14

The IFF (Identification Friend or Foe) table stores data on FS2's IFF entries. This tables default version (shown as example) is included to the code so '''iff_defs.tbl''' is not required unless entries are to be added or changed.

==General Format==
*IFF_defs table consist of the traitor iff definition and from the actual iff definitions
*Table begins with #'''IFFs'''
*First the traitor must be defined with '''$Traitor IFF:'''
**This entry is used to define which IFF is used to represent the traitors IFF
**Value: ''IFF Name''
*Different IFFs entries begin with '''[[iff_defs.tbl#$IFF Name:|$IFF Name:]]
*Table ends with #'''End'''

==$IFF Name:==

===$Colour: or $Color:===
{{Table36|
*Defines the color of the IFF as seen in by default (e.g. in briefing icons).
*Syntax: ( '''Color''' ), three '''integers''', values from 0 to 255; red, green and blue respectively
**Example: ( 0, 255, 0 )}}

===$Attacks:===
{{Table36|
*Defines the IFFs that are attacked by default
*Syntax: ( '''String''' ), name of the IFF
**Example: ( "Friendly" "Neutral" "Traitor" )}}

===+Sees ''IFF Name'' As:===
{{Table36|
*IFF can be set to be seen as in different color than what that IFFS default color is.
*Same IFF may have multiple ''+Sees '''IFF Name''' As:'' entries
*'''''IFF Name''''' defines the name of the IFF to have a different color.
**Example: +Sees '''Hostile''' As:
*Syntax: ( '''Color''' ), three '''integers''', values from 0 to 255; red, green and blue respectively
**Example: ( 255, 0, 0 )}}

===$Flags:===
{{Table36|
*IFFs can have special flags assigned to them.
*Syntax: ( '''"String"''' ), name of the flag
**Example: ( "support allowed" )
**List of flags:
***''"support allowed"''
***''"exempt from all teams at war"''}}
{{Table37|
***''"orders hidden"''
***''"orders shown"''
***''"wing name hidden"''}}

===$Default Ship Flags:===
{{Table36|
*Ships belonging to a particular IFF can have a default set of flags when created in FRED.
*Syntax: ( '''"String" "String"''' ), names of the flags
**Example: ( "cargo-known" )
**List of possible ship flags:
***''"cargo-known"''
***''"ignore-count"''
***''"protect-ship"''
***''"reinforcement"''
***''"no-shields"''
***''"escort"''
***''"player-start"''
***''"no-arrival-music"''
***''"no-arrival-warp"''
***''"no-departure-warp"''
***''"locked"''
***''"invulnerable"''
***''"hidden-from-sensors"''
***''"scannable"''
***''"kamikaze"''
***''"no-dynamic"''
***''"red-alert-carry"''
***''"beam-protect-ship"''
***''"guardian"''
***''"special-warp"''
***''"vaporize"''
***''"stealth"''
***''"friendly-stealth-invisible"''
***''"don't-collide-invisible"''}}

===$Default Ship Flags2:===
{{Table36|
*Ships belonging to a particular IFF can have a default set of flags when created in FRED.
*Syntax: ( '''"String" "String"''' ), names of the flags
**Example: ( "cargo-known" )
**List of possible ship flags:
***''"primitive-sensors"''
***''"no-subspace-drive"''
***''"nav-carry-status"''
***''"no-bank"''
***''"affected-by-gravity"''
***''"toggle-subsystem-scanning"''
***''"targetable-as-bomb"''
***''"no-builtin-messages"''
***''"primaries-locked"''
***''"secondaries-locked"''
***''"no-death-scream"''
***''"always-death-scream"''
***''"nav-needslink"''}}

==Sample Entry==

<pre>
#IFFs

;; Every iff_defs.tbl must contain a Traitor entry. Traitors attack
;; one another (required by the dogfighting code) but it is up to you
;; to decide who attacks the traitor or whom else the traitor attacks.
$Traitor IFF: Traitor

;------------------------
; Friendly
;------------------------
$IFF Name: Friendly
$Color: ( 0, 255, 0 )
$Attacks: ( "Hostile" "Neutral" "Traitor" )
$Flags: ( "support allowed" )
$Default Ship Flags: ( "cargo-known" )

;------------------------
; Hostile
;------------------------
$IFF Name: Hostile
$Color: ( 255, 0, 0 )
$Attacks: ( "Friendly" "Neutral" "Traitor" )
+Sees Friendly As: ( 255, 0, 0 )
+Sees Hostile As: ( 0, 255, 0 )

;------------------------
; Neutral
;------------------------
$IFF Name: Neutral
$Color: ( 255, 0, 0 )
$Attacks: ( "Friendly" "Traitor" )
+Sees Friendly As: ( 255, 0, 0 )
+Sees Hostile As: ( 0, 255, 0 )
+Sees Neutral As: ( 0, 255, 0 )

;------------------------
; Unknown
;------------------------
$IFF Name: Unknown
$Color: ( 255, 0, 255 )
$Attacks: ( "Hostile" )
+Sees Neutral As: ( 0, 255, 0 )
+Sees Traitor As: ( 0, 255, 0 )
$Flags: ( "exempt from all teams at war" )

;------------------------
; Traitor
;------------------------
$IFF Name: Traitor
$Color: ( 255, 0, 0 )
$Attacks: ( "Friendly" "Hostile" "Neutral" "Traitor" )
+Sees Friendly As: ( 255, 0, 0 )

#End
</pre>

[[Category:Tables]]

Invisible characters in ship names

2008-04-06T23:13:57Z

Backslash: /* The wonders of invisible characters in names: */

==The wonders of invisible characters in names:==

One of the handy features of FS2 is that its internal font does not support a lot of the high-ASCII characters, and just has a blank space instead of the actual symbol. This means that characters like Ã¹, Ã¸, or Â¤ will appear as blank spaces inside of FS2 (but not Fred). This fact can be exploited to much benefit.
 
For example, say I want a ship to jump out and then jump back in later in the mission. Technically this is impossible, since a ship can only be created once in a mission (i.e. once the Aquitane has been created, if he leaves or is destroyed he cannot be created again). However, it is possible to have the Aquitane jump out of the mission, and then later have the AquitaneÂ¤ jump in. In reality, the names are different, but to the player they will look identical.
 
Another example is the use of "counter ships". Say I want to give the player a directive to scan 7 of 10 cargo containers. There is no percent-ships-scanned sexp, so if I simply use the is-cargo-known-delay sexp, I will need to make a very complicated event covering every possible combination that would give me 70% scanned containers and 30% unscanned. But if I use counter ships, my life becomes much much easier:
 
First, I place 10 hostile stealth fighters far away from the field of battle, and name them things like Â¤, Ã¿, Ã¾, Ãº, Ã¸, and so on. Next, I set the departure cue of each one so that it leaves when one of the cargo containers is scanned (i.e. when Cargo 1 is scanned, Â¤ departs, when Cargo 2 is scanned, Ã¿ departs). Now in the directive I can use the nice and easy percent-ship-departed sexp with all your counter ships listed underneath it as the condition for the sexp returning true. Meanwhile, because I used high-ASCII characters for names, the ships won't even appear on the player's ship list when he presses F3--as far as he knows, they don't even exist. Remember to check "No Arrival Music" or you'll have constant battle music playing, even in quiet parts of your mission.
{{Table37| As of 2008.04.06, you can use the # symbol for this purpose. This has multiple advantages -- everything after the # is invisible, so you can use more descriptive names, like #cargo1, #cargo2, #cargo3 etc, or Aquitane#round2 for example. More importantly, if these high-ASCII characters ARE ever implemented in FS2 (which may happen someday to allow Unicode and better support the international fans), the previous method would become visible, whereas the # can now be considered the 'proper' way to do it. After all, ships.tbl and weapons.tbl entries already behave like this. }}

[[Category:FRED Tips]]

Weapons.tbl

2008-03-30T22:28:25Z

Backslash: Add javelin missile type

Revision information.. 
::'''3.6.x branch:''' 2.180.2.24
::'''3.7 branch:''' 4536

==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 [[Weapons.tbl#$Pspew:|particle spew]]. Trails can also be added.

==Weapons Table==

===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: '''''String'''''

====$Subtype:====
{{Table36| }}

====+Title:====
*This is the title of the weapon in the Weapons loadout screen. Only needed for player allowed weapons. Title may be anything. Numerical value is a reference to translations in [[Tstrings.tbl]]
*Syntax: XSTR('''''"String"''''', -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. Numerical value is a reference to translations in [[Tstrings.tbl]]

=====Example=====

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

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

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

====+Tech Description:====
*Descriptive text you see in the tech room. Only needed for player allowed weapons. Numerical value is a reference to translations in [[Tstrings.tbl]]

=====Example=====

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

====$Tech Model:====
{{Table36|
*Defines model used in wing loadout screen and in Tech Room for the weapon.
*Syntax: '''''String.pof''''', model filename}}

====$HUD Image:====
{{Table36|
*Defines the picture used to represent the weapon in HUD loadout list
*Syntax: '''''String''''', filename}}

====$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 needed if a model has been defined for the weapon.
*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: '''''String.pof''''' or ''none'', model filename
**Example: ''none''

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

====$External Model File:====
{{Table36|
*Defines the models shown on the gunpoint, used with Bobb's external-visible-weapon code.
*Syntax: '''''String.pof''''', model filename}}

====$Submodel Rotation Speed:====
{{Table36|
*Defines the rotation speed of the external weapon model
*Syntax: '''''Float'''''}}

====$Submodel Rotation Acceleration:====
{{Table36|
*Defines the rotation acceleration of the external weapon model
*Syntax: '''''Float'''''}}

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

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

====@Laser Color:====
**The color of the weapon effect when you fire it.
**Syntax: '''''Color''''', 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: '''''Color''''', red, green, blue respectively, value from 0 to 255
***Example: ''0, 0, 250''

====@Laser Length:====
**Length of the weapon effect.
**Syntax: '''''Float''''', meters

====@Laser Head Radius:====
**Width of the head of the weapon effect.
**Syntax: '''''Float''''', meters

====@Laser Tail Radius:====
**Width of the tail of the weapon effect.
**Syntax: '''''Float''''', 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.
*This is somehow multiplied by the speed. ie ''$Mass: 3'' and ''$Velocity: 200'' has much weaker kinetic effect than ''$Mass: 3'' and ''$Velocity: 1000''. Also $Mass is used to calculate intensity of "shudder" effect if flagged.
*Syntax: '''''Float''''', 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. $Velocity of beam also applies to its kinetic effect along with $Mass.
*Syntax: '''''Float''''', meters per second

====$Fire Wait:====
*Time in seconds between firings
*Syntax: '''''Float''''', seconds

====$Damage:====
*Base damage this weapon does. The actual damage is this number multiplied by the factors below.
*Base damage this beam does is continuous 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: '''''Float''''', damage

====$Damage Type:====
{{Table36|
*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: '''''String''''', name of the damage type as defined in [[armor.tbl]]}}

====$Arm time:====
{{Table36|
*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: '''''Float''''', seconds}}

====$Arm distance:====
{{Table36|
*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: '''''Float''''', meters}}

====$Arm radius:====
{{Table36|
*Defines the distance from the target where the weapon will arm itself
*Syntax: '''''Float''''', meters}}

====$Detonation Range:====
{{Table36|
*Defines the distance from the point in space that the weapon was launched where the weapon will detonate
*Syntax: '''''Float''''', meters}}

====$Detonation Radius:====
{{Table37|
*Defines the distance between the target center point point and the weapon which detonates the weapon.
*Syntax: '''''Float''''', meters}}

====$Shockwave damage:====
{{Table36|
*Override for the damage caused by shockwaves
*Syntax: '''''Float''''', damage}}

====$Shockwave Damage Type:====
{{Table36|
*'''REQUIRES ADDITIONAL TABLE'''. Defines the damage type used for the weapon explosions
*Syntax: '''''String''''', 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: '''''Float''''', blast effect

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

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

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

====$Shockwave rotation:====
{{Table36|
*Defines how the 3D shockwave is rotated.
*Syntax: '''''Angle''''', three values, pitch, bank, heading respectively, in degrees}}

====$Shockwave model:====
{{Table36|
*Defines the model file (.pof) used as a shockwave for the 3D shockwaves.
*Syntax: '''''String.pof''''', model filename}}

====$Shockwave name:====
{{Table36|
*Defines the name of the animation used for the 2D shockwave
*Syntax: '''''String''''', filename}}

====$Dinky shockwave:====
{{Table36|
*Dinky shockwave are used if the weapon is shot down before arming or if the conditions marked at '''Arm time''' and '''Arm distance''' are not reached before impact
*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: '''''Float''''', damage multiplier

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

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

====$Lifetime Min:====
{{Table36|
*Defines the minimum lifetime of the weapon
*Syntax: '''''Float''''', seconds}}

====$Lifetime Max:====
{{Table36|
*Defines the maximum lifetime of the weapon
*Syntax: '''''Float''''', 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 targeting with certain beam types
*Syntax: '''''Float''''', seconds

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

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

====$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: '''''Boolean''''', yes or no
*'''+Type:'''
**Defines the homing method
**Syntax: '''''String''''', ''ASPECT'' or ''HEAT''
{{Table36| An additional option, ''JAVELIN'', has been added. This behaves like an aspect missile but automatically only locks onto the engines of a target, and only if the engines are in sight.}}
*'''+Turn Time:'''
**Defines how well missile maneuvers. Number of seconds it takes the missile to do a 360 degree circle
**Syntax: '''''Float''''', seconds
*'''+View Cone:'''
**'''Heat-seeking missiles only''', this is then number of degrees the missile sees. Value / 2 gives the angle from the missile's centerline.
**Syntax: '''''Float''''', degrees
{{Table36| Has been enabled also to aspect seekers as an option.}}

*'''+Min Lock Time:'''
**'''For aspect/javelin missiles only''', the minimum number of seconds to gain target lock
**Syntax: '''''Float''''', seconds
*'''+Lock Pixels/Sec:'''
**'''For aspect/javelin missiles only''', pixels the aspect triangle moves per second while attempting lock-on
**Syntax: '''''Integer''''', pixels per second
*'''+Catch-up Pixels/Sec:'''
**'''For aspect/javelin missiles only''', pixels moved per second while attempting to catch up to the target
**Syntax: '''''Integer''''', pixels per second
*'''+Catch-up Penalty:'''
**'''For aspect/javelin missiles only''', extra pixels to move after catching up ????
**Syntax: '''''Integer''''', pixels
{{Table36|
*'''+Seeker Strength:'''
**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: '''''Float''''', seeker strength}}

====$Swarm:====
*The number of missiles to fire per volley if it's a swarm missile
*Can be issued to Standard primaries also. Causes single part turrets to malfunction but causes multi part turrets to fire only on their barrel line. Can be used for 'burst fire weapons'.
*Is incompatible with "Corkscrew" option.
*Syntax: '''''Integer''''', number of shots in a swarm
{{Table36|
*'''+SwarmWait:'''
**Defines the time between weapons fired in a swarm
**Syntax: '''''Float''''', seconds
***Default: 0.150}}

====$Free Flight Time:====
{{Table36|
*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: '''''Float''''', seconds
**Default: 0.25}}

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

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

====$Disarmed ImpactSnd:====
{{Table36|
*Sound the weapon makes when it hits a hull before being armed.
*Syntax: '''''Integer''''' or '''''String''''', name or 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: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]], usually -1

====$Model:====
{{Table36|
*Defines used model file. Included for compatibility with countermeasures as they have been merged with weapons in the code.
*Syntax: '''''String.pof''''', model filename}}

====$Rearm Rate:====
*Defines the rate the weapons are loaded to the ship
*Syntax: '''''Float''''', missiles loaded per second

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

====+Weapon Min Range:====
{{Table36|
*Defines the minimum range to the target where the weapons under AI will still fire.
*Implemented before FS_Open 3.6.5
*Syntax: '''''Float''''', 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: '''''Float''''', meters
*'''+End Width:'''
**How wide the tail of the trail is.
**Syntax: '''''Float''''', meters
*'''+Start Alpha:'''
**The opacity of the trail head.
**Syntax: '''''Float''''', value between 0 and 1
*'''+End Alpha:'''
**The opacity of the trail tail.
**Syntax: '''''Float''''', value between 0 and 1
*'''+Max Life:'''
**How long the trail lasts.
**Syntax: '''''Float''''', seconds
*'''+Bitmap:'''
**The graphic file to use for the trail.
**Syntax: '''''String''''', filename

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

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

====$Collide Ship:====
{{Table36|
*Hook for [[Scripting.tbl|Lua]] scripting
*'''Globals:''' "Self", weapon with class that the hook is defined in. "Ship", ship that the weapon collided with.
*'''Override:''' Turns off all damage effects from weapon, as well as weapon being destroyed.}}

{{Table37|
*Has been replaced with '''#Conditional Hooks''', see [[Scripting.tbl]]}}

====$Collide Weapon:====
{{Table36|
*Hook for [[Scripting.tbl|Lua]] scripting
*'''Globals:''' "Self", weapon with class that the hook is defined in. "Weapon", other weapon.
*'''Override:''' Turns off weapon killing types with bombs. If two weapons, weapon "A" (arbitrary) is preferred}}

{{Table37|
*Has been replaced with '''#Conditional Hooks''', see [[Scripting.tbl]]}}

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

====$Impact Explosion Radius:====
*Radius of the defined impact explosion.
*Syntax: '''''Float''''', meters

====$Dinky impact explosion:====
{{Table36|
*Same as Impact explosion but for Dinky (not armed) explosions
*Syntax: '''''String''''', filename or ''none''}}

====$Dinky impact explosion radius:====
{{Table36|
*Same as Impact explosion radius but for Dinky explosions
*Syntax: '''''Float''''', meters}}

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

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

====$EMP Time:====
**Duration of the EMP effect
**Syntax: '''''Float''''', seconds

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

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

====$Corkscrew:====
{{Table36|
*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: '''''Integer''''', number of missiles
*'''+Radius:'''
**Defines the radius used in the corkscrew motion
**Syntax: '''''Float''''', meters
*'''+Fire Delay:'''
**Defines the delay between missile firings
**Syntax: '''''Integer''''', milliseconds
*'''+Counter rotate:'''
**Defines if every other missile rotates to a different direction (clockwise / anticlockwise)
**Syntax: '''''Boolean''''', ''0'' or ''1'', no or yes
*'''+Twist:'''
**Defines the speed of rotation movement on the radius of corkscrew motion.
**Syntax: '''''Float''''', radians per second}}

====$Electronics:====
{{Table36|
*Defines the weapons effect against electronics. Requires [[weapons.tbl#"Electronics"|"electronics"]] flag. '''+New Style:''' and '''+Old Style:''' options are mutually exclusive.
*'''+New Style:'''
**Defines that the electronics use the new style which enables more options.
*'''+Old Style:'''
**Defines that the electronics use the old style. The old style was the way the D-Missile worked in Descent:Freespace.
*'''+Intensity:'''
**May only be used with '''+New Style:''' electronics. Defines how much the electronics hit affects larger ships. An intensity of 1.0 will disrupt a cruiser without trouble.
**Syntax: '''''Float'''''
*'''+Lifetime:'''
**Syntax: '''''Integer''''', milliseconds
*'''+Engine Multiplier:'''
**May only be used with '''+New Style:''' electronics. Defines how much longer the disruption effect lasts for engine subsytems.
**Syntax: '''''Float'''''
*'''+Weapon Multiplier:'''
**May only be used with '''+New Style:''' electronics. Defines how much longer the disruption effect lasts for non-beam turrets.
**Syntax: '''''Float'''''
*'''+Beam Turret Multiplier:'''
**May only be used with '''+New Style:''' electronics. Defines how much longer the disruption effect lasts for beam turrets.
**Syntax: '''''Float'''''
*'''+Sensors Multiplier:'''
**May only be used with '''+New Style:''' electronics. Defines how much longer the disruption effect lasts for sensor subsystems.
**Syntax: '''''Float'''''
*'''+Randomness Time:'''
**Defines the randomness of duration target suffers from the electronics hit. A random number between 0 and this time will be added or subtracted from the disruption time.
**Syntax: '''''Integer''''', milliseconds

* Without any electronics parameters, a weapon with the "electronics" flag will default to the ''Old Style'' mode with a lifetime of 6000 milliseconds and a randomness of 4000 milliseconds. Thus any ship that gets hit can get disrupted for anywhere between 2 to 10 seconds.}}

====$Spawn Angle:====
{{Table36|
*Defines the cone (with an angle) where the spawned weapons appear. ''Value'' gives the angle from the missiles centerline. The maximum possible angle between any two child weapons would be ''Value*2''.
*Syntax: '''''Float''''', degrees}}

====$Local SSM:====
{{Table36|
*Defines the local SSM (Subspace Missile). In effect missile moves via subspace to a position close to the target and starts homing.
*Weapon must be '''''aspect seeking missile''''' and must have '''''[[Weapons.tbl#"local ssm"|local ssm]]''''' flag.
*'''+Warpout Delay:'''
**Defines the time between the missile launch and the subspace jump.
**Syntax: '''''Integer''''', milliseconds
*'''+Warpin Delay:'''
**Defines the time missile stays in subspace before exiting.
**Syntax: '''''Integer''''', milliseconds
*'''+Stage 5 Velocity:'''
**Defines the velocity of the missile after the subspace jump.
**Syntax: '''''Float''''', meters per second
*'''+Warpin Radius:'''
**Defines how far from the SSM will appear from the outer radius of the target.
**Syntax: '''''Float''''', meters
*'''+Lock Range:'''
**Defines the maximum range where SSM can achieve target lock
**Syntax: '''''Float''''', meters}}

====$Countermeasure:====
{{Table36|
*Defines the countermeasure effectiveness and radius
*'''+Heat Effectiveness:'''
**Defines the countermeasures effectiveness against heat seeking missiles
**Syntax: '''''Float''''', cm effectiveness
***Default: 1
*'''+Aspect Effectiveness:'''
**Defines the countermeasures effectiveness against aspect seeking missiles
**Syntax: '''''Float''''', cm effectiveness
***Default: 1
*'''+Effective Radius:'''
**Defines the countermeasures effective radius
**Syntax: '''''Float''''', 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. 2 is a targetting beam that doesn't seem to have much of an effect on anything. 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.
**Syntax: '''''Integer''''',, only values from 0 to 4 are legal
*'''+Life:'''
**How long it lasts once the beam is actually firing.
**Syntax: '''''Float''''', seconds
*'''+Warmup:'''
**Warmup time
**Syntax: '''''Integer''''', milliseconds
*'''+Warmdown:'''
**Warmdown time
**Syntax: '''''Integer''''', milliseconds
*'''+Radius:'''
**Muzzle glow radius
**Syntax: '''''Float''''', meters
*'''+PCount:'''
**Particles spewed every interval. ??
**Syntax: '''''Integer'''''
*'''+PRadius:'''
**Particle radius
**Syntax: '''''Float''''', meters
*'''+PAngle:'''
**Defines the random "cone" where the particles are generated
**Syntax: '''''Float''''', angle of the cone
*'''+PAni:'''
**Animation used to represent the particles
**Syntax: '''''String''''', filename
*'''+Miss Factor:'''
**The higher the numbers, the more likely that this beam will miss. One value for every difficulty level
**Syntax: '''''Miss Factor''''', five '''floats''', very easy, easy, moderate, hard, insane, respectively.
***Example: 0.5 0.975 1.35 1.875 2.5
*'''+BeamSound:'''
**Corresponding looping sound effect when the beam is firing.
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+WarmupSound:'''
**Corresponding sound effect when the beam is beam warmed up.
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+WarmdownSound:'''
**Corresponding sound effect when the beam is warming down.
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+Muzzleglow:'''
**Defines the bitmap used to create the muzzle glow
**Syntax: '''''String''''', 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: '''''Integer'''''
*'''+ShrinkFactor:'''
**What percentage of lifetime where beam starts shrinking (0.1 == 10% life left)
**Syntax: '''''Float'''''
*'''+ShrinkPct:'''
**What percentage of max width we subtract per second
**Syntax: '''''Float'''''
{{Table36|
*'''+Range:'''
**Defines the maximum range where the beam still has any effect.
**Syntax: '''''Float''''', meters
*'''+Attenuation:'''
**Defines the point where the damage caused by the beam starts to attenuate. At maximum range damage is zero.
**Syntax: '''''Float''''', 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.
{{Table36|
:*'''+Index:'''
:**Field used to define with [[Modular Tables]] the beam section which is edited.
:**Syntax: '''''Integer''''', index number legal values are from 0 to 5
:*'''+remove'''
:**Removes the set beam section.
:*'''+nocreate'''
:**Does not create new section for the beam}}

:*'''+Width:'''
:**Width of the section
:**Syntax: '''''Float''''', meters
:*'''+Texture:'''
:**Texture for the section
:**Syntax: '''''String''''', filename
:*'''+RGBA Inner:'''
:**Defines the color and transparency of the center of the section
:**Syntax: '''''Color''''', red, green, blue, 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: '''''Color''''', red, green, blue, alpha, respectively, value from 0 to 255
:***Example: 150 150 150 10
:*'''+Flicker:'''
:**Defines how much the section flickers
:**Syntax: '''''Float''''', value from 0 to 1
:*'''+Zadd:'''
:**Defines the 'thickness' of the section. The higher the Zadd, the closer the section appears to be.
:**Syntax: '''''Float'''''
{{Table36|
:*'''+Tile Factor:'''
:**Defines the beam texture tileing factor. Second number defines the tileing type. Type 0 tiles the graphic in the beam as many times as defined by the 1st number. Type 1 uses the 1st value as the lenght of the tile.
:**Syntax: '''''Float''''', '''''Integer'''''
:*'''+Translation:'''
:**Defines the speed of translation of the beam, a positive value moves from the impact point to the firing point, while a negative value moves away from the firing point towards the impact point. Measured in tiles per second, where the tile count is defined in the "+Tile Factor:" field above.
:**Syntax: '''''Float'''''}}

====$Pspew:====
{{Table36|
*Defines a particle spew effect for the given weapon
*'''+Count:'''
**Defines how many particles are spawn when they are ready to be created
**Syntax: '''''Integer'''''
*'''+Time:'''
**Defines the time in milliseconds between next particle(s) spewed
**Syntax: '''''Integer''''', milliseconds
*'''+Vel:'''
**Defines the created particles velocity as percentage of the weapons velocity
**Syntax: '''''Float'''''
*'''+Radius:'''
**Defines the size of the created particles
**Syntax: '''''Float''''', meters
*'''+Life:'''
**Defines how long the particles last.
**Syntax: '''''Float''''', seconds
*'''+Scale:'''
**Defines the particle spread. Small value will make particles group together
**Syntax: '''''Float'''''
*'''+Bitmap:
**Defines the animation used to create the particle spew effect
**Syntax: '''''String''''', 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.
*TAG Level 1 will illuminate hidden targets such as stealth fighters or ships normally obscured by nebula conditions.
*TAG Level 2 illiminates targets much like TAG Level 1, but turrets will prefer to shoot at them over other ships.
*TAG Level 3 has no effect in retail.
*Syntax: '''''Integer''''' '''''Float''''', TAG level and seconds respectively

====$SSM:====
{{Table36|
*Defines the weapons SSM index number:
*Syntax: '''''Integer'''''}}

====$FOF:====
{{Table36|
*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: '''''Float''''', degrees}}

====$Shots:====
{{Table36|
*Defines the number of shots every time the weapon is fired.
*Syntax: '''''Integer''''', number of shots}}

====$decal:====
{{Table36|
*Defines impact decals if they are in use
*'''''Currently broken'''''
*'''+texture:'''
**Defines the texture used for impact decals (can use '''''-burn''''' and '''''-glow''''' textures)
**Syntax: '''''String''''', filename
*'''+backface texture:'''
**Defines ???
**Syntax: '''''String''''', filename
*'''+radius:'''
**Defines the size of the impact decals on target
**Syntax: '''''Float''''', meters
*'''+burn time:'''
**Defines the time the '''''-burn''''' texture appears on the target
**Syntax: '''''Integer''''', milliseconds}}

====$Transparent:====
{{Table36|
*Defines weapon effect as transparent. Enables optional fields for 'alpha animations'
*'''+Alpha:'''
**Defines the strenght of the alpha (transparency). And also the maximum value for the alpha cycle option
**Syntax: '''''Float''''', from 0 to 1
*'''+Alpha Min:'''
**Defines the minimum alpha value for alpha cycle option
**Syntax: '''''Float''''', from 0 to 1
*'''+Alpha Cycle:'''
**Defines the change in alpha per frame, between '''Alpha''' and '''Alpha Min''' values
**Syntax: '''''Float'''''}}

==Weapon Flags==

==="Electronics"===
*Will seize up the weapons and engines systems of any ship 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.

==="Supercap"===
*Allows this weapon to do the final 75% damage to a ship with the "supercap" 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.
{{Table36|
*'''EXTREMELY IMPORTANT NOTE:'''
**Whenever you plan to use a weapon as a player one in your campaign or missions, '''DO USE THIS FLAG'''.
**Not using it can cause problems within fs_open and it's a BAD MOD DESIGN.
**In the future, fs_open will maybe be able to avoid these problems but, nevertheless, it's still a BAD DESIGN.
**As another possible example: be careful to update "retail" tables if you plan to use Shivan weapons in player fighters.}}

==="Particle Spew"===
*Makes the weapon projectile spew out particles
{{Table36|
*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.
{{Table36|
*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 75%

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

==="countermeasure"===
{{Table36|
*Defines the weapon as a countermeasure}}

==="Ballistic"===
{{Table36|
*Defines the weapon as a ballistic weapon that needs ammunition.
*Make sure you define the size and reload rate for ballistic weapons}}

==="pierce shields"===
{{Table36|
*Causes weapons to penetrate shield without causing damage to it.}}

==="no pierce shields"===
{{Table36|
*Prevents weapons (beams) from piercing shields causing shields to be damaged by weapons first.}}

==="local ssm"===
{{Table36| }}

==="tagged only"===
{{Table36|
*Weapon can only be fired at tagged targets}}

==="beam no whack"===
{{Table36|
*Disables beam whacking (push). Practically same as setting beam mass to zero.}}

==="cycle"===
{{Table36|
*Causes weapon to alternate between firing points}}

==="small only"===
{{Table36|
*Causes AI to use the weapon only on small targets (fighters, bombers etc.)}}

==="same turret cooldown"===
{{Table36|
*Forces the turrets to fire on the designated rate of fire on all difficulty levels and all AI levels}}

==="apply no light"===
{{Table36|
*Prevents light from being applied to the weapon model.}}

==="inherit parent target"===
{{Table37|
*Sets spawned 'chield' weapons to use parent weapon's target-}}

==="training"===
{{Table37|
*Sets weapon to be of training weapon type. ?}}

==Countermeasures==
*Usually not altered. Only one can exist
{{Table36|
*More than one can exist}}

===$Name:===
*Name of the countermeasure
*Syntax: '''''String''''', name

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

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

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

===$LaunchSnd:===
*Defines the sound for the countermeasure launch
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]

===$Model:===
*Defines the used model file (.pof)
*Syntax: '''''String.pof''''', model filename

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

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

==Sample==

<pre>
#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." )
</pre>

[[Category:Tables]]

Weapons.tbl

2008-03-30T22:23:24Z

Backslash: Add javelin missile type

Revision information.. 
::'''3.6.x branch:''' 2.180.2.24
::'''3.7 branch:''' 4564

==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 [[Weapons.tbl#$Pspew:|particle spew]]. Trails can also be added.

==Weapons Table==

===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: '''''String'''''

====$Subtype:====
{{Table36| }}

====+Title:====
*This is the title of the weapon in the Weapons loadout screen. Only needed for player allowed weapons. Title may be anything. Numerical value is a reference to translations in [[Tstrings.tbl]]
*Syntax: XSTR('''''"String"''''', -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. Numerical value is a reference to translations in [[Tstrings.tbl]]

=====Example=====

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

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

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

====+Tech Description:====
*Descriptive text you see in the tech room. Only needed for player allowed weapons. Numerical value is a reference to translations in [[Tstrings.tbl]]

=====Example=====

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

====$Tech Model:====
{{Table36|
*Defines model used in wing loadout screen and in Tech Room for the weapon.
*Syntax: '''''String.pof''''', model filename}}

====$HUD Image:====
{{Table36|
*Defines the picture used to represent the weapon in HUD loadout list
*Syntax: '''''String''''', filename}}

====$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 needed if a model has been defined for the weapon.
*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: '''''String.pof''''' or ''none'', model filename
**Example: ''none''

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

====$External Model File:====
{{Table36|
*Defines the models shown on the gunpoint, used with Bobb's external-visible-weapon code.
*Syntax: '''''String.pof''''', model filename}}

====$Submodel Rotation Speed:====
{{Table36|
*Defines the rotation speed of the external weapon model
*Syntax: '''''Float'''''}}

====$Submodel Rotation Acceleration:====
{{Table36|
*Defines the rotation acceleration of the external weapon model
*Syntax: '''''Float'''''}}

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

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

====@Laser Color:====
**The color of the weapon effect when you fire it.
**Syntax: '''''Color''''', 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: '''''Color''''', red, green, blue respectively, value from 0 to 255
***Example: ''0, 0, 250''

====@Laser Length:====
**Length of the weapon effect.
**Syntax: '''''Float''''', meters

====@Laser Head Radius:====
**Width of the head of the weapon effect.
**Syntax: '''''Float''''', meters

====@Laser Tail Radius:====
**Width of the tail of the weapon effect.
**Syntax: '''''Float''''', 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.
*This is somehow multiplied by the speed. ie ''$Mass: 3'' and ''$Velocity: 200'' has much weaker kinetic effect than ''$Mass: 3'' and ''$Velocity: 1000''. Also $Mass is used to calculate intensity of "shudder" effect if flagged.
*Syntax: '''''Float''''', 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. $Velocity of beam also applies to its kinetic effect along with $Mass.
*Syntax: '''''Float''''', meters per second

====$Fire Wait:====
*Time in seconds between firings
*Syntax: '''''Float''''', seconds

====$Damage:====
*Base damage this weapon does. The actual damage is this number multiplied by the factors below.
*Base damage this beam does is continuous 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: '''''Float''''', damage

====$Damage Type:====
{{Table36|
*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: '''''String''''', name of the damage type as defined in [[armor.tbl]]}}

====$Arm time:====
{{Table36|
*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: '''''Float''''', seconds}}

====$Arm distance:====
{{Table36|
*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: '''''Float''''', meters}}

====$Arm radius:====
{{Table36|
*Defines the distance from the target where the weapon will arm itself
*Syntax: '''''Float''''', meters}}

====$Detonation Range:====
{{Table36|
*Defines the distance from the point in space that the weapon was launched where the weapon will detonate
*Syntax: '''''Float''''', meters}}

====$Detonation Radius:====
{{Table37|
*Defines the distance between the target center point point and the weapon which detonates the weapon.
*Syntax: '''''Float''''', meters}}

====$Shockwave damage:====
{{Table36|
*Override for the damage caused by shockwaves
*Syntax: '''''Float''''', damage}}

====$Shockwave Damage Type:====
{{Table36|
*'''REQUIRES ADDITIONAL TABLE'''. Defines the damage type used for the weapon explosions
*Syntax: '''''String''''', 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: '''''Float''''', blast effect

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

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

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

====$Shockwave rotation:====
{{Table36|
*Defines how the 3D shockwave is rotated.
*Syntax: '''''Angle''''', three values, pitch, bank, heading respectively, in degrees}}

====$Shockwave model:====
{{Table36|
*Defines the model file (.pof) used as a shockwave for the 3D shockwaves.
*Syntax: '''''String.pof''''', model filename}}

====$Shockwave name:====
{{Table36|
*Defines the name of the animation used for the 2D shockwave
*Syntax: '''''String''''', filename}}

====$Dinky shockwave:====
{{Table36|
*Dinky shockwave are used if the weapon is shot down before arming or if the conditions marked at '''Arm time''' and '''Arm distance''' are not reached before impact
*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: '''''Float''''', damage multiplier

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

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

====$Lifetime Min:====
{{Table36|
*Defines the minimum lifetime of the weapon
*Syntax: '''''Float''''', seconds}}

====$Lifetime Max:====
{{Table36|
*Defines the maximum lifetime of the weapon
*Syntax: '''''Float''''', 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 targeting with certain beam types
*Syntax: '''''Float''''', seconds

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

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

====$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: '''''Boolean''''', yes or no
*'''+Type:'''
**Defines the homing method
**Syntax: '''''String''''', ''ASPECT'' or ''HEAT''
{{Table36| An additional option, ''JAVELIN'', has been added. This behaves like an aspect missile but automatically only locks onto the engines of a target, and only if the engines are in sight.}}
*'''+Turn Time:'''
**Defines how well missile maneuvers. Number of seconds it takes the missile to do a 360 degree circle
**Syntax: '''''Float''''', seconds
*'''+View Cone:'''
**'''Heat-seeking missiles only''', this is then number of degrees the missile sees. Value / 2 gives the angle from the missile's centerline.
**Syntax: '''''Float''''', degrees
{{Table36| Has been enabled also to aspect seekers as an option.}}

*'''+Min Lock Time:'''
**'''For aspect/javelin missiles only''', the minimum number of seconds to gain target lock
**Syntax: '''''Float''''', seconds
*'''+Lock Pixels/Sec:'''
**'''For aspect/javelin missiles only''', pixels the aspect triangle moves per second while attempting lock-on
**Syntax: '''''Integer''''', pixels per second
*'''+Catch-up Pixels/Sec:'''
**'''For aspect/javelin missiles only''', pixels moved per second while attempting to catch up to the target
**Syntax: '''''Integer''''', pixels per second
*'''+Catch-up Penalty:'''
**'''For aspect/javelin missiles only''', extra pixels to move after catching up ????
**Syntax: '''''Integer''''', pixels
{{Table36|
*'''+Seeker Strength:'''
**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: '''''Float''''', seeker strength}}

====$Swarm:====
*The number of missiles to fire per volley if it's a swarm missile
*Can be issued to Standard primaries also. Causes single part turrets to malfunction but causes multi part turrets to fire only on their barrel line. Can be used for 'burst fire weapons'.
*Is incompatible with "Corkscrew" option.
*Syntax: '''''Integer''''', number of shots in a swarm
{{Table36|
*'''+SwarmWait:'''
**Defines the time between weapons fired in a swarm
**Syntax: '''''Float''''', seconds
***Default: 0.150}}

====$Free Flight Time:====
{{Table36|
*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: '''''Float''''', seconds
**Default: 0.25}}

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

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

====$Disarmed ImpactSnd:====
{{Table36|
*Sound the weapon makes when it hits a hull before being armed.
*Syntax: '''''Integer''''' or '''''String''''', name or 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: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]], usually -1

====$Model:====
{{Table36|
*Defines used model file. Included for compatibility with countermeasures as they have been merged with weapons in the code.
*Syntax: '''''String.pof''''', model filename}}

====$Rearm Rate:====
*Defines the rate the weapons are loaded to the ship
*Syntax: '''''Float''''', missiles loaded per second

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

====+Weapon Min Range:====
{{Table36|
*Defines the minimum range to the target where the weapons under AI will still fire.
*Implemented before FS_Open 3.6.5
*Syntax: '''''Float''''', 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: '''''Float''''', meters
*'''+End Width:'''
**How wide the tail of the trail is.
**Syntax: '''''Float''''', meters
*'''+Start Alpha:'''
**The opacity of the trail head.
**Syntax: '''''Float''''', value between 0 and 1
*'''+End Alpha:'''
**The opacity of the trail tail.
**Syntax: '''''Float''''', value between 0 and 1
*'''+Max Life:'''
**How long the trail lasts.
**Syntax: '''''Float''''', seconds
*'''+Bitmap:'''
**The graphic file to use for the trail.
**Syntax: '''''String''''', filename

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

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

====$Collide Ship:====
{{Table36|
*Hook for [[Scripting.tbl|Lua]] scripting
*'''Globals:''' "Self", weapon with class that the hook is defined in. "Ship", ship that the weapon collided with.
*'''Override:''' Turns off all damage effects from weapon, as well as weapon being destroyed.}}

{{Table37|
*Has been replaced with '''#Conditional Hooks''', see [[Scripting.tbl]]}}

====$Collide Weapon:====
{{Table36|
*Hook for [[Scripting.tbl|Lua]] scripting
*'''Globals:''' "Self", weapon with class that the hook is defined in. "Weapon", other weapon.
*'''Override:''' Turns off weapon killing types with bombs. If two weapons, weapon "A" (arbitrary) is preferred}}

{{Table37|
*Has been replaced with '''#Conditional Hooks''', see [[Scripting.tbl]]}}

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

====$Impact Explosion Radius:====
*Radius of the defined impact explosion.
*Syntax: '''''Float''''', meters

====$Dinky impact explosion:====
{{Table36|
*Same as Impact explosion but for Dinky (not armed) explosions
*Syntax: '''''String''''', filename or ''none''}}

====$Dinky impact explosion radius:====
{{Table36|
*Same as Impact explosion radius but for Dinky explosions
*Syntax: '''''Float''''', meters}}

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

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

====$EMP Time:====
**Duration of the EMP effect
**Syntax: '''''Float''''', seconds

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

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

====$Corkscrew:====
{{Table36|
*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: '''''Integer''''', number of missiles
*'''+Radius:'''
**Defines the radius used in the corkscrew motion
**Syntax: '''''Float''''', meters
*'''+Fire Delay:'''
**Defines the delay between missile firings
**Syntax: '''''Integer''''', milliseconds
*'''+Counter rotate:'''
**Defines if every other missile rotates to a different direction (clockwise / anticlockwise)
**Syntax: '''''Boolean''''', ''0'' or ''1'', no or yes
*'''+Twist:'''
**Defines the speed of rotation movement on the radius of corkscrew motion.
**Syntax: '''''Float''''', radians per second}}

====$Electronics:====
{{Table36|
*Defines the weapons effect against electronics. Requires [[weapons.tbl#"Electronics"|"electronics"]] flag. '''+New Style:''' and '''+Old Style:''' options are mutually exclusive.
*'''+New Style:'''
**Defines that the electronics use the new style which enables more options.
*'''+Old Style:'''
**Defines that the electronics use the old style. The old style was the way the D-Missile worked in Descent:Freespace.
*'''+Intensity:'''
**May only be used with '''+New Style:''' electronics. Defines how much the electronics hit affects larger ships. An intensity of 1.0 will disrupt a cruiser without trouble.
**Syntax: '''''Float'''''
*'''+Lifetime:'''
**Syntax: '''''Integer''''', milliseconds
*'''+Engine Multiplier:'''
**May only be used with '''+New Style:''' electronics. Defines how much longer the disruption effect lasts for engine subsytems.
**Syntax: '''''Float'''''
*'''+Weapon Multiplier:'''
**May only be used with '''+New Style:''' electronics. Defines how much longer the disruption effect lasts for non-beam turrets.
**Syntax: '''''Float'''''
*'''+Beam Turret Multiplier:'''
**May only be used with '''+New Style:''' electronics. Defines how much longer the disruption effect lasts for beam turrets.
**Syntax: '''''Float'''''
*'''+Sensors Multiplier:'''
**May only be used with '''+New Style:''' electronics. Defines how much longer the disruption effect lasts for sensor subsystems.
**Syntax: '''''Float'''''
*'''+Randomness Time:'''
**Defines the randomness of duration target suffers from the electronics hit. A random number between 0 and this time will be added or subtracted from the disruption time.
**Syntax: '''''Integer''''', milliseconds

* Without any electronics parameters, a weapon with the "electronics" flag will default to the ''Old Style'' mode with a lifetime of 6000 milliseconds and a randomness of 4000 milliseconds. Thus any ship that gets hit can get disrupted for anywhere between 2 to 10 seconds.}}

====$Spawn Angle:====
{{Table36|
*Defines the cone (with an angle) where the spawned weapons appear. ''Value'' gives the angle from the missiles centerline. The maximum possible angle between any two child weapons would be ''Value*2''.
*Syntax: '''''Float''''', degrees}}

====$Local SSM:====
{{Table36|
*Defines the local SSM (Subspace Missile). In effect missile moves via subspace to a position close to the target and starts homing.
*Weapon must be '''''aspect seeking missile''''' and must have '''''[[Weapons.tbl#"local ssm"|local ssm]]''''' flag.
*'''+Warpout Delay:'''
**Defines the time between the missile launch and the subspace jump.
**Syntax: '''''Integer''''', milliseconds
*'''+Warpin Delay:'''
**Defines the time missile stays in subspace before exiting.
**Syntax: '''''Integer''''', milliseconds
*'''+Stage 5 Velocity:'''
**Defines the velocity of the missile after the subspace jump.
**Syntax: '''''Float''''', meters per second
*'''+Warpin Radius:'''
**Defines how far from the SSM will appear from the outer radius of the target.
**Syntax: '''''Float''''', meters
*'''+Lock Range:'''
**Defines the maximum range where SSM can achieve target lock
**Syntax: '''''Float''''', meters}}

====$Countermeasure:====
{{Table36|
*Defines the countermeasure effectiveness and radius
*'''+Heat Effectiveness:'''
**Defines the countermeasures effectiveness against heat seeking missiles
**Syntax: '''''Float''''', cm effectiveness
***Default: 1
*'''+Aspect Effectiveness:'''
**Defines the countermeasures effectiveness against aspect seeking missiles
**Syntax: '''''Float''''', cm effectiveness
***Default: 1
*'''+Effective Radius:'''
**Defines the countermeasures effective radius
**Syntax: '''''Float''''', 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. 2 is a targetting beam that doesn't seem to have much of an effect on anything. 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.
**Syntax: '''''Integer''''',, only values from 0 to 4 are legal
*'''+Life:'''
**How long it lasts once the beam is actually firing.
**Syntax: '''''Float''''', seconds
*'''+Warmup:'''
**Warmup time
**Syntax: '''''Integer''''', milliseconds
*'''+Warmdown:'''
**Warmdown time
**Syntax: '''''Integer''''', milliseconds
*'''+Radius:'''
**Muzzle glow radius
**Syntax: '''''Float''''', meters
*'''+PCount:'''
**Particles spewed every interval. ??
**Syntax: '''''Integer'''''
*'''+PRadius:'''
**Particle radius
**Syntax: '''''Float''''', meters
*'''+PAngle:'''
**Defines the random "cone" where the particles are generated
**Syntax: '''''Float''''', angle of the cone
*'''+PAni:'''
**Animation used to represent the particles
**Syntax: '''''String''''', filename
*'''+Miss Factor:'''
**The higher the numbers, the more likely that this beam will miss. One value for every difficulty level
**Syntax: '''''Miss Factor''''', five '''floats''', very easy, easy, moderate, hard, insane, respectively.
***Example: 0.5 0.975 1.35 1.875 2.5
*'''+BeamSound:'''
**Corresponding looping sound effect when the beam is firing.
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+WarmupSound:'''
**Corresponding sound effect when the beam is beam warmed up.
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+WarmdownSound:'''
**Corresponding sound effect when the beam is warming down.
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+Muzzleglow:'''
**Defines the bitmap used to create the muzzle glow
**Syntax: '''''String''''', 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: '''''Integer'''''
*'''+ShrinkFactor:'''
**What percentage of lifetime where beam starts shrinking (0.1 == 10% life left)
**Syntax: '''''Float'''''
*'''+ShrinkPct:'''
**What percentage of max width we subtract per second
**Syntax: '''''Float'''''
{{Table36|
*'''+Range:'''
**Defines the maximum range where the beam still has any effect.
**Syntax: '''''Float''''', meters
*'''+Attenuation:'''
**Defines the point where the damage caused by the beam starts to attenuate. At maximum range damage is zero.
**Syntax: '''''Float''''', 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.
{{Table36|
:*'''+Index:'''
:**Field used to define with [[Modular Tables]] the beam section which is edited.
:**Syntax: '''''Integer''''', index number legal values are from 0 to 5
:*'''+remove'''
:**Removes the set beam section.
:*'''+nocreate'''
:**Does not create new section for the beam}}

:*'''+Width:'''
:**Width of the section
:**Syntax: '''''Float''''', meters
:*'''+Texture:'''
:**Texture for the section
:**Syntax: '''''String''''', filename
:*'''+RGBA Inner:'''
:**Defines the color and transparency of the center of the section
:**Syntax: '''''Color''''', red, green, blue, 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: '''''Color''''', red, green, blue, alpha, respectively, value from 0 to 255
:***Example: 150 150 150 10
:*'''+Flicker:'''
:**Defines how much the section flickers
:**Syntax: '''''Float''''', value from 0 to 1
:*'''+Zadd:'''
:**Defines the 'thickness' of the section. The higher the Zadd, the closer the section appears to be.
:**Syntax: '''''Float'''''
{{Table36|
:*'''+Tile Factor:'''
:**Defines the beam texture tileing factor. Second number defines the tileing type. Type 0 tiles the graphic in the beam as many times as defined by the 1st number. Type 1 uses the 1st value as the lenght of the tile.
:**Syntax: '''''Float''''', '''''Integer'''''
:*'''+Translation:'''
:**Defines the speed of translation of the beam, a positive value moves from the impact point to the firing point, while a negative value moves away from the firing point towards the impact point. Measured in tiles per second, where the tile count is defined in the "+Tile Factor:" field above.
:**Syntax: '''''Float'''''}}

====$Pspew:====
{{Table36|
*Defines a particle spew effect for the given weapon
*'''+Count:'''
**Defines how many particles are spawn when they are ready to be created
**Syntax: '''''Integer'''''
*'''+Time:'''
**Defines the time in milliseconds between next particle(s) spewed
**Syntax: '''''Integer''''', milliseconds
*'''+Vel:'''
**Defines the created particles velocity as percentage of the weapons velocity
**Syntax: '''''Float'''''
*'''+Radius:'''
**Defines the size of the created particles
**Syntax: '''''Float''''', meters
*'''+Life:'''
**Defines how long the particles last.
**Syntax: '''''Float''''', seconds
*'''+Scale:'''
**Defines the particle spread. Small value will make particles group together
**Syntax: '''''Float'''''
*'''+Bitmap:
**Defines the animation used to create the particle spew effect
**Syntax: '''''String''''', 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.
*TAG Level 1 will illuminate hidden targets such as stealth fighters or ships normally obscured by nebula conditions.
*TAG Level 2 illiminates targets much like TAG Level 1, but turrets will prefer to shoot at them over other ships.
*TAG Level 3 has no effect in retail.
*Syntax: '''''Integer''''' '''''Float''''', TAG level and seconds respectively

====$SSM:====
{{Table36|
*Defines the weapons SSM index number:
*Syntax: '''''Integer'''''}}

====$FOF:====
{{Table36|
*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: '''''Float''''', degrees}}

====$Shots:====
{{Table36|
*Defines the number of shots every time the weapon is fired.
*Syntax: '''''Integer''''', number of shots}}

====$decal:====
{{Table36|
*Defines impact decals if they are in use
*'''''Currently broken'''''
*'''+texture:'''
**Defines the texture used for impact decals (can use '''''-burn''''' and '''''-glow''''' textures)
**Syntax: '''''String''''', filename
*'''+backface texture:'''
**Defines ???
**Syntax: '''''String''''', filename
*'''+radius:'''
**Defines the size of the impact decals on target
**Syntax: '''''Float''''', meters
*'''+burn time:'''
**Defines the time the '''''-burn''''' texture appears on the target
**Syntax: '''''Integer''''', milliseconds}}

====$Transparent:====
{{Table36|
*Defines weapon effect as transparent. Enables optional fields for 'alpha animations'
*'''+Alpha:'''
**Defines the strenght of the alpha (transparency). And also the maximum value for the alpha cycle option
**Syntax: '''''Float''''', from 0 to 1
*'''+Alpha Min:'''
**Defines the minimum alpha value for alpha cycle option
**Syntax: '''''Float''''', from 0 to 1
*'''+Alpha Cycle:'''
**Defines the change in alpha per frame, between '''Alpha''' and '''Alpha Min''' values
**Syntax: '''''Float'''''}}

==Weapon Flags==

==="Electronics"===
*Will seize up the weapons and engines systems of any ship 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.

==="Supercap"===
*Allows this weapon to do the final 75% damage to a ship with the "supercap" 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.
{{Table36|
*'''EXTREMELY IMPORTANT NOTE:'''
**Whenever you plan to use a weapon as a player one in your campaign or missions, '''DO USE THIS FLAG'''.
**Not using it can cause problems within fs_open and it's a BAD MOD DESIGN.
**In the future, fs_open will maybe be able to avoid these problems but, nevertheless, it's still a BAD DESIGN.
**As another possible example: be careful to update "retail" tables if you plan to use Shivan weapons in player fighters.}}

==="Particle Spew"===
*Makes the weapon projectile spew out particles
{{Table36|
*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.
{{Table36|
*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 75%

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

==="countermeasure"===
{{Table36|
*Defines the weapon as a countermeasure}}

==="Ballistic"===
{{Table36|
*Defines the weapon as a ballistic weapon that needs ammunition.
*Make sure you define the size and reload rate for ballistic weapons}}

==="pierce shields"===
{{Table36|
*Causes weapons to penetrate shield without causing damage to it.}}

==="no pierce shields"===
{{Table36|
*Prevents weapons (beams) from piercing shields causing shields to be damaged by weapons first.}}

==="local ssm"===
{{Table36| }}

==="tagged only"===
{{Table36|
*Weapon can only be fired at tagged targets}}

==="beam no whack"===
{{Table36|
*Disables beam whacking (push). Practically same as setting beam mass to zero.}}

==="cycle"===
{{Table36|
*Causes weapon to alternate between firing points}}

==="small only"===
{{Table36|
*Causes AI to use the weapon only on small targets (fighters, bombers etc.)}}

==="same turret cooldown"===
{{Table36|
*Forces the turrets to fire on the designated rate of fire on all difficulty levels and all AI levels}}

==="apply no light"===
{{Table36|
*Prevents light from being applied to the weapon model.}}

==="inherit parent target"===
{{Table37|
*Sets spawned 'chield' weapons to use parent weapon's target-}}

==="training"===
{{Table37|
*Sets weapon to be of training weapon type. ?}}

==Countermeasures==
*Usually not altered. Only one can exist
{{Table36|
*More than one can exist}}

===$Name:===
*Name of the countermeasure
*Syntax: '''''String''''', name

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

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

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

===$LaunchSnd:===
*Defines the sound for the countermeasure launch
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]

===$Model:===
*Defines the used model file (.pof)
*Syntax: '''''String.pof''''', model filename

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

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

==Sample==

<pre>
#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." )
</pre>

[[Category:Tables]]

Ai profiles.tbl

2008-03-30T20:12:49Z

Backslash:

{{SCP_table}}

{{TableVersion|4565|4565}}

==General Format==
*AI_profiles.tbl defines the default AI profile and also any additional global variables that the AI uses. Incorporates some of the materials from the older difficulty.tbl
*Any option left undefined uses default values.
*'''#AI Profiles'''
*'''$Default Profile:'''
*The additional AI profiles
*'''#End'''

==AI Profiles==
*Defines AI profile global variables

===$Default Profile:===
*Unless the name of the default profile is the same as the name of one the additional AI profiles game defaults to retail AI behaviour. Non-default AI profiles must be selected with [[FRED]] for each mission separately.

===$Profile Name:===
*All multiple options relate to difficulty levels (Very Easy, Easy, Medium, Hard, Insane).

----

The following entries accept '''float list''' of five comma separated values. One value for each of the difficulty level.

===$Player Afterburner Recharge Scale:===
{{Table36|
*Sets the speed of afterburner recharge
*Syntax: '''Float list'''
**Default: 5, 3, 2, 1.5, 1}}

===$Max Beam Friendly Fire Damage:===
{{Table36|
*Defines the maximum damage inflicted by friendly beam fire
*Syntax: '''Float list'''
**Default: 0, 5, 10, 20, 30}}

===$Player Countermeasure Life Scale:===
{{Table36|
*Sets the factor applied to player launched countermeasure lifetime
*Syntax: '''Float list'''
**Default: 3, 2, 1.5, 1.25, 1}}

===$AI Countermeasure Firing Chance:===
{{Table36|
*Defines the chance a countermeasure will be fired by an AI-controlled ship (this is scaled by ai_class)
*Syntax: '''Float list'''
**Default: 0.2, 0.3, 0.5, 0.9, 1.1}}

===$AI In Range Time:===
{{Table36|
*Defines the seconds added to the time it takes for an enemy to come in range of (i.e. target) a friendly ship
*Syntax: '''Float list'''
**Default: 2, 1.4, 0.75, 0, -1}}

===$AI Always Links Ammo Weapons:===
{{Table36|
*AI ships will link ballistic primaries if ammo levels are greater than these percents.
*Syntax: '''Float list'''
**Default: 95, 80, 60, 40, 20}}

===$AI Maybe Links Ammo Weapons:===
{{Table36|
*Defines the same as '''$AI Always Links Ammo Weapons:''' but in situations when its hull is below 33 % of maximum hitpoints.
*Syntax: '''Float list'''
**Default: 90, 60, 40, 20, 10}}

===$AI Always Links Energy Weapons:===
{{Table36|
*AI ships will link energy primaries if energy levels are greater than these percents.
*Syntax: '''Float list'''
**Default: 100, 80, 60, 40, 20}}

===$AI Maybe Links Energy Weapons:===
{{Table36|
*Defines the same as '''$AI Always Links Energy Weapons:''' but in situations when its hull is below 33 % of maximum hitpoints.
*Syntax: '''Float list'''
**Default: 90, 60, 40, 20, 10}}

===$Max Missles Locked on Player:===
{{Table36|
*Defines the maximum number of missiles allowed to be homing in on a player at any given time
*Note: Single-player only, no restriction in multiplayer
*Syntax: '''Float list'''
**Default: 2, 3, 4, 7, 99}}

===$Max Player Attackers:===
{{Table36|
*Sets the maximum number of ships allowed to be attacking the player at any given time
*Syntax: '''Float list'''
**Default: 2, 3, 4, 5, 99}}

===$Max Incoming Asteroids:===
{{Table36|
*Sets the maximum number of active (i.e. "thrown") asteroids that can be heading toward a friendly ship at any given time
*Syntax: '''Float list'''
**Default: 3, 4, 5, 7, 10}}

===$Player Damage Factor:===
{{Table36|
*Defines the factor applied to damage suffered by the player
*Syntax: '''Float list'''
**Default: 0.25, 0.5, 0.65, 0.85, 1}}

===$Player Subsys Damage Factor:===
{{Table36|
*Sets the factor applied to subsystem damage suffered by the player. This is in addition to the '''$Player Damage Factor:'''
*Syntax: '''Float list'''
**Default: 0.2, 0.4, 0.6, 0.8, 1}}

===$Predict Position Delay:===
{{Table36|
*Sets the measure of time (in F1_0 units) after which the AI will recalculate the position of its target
*Syntax: '''Float list'''
**Default: 2, 1.5, 1.333, 0.5, 0}}

===$Player Shield Recharge Scale:===
{{Table36|
*Sets the factor applied to the speed at which the player's shields recharge
*Syntax: '''Float list'''
**Default: 4, 2, 1.5, 1.25, 1}}

===$AI Shield Manage Delay:===
{{Table36|
*Also '''$AI Shield Manage Delays:'''
*Sets the time in seconds between each instance of an AI ship managing its shields
*Syntax: '''Float list'''
**Default: 5, 4, 2.5, 1.2, 0.1}}

===$Friendly AI Fire Delay Scale:===
{{Table36|
*Sets the factor applied to "fire wait" for friendly ships
*Syntax: '''Float list'''
**Default: 2, 1.4, 1.25, 1.1, 1}}

===$Hostile AI Fire Delay Scale:===
{{Table36|
*Sets the factor applied to "fire wait" for hostile ships
*Syntax: '''Float list'''
**Default: 4, 2.5, 1.75, 1.25, 1}}

===$Player Subsys Damage Factor:===
{{Table36|
*Also '''$AI Damage Reduction to Player Subsys:'''
*Syntax: '''Float list'''
**Default: 0.2, 0.4, 0.6, 0.8, 1}}

===$AI Turn Time Scale:===
{{Table36|
*Defines the factor applied to time it takes for enemy ships to turn
*Syntax: '''Float list'''
**Default: 3, 2.2, 1.6, 1.3, 1}}

===$Player Weapon Recharge Scale:===
{{Table36|
*Defines the factor applied to the speed at which the player's weapons recharge
*Syntax: '''Float list'''
**Default: 10, 4, 2.5, 2, 1.5}}

===$Max Turret Target Ownage:===
{{Table36|
*Sets the maximum number of turrets on a particular ship allowed to be attacking the same target at any given time
*Syntax: '''Float list'''
**Default: 3, 4, 7, 12, 19}}

===$Max Turret Player Ownage:===
{{Table36|
*Sets the maximum number of turrets on a particular ship allowed to be attacking the player at any given time
*Syntax: '''Float list'''
**Default: 3, 4, 7, 12, 19}}

----

The following entries are boolean flags. They can be set to ''YES'' or ''NO'', ''TRUE'' or ''FALSE'', ''OUI'' or ''NON'', ''HIja′'' or ''ghobe′'', etc. The default is ''NO''.

===$big ships can attack beam turrets on untargeted ships:===
{{Table36|
*If set, big ships can attack a beam turret that's firing on them from a ship that they don't currently have targeted.}}

===$smart primary weapon selection:===
{{Table36|
*If set, enables the new primary weapon selection method}}

===$smart secondary weapon selection:===
{{Table36|
*If set, enables the new secondary weapon selection method (including proper use of bomber+ missiles)}}

===$smart shield management:===
{{Table36|
*If set, enables smart shield management (previously was -smart_shields on the command line)}}

===$allow rapid secondary dumbfire:===
{{Table36|
*If set, allows an AI ship to switch to rapid fire for dumbfire missiles}}

===$huge turret weapons ignore bombs:===
{{Table36|
*If set, causes huge turret weapons (including anti-capship beams) to not target bombs}}

===$don't insert random turret fire delay:===
{{Table36|
*If set, removes the random turret fire delay (from .1 to .9 seconds) inserted in addition to AI Fire Delay Scale}}

===$hack improve non-homing swarm turret fire accuracy:===
{{Table36|
*If set, triggers a hack to improves the accuracy of non-homing swarm missiles by firing them along the turret's last fire direction rather than the direction it currently faces
*Also disables swarm weapons ability to fire only on the 'turrets barrel line'.}}

===$shockwaves damage small ship subsystems:===
{{Table36|
*If set, shockwaves will cause damage to small ship subsystems (like in FS1)}}

===$navigation subsystem governs warpout capability:===
{{Table36|
*If set, ships will not be able to warp out if their navigation subsystem is destroyed or low in strength}}

===$ignore lower bound for minimum speed of docked ship:===
{{Table36|
*If set, there will be no lower bound for the speed at which docked ships move (like in FS1).
*When a ship is towing another ship or ships, the towing ship will be slowed down to a degree depending on the total mass of all docked ships. In FS1, the ships could slow down to an arbitrarily slow speed, even a fraction of a m/s above zero. In FS2, there is a lower bound on this behavior so that all ships are guaranteed to move at a minimum docked speed. When set, this flag removes the lower bound and restores FS1 behavior.}}

===$disable linked fire penalty:===
{{Table36|
*If set, there will be no penalty for linking primaries. Normally, the rate of fire is divided by the number of linked guns.}}

===$disable weapon damage scaling:===
{{Table36|
*If set, weapons will do the same damage to a ship regardless of "big damage", "supercap", etc. ship types.}}

===$use additive weapon velocity:===
{{Table36|
*If set, weapons will inherit their firing ship's velocity. A ship traveling quickly will fire weapons faster than a ship traveling slowly. This also improves the accuracy of weapons fired while gliding.}}

===$use newtonian dampening:===
{{Table36|
*Newtonian Dampening changes turning and acceleration behavior. By default, there's quite a bit of slide when you turn, and when combined with high damp values (such as in BtRL), you can actually push your speed up beyond the max. Newtonian Dampening is the more realistic turns, where too much turning will lower your speed. Forward momentum is also affected. Backslash can explain it in more detail. [http://www.hard-light.net/forums/index.php/topic,50870.msg1029741.html#msg1029741] }}

==Sample Entry==
*Retail FS2 behaviour

<pre>
#AI Profiles

$Default Profile: FS2 RETAIL

$Profile Name: FS2 RETAIL

$Player Afterburner Recharge Scale: 5, 3, 2, 1.5, 1
$Max Beam Friendly Fire Damage: 0, 5, 10, 20, 30
$Player Countermeasure Life Scale: 3, 2, 1.5, 1.25, 1
$AI Countermeasure Firing Chance: 0.2, 0.3, 0.5, 0.9, 1.1
$AI In Range Time: 2, 1.4, 0.75, 0, -1
$AI Always Links Ammo Weapons: 95, 80, 60, 40, 20
$AI Maybe Links Ammo Weapons: 90, 60, 40, 20, 10
$AI Always Links Energy Weapons: 100, 80, 60, 40, 20
$AI Maybe Links Energy Weapons: 90, 60, 40, 20, 10
$Max Missles Locked on Player: 2, 3, 4, 7, 99
$Max Player Attackers: 2, 3, 4, 5, 99
$Max Incoming Asteroids: 3, 4, 5, 7, 10
$Player Damage Factor: 0.25, 0.5, 0.65, 0.85, 1
$Player Subsys Damage Factor: 0.2, 0.4, 0.6, 0.8, 1
$Predict Position Delay: 2, 1.5, 1.33, 0.5, 0
$AI Shield Manage Delay: 5, 4, 2.5, 1.2, 0.1
$Friendly AI Fire Delay Scale: 2, 1.4, 1.25, 1.1, 1
$Hostile AI Fire Delay Scale: 4, 2.5, 1.75, 1.25, 1
$AI Turn Time Scale: 3, 2.2, 1.6, 1.3, 1
$Player Shield Recharge Scale: 4, 2, 1.5, 1.25, 1
$Player Weapon Recharge Scale: 10, 4, 2.5, 2, 1.5
$Max Turret Target Ownage: 3, 4, 7, 12, 19
$Max Turret Player Ownage: 3, 4, 7, 12, 19

$big ships can attack beam turrets on untargeted ships: NO
$smart primary weapon selection: NO
$smart secondary weapon selection: NO
$smart shield management: NO
$allow rapid secondary dumbfire: NO
$huge turret weapons ignore bombs: NO
$don't insert random turret fire delay: NO
$hack improve non-homing swarm turret fire accuracy: NO
$shockwaves damage small ship subsystems: NO
$navigation subsystem governs warpout capability: NO
$ignore lower bound for minimum speed of docked ship: NO
$disable linked fire penalty: NO
$disable weapon damage scaling: NO
$use additive weapon velocity: NO
$use newtonian dampening: NO

#End
</pre>

== References ==
# "[http://www.hard-light.net/forums/index.php/topic,50870.msg1029741.html#msg1029741 Re: New difficulty? - Feature request!]", ''Hard Light Productions Forums'', Hard Light Productions, 2007-12-15. Retrieved on [[December_27]], [[2007]].

[[Category:Tables]]

Texturing

2006-05-30T05:03:43Z

Backslash: /* SCP Team Recommendations */

==General==

Properly texturing a model is perhaps one of the easiest aspects of modeling to actually do, but possibly the hardest to do well. There are two types of texturing methods, tiling and mapping, each with its own distinct advantages and disadvantages. I am not qualified to explain mapping (also called texture wrapping or unwrapping), as this is by far the more difficult of the two to do well. This form of map is most commonly used on fighters, although some capships (many FS1 cruisers, as well as distinct ships like the Lucifer) make use of full mapping. The advantage comes in a form-fitted map, that has each piece distinctly textured to reflect the designer's intentions as to what function each section should serve. However, especially with the older 256x256 maps, large scale mapping can be blurry and inconsistant if extreme care is not given to the construction of a map. Mapping a ship also requires you to be able to create techy maps in a photoshop-like program, and there really isn't an effective substitute.

Texture tiling: This method is simple, and (besides being the primary capital ship texturing method used by Volition) produces a consistantly crisp and consistant hull if applied correctly. When constructing a model, the choice between mapping and tiling generally comes early; anything with large flat or gradually curved expanses can easily exceed the optimal resolution for wrapped textures and makes tiling extremely noticable. As a general rule of thumb, don't create large expances of unbroken hull and you won't have this problem. If you can't get around it, though, try to split the section into two or more horizontal or vertical sections that can be mapped with similar textures or otherwise find a way to break overly repeated textures up. Using a varient of the same texture (such as ~C~Tile1 and ~C~Tile5 from the stock FS2 textures) can work really well here. Once your model is ready to texture, you must provide UV coordinates for each polygon so that the game renderer knows how to display your textures. I start out usually by applying a box UV map to the whole object, and then work from there. This comes with the advantage of lining everything up for tiled textures, but can create some odd seaming effects around 45 degree facings. I then go back and planar map (TS5) or unwrap (3ds Max) any parts that require special attention, such as engines, viewports, corners, etc. so that they fit the scheme I want. I would advise against spherical, cylindrical, or shrinkwrap UV map options, as they tend to create unstable normals (in TS) and almost always create an unexpected "pole" effect around the ends which is difficult to rectify. For a step-by-step walkthrough, I would strongly suggest taking your modeling program of choice and just playing with it. See what you can come up with. And that's all of the texture section until someone who is better at it than I am comes along and fixes this page up.

==SCP Team Recommendations==
The new HT&L feature of Freespace 2 SCP has allowed a vast increase in the number of polygons that can be displayed at any one time, however, in order to keep gameplay smooth, the SCP team recommends the following rules when making models for use in Freespace 2.

'''Textures :-'''

1 : Use as few textures per model as is possible, optimization is the key. For fighters and bombers you should only need a single 512 x 512 map for the model. Capital ships can use more textures, but the less textures and the less memory they take up, the better.

2 : Unless it is absolutely vital, use the .DDS format for storing your images. The DXT formats of these files are compressed and are automatically decompressed by your video hardware, so they take up far less memory, thus improving performance. Freespace 2 also supports .TGA format files, but these should only be used where .DDS files are causing noticeable compression errors on your texture (this can happen most noticeably with semi-transparent textures, or gradients)
*DDS format consists of multiple types. If the texture needs an alpha channel, use DXT5 compression, otherwise use DXT1c compression. (DXT1c uses way less memory and prevents the 'mirror' effect when used with environment maps.)
**Tip: See if the program you use to compress has a High Quality option. With the nvdxt cmdline program, the switch is: -quality_highest
*Other alternatives to TGA -- in cases where DXT compression is unacceptable (noticable errors/artifacts) -- are u888, u8888, or u1555. u888 is 24 bit color and u888 is 32 bit color (24 bit plus 8 bit alpha map), just like the types of TGA. The file doesn't get any smaller than TGA, but it can now have mipmaps (see Models). u1555 is 15-bit color, usually best for files that used to be PCX.

3 : For highly detailed ships, it is better, from a memory point of view, to use one large texture than several smaller ones.

4 : ALWAYS use texture sizes that are a power of 2, i.e. 256, 512, 1024 or, at most, 2048. You can have different ratios, such as 512x256, but always use these sizes.

'''Models :-'''

Remember that any Level of Detail models are going to be stored in memory, so use them sensibly. Freespace SCP now uses Mipmap technology, so you no longer need to create LOD’s for the textures, an old requirement of Freespace 2 modding. Whilst polygon count does not have as dramatic effect on performance as texture size does, it is, as always, best to optimize where possible.

==Texture Types==
Freespace 2 SCP uses mostly .DDS and .TGA format images. These can also be linked together to form animated maps (see later). Also, .PCX files are commonly found as they were the original format of Freepsace 2 Textures.
===Texture naming conventions===
Whilst the textures on your models can be called anything, there are certain naming conventions in creating effects textures such as glow-maps or specularity, basically the naming convention works as follows.

'''TextureName.xxx''' – This is the colour map for the material. It should be mapped out to the models UV Map. This can use an alpha map for transparency.

'''TextureName''-glow''.xxx''' – This is the glow map for the model. It simulates the effect of ‘portholes’ or other glowing part of the ship. Using the same UV Map, and a black background, make any flat lighting effects you want on the ship on this texture. These are different from Glow-points, which are points on the model and are covered later.

'''TextureName''-shine''.xxx''' – This is the Specular map of the model, once again using the UV’s for the model, colour in all the parts of the surface which are metallic, using whatever colour you want the shininess to be. The brighter the colour, the shinier it will be.
'''NOTE:''' Shine maps can also have an alpha map. This alpha map is used to define the level of ‘reflection’ when environment mapping is operating.

'''TextureName''-trans''.xxx''' – This enables the transparency for the map of the model, once again using the UV’s for the model. Map in question can also be set as ''-shine'' or ''-glow'' map (for example '''TextureName''-trans-glow''''').

NOTE : When creating Shine-maps, if the map does not have any environment mapping (reflection effect) then the Spec-map should be saved in DXT1c format with no Alpha-map. This will improve performance for maps that do not use environemt mapping (environment mapping is different to Specular, which helps give a metallic 'effect' to the material).

===Animated Textures===
Freespace 2 SCP also supports two kinds of animated file format. The first is the standard .ANI extension as used by Freespace Retail, you can convert these using the AniBuilder program from the Descent Tools package. The Second format is the new .eff file. This allows multiple single images to be chained together into an animated texture.
All .EFF image files must be in the same format, but can be in any format Freespace SCP supports, and must have an underscore and their Frame number added onto their name as a 4-digit number starting at 0000, for example RunningLights_0000.DDS, RunningLights_0001.DDS etc.
Now simply create a new text file for your animated texture with the same Base name as your texture and a .EFF extension (in this case, RunningLights.EFF) and simply enter the following text.

'''$Type:''' XXX - Defines the type of file being used, can be DDS, TGA, PCX or others

'''$Frames:''' XX - Defines the number of Frames in the total (looping) animation.

'''$FPS:''' XX - The Frame Per Second speed of the animation.

This file should be saved in the textures folder of your project alongside the images themselves.

User:Backslash

2006-05-21T00:12:38Z

Backslash:

As I figure out the whole wiki making thing, I'm going to write things temporarily on my page.

I'm going to write some notes on compiling fs2_open for Windows with Visual Studio 2003 and/or 2005. Hopefully this will be useful for other people with similar problems, or those who always wanted to try but couldn't figure it out.

Really, it's less complicated than it sounds once you've got everything together :-P PM me on the hard-light forums if you have questions.

I did 2003 first and it was easier. Yeah, I know, this version is not so widely used. Well I don't have a full version of 2005, just the Express Edition. So, first, Visual Studio 2003:

* At this point, almost all of the needed libraries and stuff are included in the CVS checkout. This is convenient for us Windows users (but a bit silly for everyone else). All you need is the Platform SDK, and maybe the DirectX SDK (but that I'm not sure you need all of any more).
* Once you download the CVS (pending article), open the projects folder. There you'll find a MSVC_2003 folder, which has some of what we need, but the project hasn't been updated in some time. I'm hoping to get this fixed.
* For now, the best solution is to copy the project files from the MSVC_6 folder. Then open the workspace. It should work right away after a wizarded conversion. Awesome.

Now for Visual C++ 2005 Express Edition:

I dunno if this is the "right" way -- the way I did the dependencies might end up requiring anyone else to whom you give a compiled build needing some extra DLLs. but eh, it works for me. (Corrections welcome, please!) I think it's gotten easier with some changes they made in the May 15 version of the MSVC_6, so what I did was:

* make sure my Tools->Options->Projects and Solutions->VC++ Directories properly points to where I have my Platform SDK and DirectX SDK (do this for Include files and Library files at least)
* erase what's in the MSVC_2005 folder
* copy the contents of MSVC_6 to MSVC_2005
* open the Freespace2.dsw and go through the default conversion steps
* switch to Release configuration
* in Properties of the Freespace2 project, go to Linker, inside it: Input.
* add to Ignore Specific Library: libci.lib
* added to Additional Dependencies: ole32.lib advapi32.lib gdi32.lib user32.lib

And hopefully that should do it. oh there might be some complaints about an undeclared i variable inside a for loop... change "for (i=0 "... to "for (int i=0 "... but you should be familiar with this sort of thing.
Ideally, I can later replace the project in the folder on CVS, if it works for more than just me :D

optional (speeds compiling up)
* in Properties of the Freespace2 project, go to C/C++
* inside Browse Information, change Enable Browse Information to None. Do this for all the projects: Freespace2, code, Fred2.
* inside Code Generation, Enable Minimal Rebuild.
extra optional (just in case, try compiling first... later mess with this stuff. and do it to Release not Debug)
* inside Optimization, tweak as you like. I turned on a bunch of optimizations, including 'Optimize For Processor' to Pentium 4 and above (/G7).
* inside Code Generation, experiment with 'Enable Enhanced Instruction Set' depending on your processor. [me, I have an Athlon XP, which supports SSE but actually runs faster without it if /G7 is on.]

User:Backslash

2006-05-21T00:08:52Z

Backslash:

As I figure out the whole wiki making thing, I'm going to write things temporarily on my page.

I'm going to write some notes on compiling fs2_open for Windows with Visual Studio 2003 and/or 2005. Hopefully this will be useful for other people with similar problems, or those who always wanted to try but couldn't figure it out.

It's less complicated than it sounds once you've got everything together :-P

I did 2003 first and it was easier. Yeah, I know, this version is not so widely used. Well I don't have a full version of 2005, just the Express Edition.

At this point, almost all of the needed libraries and stuff are included in the CVS checkout. This is convenient for us Windows users (but a bit silly for everyone else). All you need is the Platform SDK, and maybe the DirectX SDK (but that I'm not sure you need all of any more).

Once you download the CVS (pending article), open the projects folder. There you'll find a MSVC_2003 folder, which has a lot of what we need, but the project hasn't been updated in some time. I'm hoping to get this fixed.

For now, the solution is to copy the project files from another project folder, such as MSVC_6. Then open the workspace. If you're using 2003, it works right away after a wizarded conversion. Awesome.

Now for Visual C++ 2005 Express Edition:

I dunno if this is the "right" way -- the way I did the dependencies might end up requiring anyone else to whom you give a compiled build needing some extra DLLs. but eh, it works for me. (Corrections welcome, please!) I think it's gotten easier with some changes they made in the May 15 version of the MSVC_6, so what I did was:

* make sure my Tools->Options->Projects and Solutions->VC++ Directories properly points to where I have my Platform SDK and DirectX SDK (do this for Include files and Library files at least)
* erase what's in the MSVC_2005 folder
* copy the contents of MSVC_6 to MSVC_2005
* open the Freespace2.dsw and go through the default conversion steps
* switch to Release configuration
* in Properties of the Freespace2 project, go to Linker, inside it: Input.
* add to Ignore Specific Library: libci.lib
* added to Additional Dependencies: ole32.lib advapi32.lib gdi32.lib user32.lib

And hopefully that should do it. oh there might be some complaints about an undeclared i variable inside a for loop... change "for (i=0 "... to "for (int i=0 "... but you should be familiar with this sort of thing.
Ideally, I can later replace the project in the folder on CVS, if it works for more than just me :D

optional (speeds compiling up)
* in Properties of the Freespace2 project, go to C/C++
* inside Browse Information, change Enable Browse Information to None. Do this for all the projects: Freespace2, code, Fred2.
* inside Code Generation, Enable Minimal Rebuild.
extra optional (just in case, try compiling first... later mess with this stuff. and do it to Release not Debug)
* inside Optimization, tweak as you like. I turned on a bunch of optimizations, including 'Optimize For Processor' to Pentium 4 and above (/G7).
* inside Code Generation, experiment with 'Enable Enhanced Instruction Set' depending on your processor. [me, I have an Athlon XP, which supports SSE but actually runs faster without it if /G7 is on.]

Hud gauges.tbl

2006-05-10T07:33:17Z

Backslash: /* Example */

hud_gauges.tbl (Originally direct paste from FSDoc 2004.12.19, continuing to clean up. Please, somebody who knows more about this table, or just Wiki standards, fix my mistakes!)

IMPORTANT: The information in this section is how hud_gauges.tbl '''should''' work. Some things may not work as this guide says they should; in that case, e-mail me (WMCoolmon) or send me a PM via the Forums.

hud_gauges.tbl is used for modifying the elements of the HUD. It is as of now currently unfinished. However, it can still be used to add custom gauges equivelant to something like the wingman status display.

==Gauge system overview==

*Many of the gauges in Freespace 2 are made up of individual images and text. To allow easy editing, these have been broken up into main gauges and child gauges. '''Main gauges''' (aka parent gauges) are a standalone part of the HUD, and may be one gauge or a collection of gauges. '''Child gauges''' are gauges that are dependant upon another gauge's position.
*For example, in the center of the screen of Freespace 2, there is a gauge that tells you your target's hud strength and shield status. The text is a child gauge, and the shield quadrant is a child gauge. Both of these together make up the main gauge. So, to move both to the corner, you would simply change the position of the main gauge.
*Finally, '''all coordinates are measured in pixels from the upper-left corner of the screen.''' (100 50) is 100 pixels to the right and 50 pixels down; this may seem unnatural at first, but is easy to get used to.

==Sections overview==

*hud_gauges.tbl contains six sections, the most of any table in Freespace. They are:
**Miscellaneous variables
***All miscellaneous variables go at the top of the hud_gauges.tbl file. Currently, the only variable here is the number of escort ships.
**<nowiki>#</nowiki>Custom Gauges
***This is where all custom gauges (and their default attributes) are defined.
**<nowiki>#</nowiki>Main Gauges
***Used to set the attributes of the main HUD gauges, such as the escort list or the shield status display.
**<nowiki>#</nowiki>Gauges
***Used to set individual child gauges' attributes.
**<nowiki>#</nowiki>Ship Main Gauges
***Same as the <nowiki>#</nowiki>Main Gauges section, except it's used for overrides to the gauges for specific ships.
**<nowiki>#</nowiki>Ship Gauges
***Again, this is the same as the <nowiki>#</nowiki>Gauges section, except for individual ship overrides.

==Miscellaneous variables==
*All miscellaneous variables are defined at the top of hud_gauges.tbl. The complete list is as follows:

===$Max Escort Ships: <integer up to 20>===
*Sets the number of escort ships shown in the list. Entries more than 16 will cause the list to overflow into the weapons list under a resolution of 1024x768.

==<nowiki>#</nowiki>Custom Gauges==
*Custom Gauges are easy to use, and incredibly powerful with the hud-set SEXPs. Initially, they are completely blank; in order to see them you must set their text or image variable in one of the Gauges sections. In order to define a new custom gauge, only the name field is needed:

===$Name:===
*What the name of the custom gauge will be
*Syntax: <string of up to 32 characters>

*'''+Default640x:'''
**The Default X coordinate of the gauge in 640x480
**Syntax: <integer>

*'''+Default640y:'''
**The Default Y coordinate in 640x480
**Syntax: <integer>

*'''+Default1024x:'''
**The Default X coordinate in 1024x768
**Syntax: <integer>

*'''+Default1024y:'''
**The Default Y coordinate in 1024x768
**Syntax: <integer>

*'''+Parent:'''
**The parent gauge of the new custom gauge.
**Syntax: <string of up to 32 characters>

==<nowiki>#</nowiki>Main Gauges==
*Each list of main gauge definitions can start with one of two strings - $Resolution and $Default. A list started with $Resolution will only be used if the resolution FreeSpace 2 is started in is exactly the same as $Resolution. $Default lists will be loaded regardless of the resolution. Finally, all tags are '''additive''', so you can define some HUD gauges in a resolution tag and others in another and both will be loaded, provided the tags match up to the current resolution.
*In other words, a list starting with $Resolution: (1024 768) will only be used in 1024 768. However, a list starting with $Default: (640 480) will be scaled to any resolution, regardless of what the current resolution is.
*To have gauges be an absolute distance from the upper-left corner of the screen, regardless of resolution, use $Default: (0 0).
*Finally, gauges are loaded from first to last in the listing of resolution-specific and default gauge lists, so if any valid gauge settings are defined more than once, the last setting will be used. This means that $Default lists '''should always come first''', so that resolution-specific settings will override them, rather than the other way around.
'''IMPORTANT: Only $Default or $Resolution may be defined, NOT both.'''

===$Default:===
*Defines what resolution cooridinates are given in and scale them to the current resolution appropriately. If (0 0) is given, coordinates are assumed to be absolute numbers of pixels from the upper-left corner of the screen no matter what resolution is used in fs2_open.
*Syntax: (<integer> <integer>)
**Tip: Set to (100 100) to set coordinates using percentages.

===$Resolution:===
*Tells fs2_open that coordinates are for the specified resolution and that resolution only. These will not be used or scaled if the resolution fs2_open is started in is different.
*Syntax: (<integer> <integer>)

====$<Gauge name>:====
*Where <Gauge name> is the name of the gauge you want to move, moves the upper-left corner of the gauge to the specified position.
*Syntax: (<floating-point> <floating-point>)
*'''List of known supported retail gauges''': Player Shield, Target Shield, Shield Mini, Afterburner Energy, Weapons Energy, Escort List

*'''+Size:'''
**Defines the size of the gauge; usually not needed, unless the gauge should be centered (see +Percentage below).
**Syntax: (<integer> <integer>)

*'''+Percentage:'''
**Moves the '''center''' of the gauge by the given percent. Added onto the original coordinates given for the gauge.
**Syntax: (<floating-point> <floating-point>)

*'''+Image:'''
**What image or animation the gauge should use. If set for a custom gauge, this image will always be displayed at the gauge's coordinates unless a SEXP is called.
**Syntax: <animation filename of up to 32 characters>

*'''+Text:'''
**What text the gauge should use. If set for a custom gauge, the text will always be shown unless a SEXP is used.
**Syntax: <Text of up to 32 characters, although the limit varies for retail gauges>

*'''+Color:'''
**What color the gauge's image or text should be.
**Syntax: <red value from 0-255> <green value from 0-255> <blue value from 0-255>

==<nowiki>#</nowiki>Ship Main Gauges==
Basically the same as the <nowiki>#</nowiki>Main Gauges Section, the Ship Main Gauges adds a new variable - $Ship. This defines which ship the specified changes will apply to. So, if you set $Ship as "GTF Ulysses", whenever the player flies the Ulysses, s/he will see the HUD changes.
'''IMPORTANT: Only $Default or $Resolution may be defined, NOT both.'''

===$Ship:===
*Defines what ship class HUD attributes will apply to.
*Syntax: <string of up to 32 characters

===$Default:===
*Defines what resolution cooridinates are given in and scale them to the current resolution appropriately. If (0 0) is given, coordinates are assumed to be absolute numbers of pixels from the upper-left corner of the screen no matter what resolution is used in fs2_open.
*Syntax: (<integer> <integer>)
**Tip: Set to (100 100) to set coordinates using percentages.

===$Resolution:===
*Tells fs2_open that coordinates are for the specified resolution and that resolution only. These will not be used or scaled if the resolution fs2_open is started in is different.
*Syntax: (<integer> <integer>)

====$<Gauge name>:====
*Where <Gauge name> is the name of the gauge you want to move, moves the upper-left corner of the gauge to the specified position.
*Syntax: (<floating-point> <floating-point>)

*'''+Size:'''
**Defines the size of the gauge; usually not needed, unless the gauge should be centered (see +Percentage below).
**Syntax: (<integer> <integer>)

*'''+Percentage:'''
**Moves the '''center''' of the gauge by the given percent. Added onto the original coordinates given for the gauge.
**Syntax: (<floating-point> <floating-point>)

*'''+Image:'''
**What image or animation the gauge should use. If set for a custom gauge, this image will always be displayed at the gauge's coordinates unless a SEXP is called.
**Syntax: <animation filename of up to 32 characters>

*'''+Text:'''
**What text the gauge should use. If set for a custom gauge, the text will always be shown unless a SEXP is used.
**Syntax: <Text of up to 32 characters, although the limit varies for retail gauges>

*'''+Color:'''
**What color the gauge's image or text should be.
**Syntax: <red value from 0-255> <green value from 0-255> <blue value from 0-255>

==Minimal Example==
$Max Escort Ships: 15

==Example==
*it runs, but not entirely sure if all of it is working properly; this is a copy-paste from somewhere else... someone please update

$Max Escort Ships: 15

#Main Gauges
$Resolution: (1024 768)
$Escort List: (865 330) ;Where the escort list goes.
+Image: escort1
+Text: Monitoring ;This is incorrect, but how it is in the current build...will be fixed
#End

#Gauges
$Resolution: (1024 768)
$Gauge: Escort List
$Header Text: (4 1)
;+Text: Monitoring ;This is correct, and how it will be after this build
$List: (0 13) ;Where the list starts
$Ship: (0 11) ;An individual entry
+Image: escort2
$Last Ship: (0 11) ;Last entry
+Image: escort3
$Ship Name: (4 0) ;Where the name goes relative to the entry position
$Ship Hull: (116 0) ;Ditto for hull %
$Ship Status: (-11 0) ;Ditto for ship status, aka the D that shows up when a ship is disabled.

[[Category:Tables]]

Hud gauges.tbl

2006-05-10T01:05:06Z

Backslash: /* $<Gauge name>: */

hud_gauges.tbl (Originally direct paste from FSDoc 2004.12.19, continuing to clean up. Please, somebody who knows more about this table, or just Wiki standards, fix my mistakes!)

IMPORTANT: The information in this section is how hud_gauges.tbl '''should''' work. Some things may not work as this guide says they should; in that case, e-mail me (WMCoolmon) or send me a PM via the Forums.

hud_gauges.tbl is used for modifying the elements of the HUD. It is as of now currently unfinished. However, it can still be used to add custom gauges equivelant to something like the wingman status display.

==Gauge system overview==

*Many of the gauges in Freespace 2 are made up of individual images and text. To allow easy editing, these have been broken up into main gauges and child gauges. '''Main gauges''' (aka parent gauges) are a standalone part of the HUD, and may be one gauge or a collection of gauges. '''Child gauges''' are gauges that are dependant upon another gauge's position.
*For example, in the center of the screen of Freespace 2, there is a gauge that tells you your target's hud strength and shield status. The text is a child gauge, and the shield quadrant is a child gauge. Both of these together make up the main gauge. So, to move both to the corner, you would simply change the position of the main gauge.
*Finally, '''all coordinates are measured in pixels from the upper-left corner of the screen.''' (100 50) is 100 pixels to the right and 50 pixels down; this may seem unnatural at first, but is easy to get used to.

==Sections overview==

*hud_gauges.tbl contains six sections, the most of any table in Freespace. They are:
**Miscellaneous variables
***All miscellaneous variables go at the top of the hud_gauges.tbl file. Currently, the only variable here is the number of escort ships.
**<nowiki>#</nowiki>Custom Gauges
***This is where all custom gauges (and their default attributes) are defined.
**<nowiki>#</nowiki>Main Gauges
***Used to set the attributes of the main HUD gauges, such as the escort list or the shield status display.
**<nowiki>#</nowiki>Gauges
***Used to set individual child gauges' attributes.
**<nowiki>#</nowiki>Ship Main Gauges
***Same as the <nowiki>#</nowiki>Main Gauges section, except it's used for overrides to the gauges for specific ships.
**<nowiki>#</nowiki>Ship Gauges
***Again, this is the same as the <nowiki>#</nowiki>Gauges section, except for individual ship overrides.

==Miscellaneous variables==
*All miscellaneous variables are defined at the top of hud_gauges.tbl. The complete list is as follows:

===$Max Escort Ships: <integer up to 20>===
*Sets the number of escort ships shown in the list. Entries more than 16 will cause the list to overflow into the weapons list under a resolution of 1024x768.

==<nowiki>#</nowiki>Custom Gauges==
*Custom Gauges are easy to use, and incredibly powerful with the hud-set SEXPs. Initially, they are completely blank; in order to see them you must set their text or image variable in one of the Gauges sections. In order to define a new custom gauge, only the name field is needed:

===$Name:===
*What the name of the custom gauge will be
*Syntax: <string of up to 32 characters>

*'''+Default640x:'''
**The Default X coordinate of the gauge in 640x480
**Syntax: <integer>

*'''+Default640y:'''
**The Default Y coordinate in 640x480
**Syntax: <integer>

*'''+Default1024x:'''
**The Default X coordinate in 1024x768
**Syntax: <integer>

*'''+Default1024y:'''
**The Default Y coordinate in 1024x768
**Syntax: <integer>

*'''+Parent:'''
**The parent gauge of the new custom gauge.
**Syntax: <string of up to 32 characters>

==<nowiki>#</nowiki>Main Gauges==
*Each list of main gauge definitions can start with one of two strings - $Resolution and $Default. A list started with $Resolution will only be used if the resolution FreeSpace 2 is started in is exactly the same as $Resolution. $Default lists will be loaded regardless of the resolution. Finally, all tags are '''additive''', so you can define some HUD gauges in a resolution tag and others in another and both will be loaded, provided the tags match up to the current resolution.
*In other words, a list starting with $Resolution: (1024 768) will only be used in 1024 768. However, a list starting with $Default: (640 480) will be scaled to any resolution, regardless of what the current resolution is.
*To have gauges be an absolute distance from the upper-left corner of the screen, regardless of resolution, use $Default: (0 0).
*Finally, gauges are loaded from first to last in the listing of resolution-specific and default gauge lists, so if any valid gauge settings are defined more than once, the last setting will be used. This means that $Default lists '''should always come first''', so that resolution-specific settings will override them, rather than the other way around.
'''IMPORTANT: Only $Default or $Resolution may be defined, NOT both.'''

===$Default:===
*Defines what resolution cooridinates are given in and scale them to the current resolution appropriately. If (0 0) is given, coordinates are assumed to be absolute numbers of pixels from the upper-left corner of the screen no matter what resolution is used in fs2_open.
*Syntax: (<integer> <integer>)
**Tip: Set to (100 100) to set coordinates using percentages.

===$Resolution:===
*Tells fs2_open that coordinates are for the specified resolution and that resolution only. These will not be used or scaled if the resolution fs2_open is started in is different.
*Syntax: (<integer> <integer>)

====$<Gauge name>:====
*Where <Gauge name> is the name of the gauge you want to move, moves the upper-left corner of the gauge to the specified position.
*Syntax: (<floating-point> <floating-point>)
*'''List of known supported retail gauges''': Player Shield, Target Shield, Shield Mini, Afterburner Energy, Weapons Energy, Escort List

*'''+Size:'''
**Defines the size of the gauge; usually not needed, unless the gauge should be centered (see +Percentage below).
**Syntax: (<integer> <integer>)

*'''+Percentage:'''
**Moves the '''center''' of the gauge by the given percent. Added onto the original coordinates given for the gauge.
**Syntax: (<floating-point> <floating-point>)

*'''+Image:'''
**What image or animation the gauge should use. If set for a custom gauge, this image will always be displayed at the gauge's coordinates unless a SEXP is called.
**Syntax: <animation filename of up to 32 characters>

*'''+Text:'''
**What text the gauge should use. If set for a custom gauge, the text will always be shown unless a SEXP is used.
**Syntax: <Text of up to 32 characters, although the limit varies for retail gauges>

*'''+Color:'''
**What color the gauge's image or text should be.
**Syntax: <red value from 0-255> <green value from 0-255> <blue value from 0-255>

==<nowiki>#</nowiki>Ship Main Gauges==
Basically the same as the <nowiki>#</nowiki>Main Gauges Section, the Ship Main Gauges adds a new variable - $Ship. This defines which ship the specified changes will apply to. So, if you set $Ship as "GTF Ulysses", whenever the player flies the Ulysses, s/he will see the HUD changes.
'''IMPORTANT: Only $Default or $Resolution may be defined, NOT both.'''

===$Ship:===
*Defines what ship class HUD attributes will apply to.
*Syntax: <string of up to 32 characters

===$Default:===
*Defines what resolution cooridinates are given in and scale them to the current resolution appropriately. If (0 0) is given, coordinates are assumed to be absolute numbers of pixels from the upper-left corner of the screen no matter what resolution is used in fs2_open.
*Syntax: (<integer> <integer>)
**Tip: Set to (100 100) to set coordinates using percentages.

===$Resolution:===
*Tells fs2_open that coordinates are for the specified resolution and that resolution only. These will not be used or scaled if the resolution fs2_open is started in is different.
*Syntax: (<integer> <integer>)

====$<Gauge name>:====
*Where <Gauge name> is the name of the gauge you want to move, moves the upper-left corner of the gauge to the specified position.
*Syntax: (<floating-point> <floating-point>)

*'''+Size:'''
**Defines the size of the gauge; usually not needed, unless the gauge should be centered (see +Percentage below).
**Syntax: (<integer> <integer>)

*'''+Percentage:'''
**Moves the '''center''' of the gauge by the given percent. Added onto the original coordinates given for the gauge.
**Syntax: (<floating-point> <floating-point>)

*'''+Image:'''
**What image or animation the gauge should use. If set for a custom gauge, this image will always be displayed at the gauge's coordinates unless a SEXP is called.
**Syntax: <animation filename of up to 32 characters>

*'''+Text:'''
**What text the gauge should use. If set for a custom gauge, the text will always be shown unless a SEXP is used.
**Syntax: <Text of up to 32 characters, although the limit varies for retail gauges>

*'''+Color:'''
**What color the gauge's image or text should be.
**Syntax: <red value from 0-255> <green value from 0-255> <blue value from 0-255>

==Minimal Example==
$Max Escort Ships: 15

==Example==
*not entirely sure if this works, copy-paste from somewhere else... someone please update

$Max Escort Ships: 15

#Main Gauges
$Resolution: (1024 768)
$Escort List: (865 330) ;Where the escort list goes.
+Image: escort1
+Text: Monitoring ;This is incorrect, but how it is in the current build...will be fixed
#End

#Gauges
$Resolution: (1024 768)
$Escort List
$Header Text: (4 1)
;+Text: Monitoring ;This is correct, and how it will be after this build
$List: (0 13) ;Where the list starts
$Ship: (0 11) ;An individual entry
+Image: escort2
$Last Ship: (0 11) ;Last entry
+Image: escort3
$Ship Name: (4 0) ;Where the name goes relative to the entry position
$Ship Hull: (116 0) ;Ditto for hull %
$Ship Status: (-11 0) ;Ditto for ship status, aka the D that shows up when a ship is disabled.

[[Category:Tables]]

Hud gauges.tbl

2006-05-09T23:47:40Z

Backslash:

hud_gauges.tbl (Originally direct paste from FSDoc 2004.12.19, continuing to clean up. Please, somebody who knows more about this table, or just Wiki standards, fix my mistakes!)

IMPORTANT: The information in this section is how hud_gauges.tbl '''should''' work. Some things may not work as this guide says they should; in that case, e-mail me (WMCoolmon) or send me a PM via the Forums.

hud_gauges.tbl is used for modifying the elements of the HUD. It is as of now currently unfinished. However, it can still be used to add custom gauges equivelant to something like the wingman status display.

==Gauge system overview==

*Many of the gauges in Freespace 2 are made up of individual images and text. To allow easy editing, these have been broken up into main gauges and child gauges. '''Main gauges''' (aka parent gauges) are a standalone part of the HUD, and may be one gauge or a collection of gauges. '''Child gauges''' are gauges that are dependant upon another gauge's position.
*For example, in the center of the screen of Freespace 2, there is a gauge that tells you your target's hud strength and shield status. The text is a child gauge, and the shield quadrant is a child gauge. Both of these together make up the main gauge. So, to move both to the corner, you would simply change the position of the main gauge.
*Finally, '''all coordinates are measured in pixels from the upper-left corner of the screen.''' (100 50) is 100 pixels to the right and 50 pixels down; this may seem unnatural at first, but is easy to get used to.

==Sections overview==

*hud_gauges.tbl contains six sections, the most of any table in Freespace. They are:
**Miscellaneous variables
***All miscellaneous variables go at the top of the hud_gauges.tbl file. Currently, the only variable here is the number of escort ships.
**<nowiki>#</nowiki>Custom Gauges
***This is where all custom gauges (and their default attributes) are defined.
**<nowiki>#</nowiki>Main Gauges
***Used to set the attributes of the main HUD gauges, such as the escort list or the shield status display.
**<nowiki>#</nowiki>Gauges
***Used to set individual child gauges' attributes.
**<nowiki>#</nowiki>Ship Main Gauges
***Same as the <nowiki>#</nowiki>Main Gauges section, except it's used for overrides to the gauges for specific ships.
**<nowiki>#</nowiki>Ship Gauges
***Again, this is the same as the <nowiki>#</nowiki>Gauges section, except for individual ship overrides.

==Miscellaneous variables==
*All miscellaneous variables are defined at the top of hud_gauges.tbl. The complete list is as follows:

===$Max Escort Ships: <integer up to 20>===
*Sets the number of escort ships shown in the list. Entries more than 16 will cause the list to overflow into the weapons list under a resolution of 1024x768.

==<nowiki>#</nowiki>Custom Gauges==
*Custom Gauges are easy to use, and incredibly powerful with the hud-set SEXPs. Initially, they are completely blank; in order to see them you must set their text or image variable in one of the Gauges sections. In order to define a new custom gauge, only the name field is needed:

===$Name:===
*What the name of the custom gauge will be
*Syntax: <string of up to 32 characters>

*'''+Default640x:'''
**The Default X coordinate of the gauge in 640x480
**Syntax: <integer>

*'''+Default640y:'''
**The Default Y coordinate in 640x480
**Syntax: <integer>

*'''+Default1024x:'''
**The Default X coordinate in 1024x768
**Syntax: <integer>

*'''+Default1024y:'''
**The Default Y coordinate in 1024x768
**Syntax: <integer>

*'''+Parent:'''
**The parent gauge of the new custom gauge.
**Syntax: <string of up to 32 characters>

==<nowiki>#</nowiki>Main Gauges==
*Each list of main gauge definitions can start with one of two strings - $Resolution and $Default. A list started with $Resolution will only be used if the resolution FreeSpace 2 is started in is exactly the same as $Resolution. $Default lists will be loaded regardless of the resolution. Finally, all tags are '''additive''', so you can define some HUD gauges in a resolution tag and others in another and both will be loaded, provided the tags match up to the current resolution.
*In other words, a list starting with $Resolution: (1024 768) will only be used in 1024 768. However, a list starting with $Default: (640 480) will be scaled to any resolution, regardless of what the current resolution is.
*To have gauges be an absolute distance from the upper-left corner of the screen, regardless of resolution, use $Default: (0 0).
*Finally, gauges are loaded from first to last in the listing of resolution-specific and default gauge lists, so if any valid gauge settings are defined more than once, the last setting will be used. This means that $Default lists '''should always come first''', so that resolution-specific settings will override them, rather than the other way around.
'''IMPORTANT: Only $Default or $Resolution may be defined, NOT both.'''

===$Default:===
*Defines what resolution cooridinates are given in and scale them to the current resolution appropriately. If (0 0) is given, coordinates are assumed to be absolute numbers of pixels from the upper-left corner of the screen no matter what resolution is used in fs2_open.
*Syntax: (<integer> <integer>)
**Tip: Set to (100 100) to set coordinates using percentages.

===$Resolution:===
*Tells fs2_open that coordinates are for the specified resolution and that resolution only. These will not be used or scaled if the resolution fs2_open is started in is different.
*Syntax: (<integer> <integer>)

====$<Gauge name>:====
*Where <Gauge name> is the name of the gauge you want to move, moves the upper-left corner of the gauge to the specified position.
*Syntax: (<floating-point> <floating-point>)

*'''+Size:'''
**Defines the size of the gauge; usually not needed, unless the gauge should be centered (see +Percentage below).
**Syntax: (<integer> <integer>)

*'''+Percentage:'''
**Moves the '''center''' of the gauge by the given percent. Added onto the original coordinates given for the gauge.
**Syntax: (<floating-point> <floating-point>)

*'''+Image:'''
**What image or animation the gauge should use. If set for a custom gauge, this image will always be displayed at the gauge's coordinates unless a SEXP is called.
**Syntax: <animation filename of up to 32 characters>

*'''+Text:'''
**What text the gauge should use. If set for a custom gauge, the text will always be shown unless a SEXP is used.
**Syntax: <Text of up to 32 characters, although the limit varies for retail gauges>

*'''+Color:'''
**What color the gauge's image or text should be.
**Syntax: <red value from 0-255> <green value from 0-255> <blue value from 0-255>

==<nowiki>#</nowiki>Ship Main Gauges==
Basically the same as the <nowiki>#</nowiki>Main Gauges Section, the Ship Main Gauges adds a new variable - $Ship. This defines which ship the specified changes will apply to. So, if you set $Ship as "GTF Ulysses", whenever the player flies the Ulysses, s/he will see the HUD changes.
'''IMPORTANT: Only $Default or $Resolution may be defined, NOT both.'''

===$Ship:===
*Defines what ship class HUD attributes will apply to.
*Syntax: <string of up to 32 characters

===$Default:===
*Defines what resolution cooridinates are given in and scale them to the current resolution appropriately. If (0 0) is given, coordinates are assumed to be absolute numbers of pixels from the upper-left corner of the screen no matter what resolution is used in fs2_open.
*Syntax: (<integer> <integer>)
**Tip: Set to (100 100) to set coordinates using percentages.

===$Resolution:===
*Tells fs2_open that coordinates are for the specified resolution and that resolution only. These will not be used or scaled if the resolution fs2_open is started in is different.
*Syntax: (<integer> <integer>)

====$<Gauge name>:====
*Where <Gauge name> is the name of the gauge you want to move, moves the upper-left corner of the gauge to the specified position.
*Syntax: (<floating-point> <floating-point>)

*'''+Size:'''
**Defines the size of the gauge; usually not needed, unless the gauge should be centered (see +Percentage below).
**Syntax: (<integer> <integer>)

*'''+Percentage:'''
**Moves the '''center''' of the gauge by the given percent. Added onto the original coordinates given for the gauge.
**Syntax: (<floating-point> <floating-point>)

*'''+Image:'''
**What image or animation the gauge should use. If set for a custom gauge, this image will always be displayed at the gauge's coordinates unless a SEXP is called.
**Syntax: <animation filename of up to 32 characters>

*'''+Text:'''
**What text the gauge should use. If set for a custom gauge, the text will always be shown unless a SEXP is used.
**Syntax: <Text of up to 32 characters, although the limit varies for retail gauges>

*'''+Color:'''
**What color the gauge's image or text should be.
**Syntax: <red value from 0-255> <green value from 0-255> <blue value from 0-255>

==Minimal Example==
$Max Escort Ships: 15

==Example==
*not entirely sure if this works, copy-paste from somewhere else... someone please update

$Max Escort Ships: 15

#Main Gauges
$Resolution: (1024 768)
$Escort List: (865 330) ;Where the escort list goes.
+Image: escort1
+Text: Monitoring ;This is incorrect, but how it is in the current build...will be fixed
#End

#Gauges
$Resolution: (1024 768)
$Escort List
$Header Text: (4 1)
;+Text: Monitoring ;This is correct, and how it will be after this build
$List: (0 13) ;Where the list starts
$Ship: (0 11) ;An individual entry
+Image: escort2
$Last Ship: (0 11) ;Last entry
+Image: escort3
$Ship Name: (4 0) ;Where the name goes relative to the entry position
$Ship Hull: (116 0) ;Ditto for hull %
$Ship Status: (-11 0) ;Ditto for ship status, aka the D that shows up when a ship is disabled.

[[Category:Tables]]

Hud gauges.tbl

2006-05-04T03:44:23Z

Backslash:

hud_gauges.tbl (Originally direct paste from FSDoc 2004.12.19, continuing to clean up. Please, somebody who knows more about this table, or just Wiki standards, fix my mistakes!)

IMPORTANT: The information in this section is how hud_gauges.tbl '''should''' work. Some things may not work as this guide says they should; in that case, e-mail me (WMCoolmon) or send me a PM via the Forums.

hud_gauges.tbl is used for modifying the elements of the HUD. It is as of now currently unfinished. However, it can still be used to add custom gauges equivelant to something like the wingman status display.

==Gauge system overview==

*Many of the gauges in Freespace 2 are made up of individual images and text. To allow easy editing, these have been broken up into main gauges and child gauges. '''Main gauges''' (aka parent gauges) are a standalone part of the HUD, and may be one gauge or a collection of gauges. '''Child gauges''' are gauges that are dependant upon another gauge's position.
*For example, in the center of the screen of Freespace 2, there is a gauge that tells you your target's hud strength and shield status. The text is a child gauge, and the shield quadrant is a child gauge. Both of these together make up the main gauge. So, to move both to the corner, you would simply change the position of the main gauge.
*Finally, '''all coordinates are measured in pixels from the upper-left corner of the screen.''' (100 50) is 100 pixels to the right and 50 pixels down; this may seem unnatural at first, but is easy to get used to.

==Sections overview==

*hud_gauges.tbl contains six sections, the most of any table in Freespace. They are:
**Miscellaneous variables
***All miscellaneous variables go at the top of the hud_gauges.tbl file. Currently, the only variable here is the number of escort ships.
**<nowiki>#</nowiki>Custom Gauges
***This is where all custom gauges (and their default attributes) are defined.
**<nowiki>#</nowiki>Main Gauges
***Used to set the attributes of the main HUD gauges, such as the escort list or the shield status display.
**<nowiki>#</nowiki>Gauges
***Used to set individual child gauges' attributes.
**<nowiki>#</nowiki>Ship Main Gauges
***Same as the <nowiki>#</nowiki>Main Gauges section, except it's used for overrides to the gauges for specific ships.
**<nowiki>#</nowiki>Ship Gauges
***Again, this is the same as the <nowiki>#</nowiki>Gauges section, except for individual ship overrides.

==Miscellaneous variables==
*All miscellaneous variables are defined at the top of hud_gauges.tbl. The complete list is as follows:

===$Max Escort Ships: <integer up to 20>===
*Sets the number of escort ships shown in the list. Entries more than 16 will cause the list to overflow into the weapons list under a resolution of 1024x768.

==<nowiki>#</nowiki>Custom Gauges==
*Custom Gauges are easy to use, and incredibly powerful with the hud-set SEXPs. Initially, they are completely blank; in order to see them you must set their text or image variable in one of the Gauges sections. In order to define a new custom gauge, only the name field is needed:

===$Name:===
*What the name of the custom gauge will be
*Syntax: <string of up to 32 characters>

*'''+Default640x:'''
**The Default X coordinate of the gauge in 640x480
**Syntax: <integer>

*'''+Default640y:'''
**The Default Y coordinate in 640x480
**Syntax: <integer>

*'''+Default1024x:'''
**The Default X coordinate in 1024x768
**Syntax: <integer>

*'''+Default1024y:'''
**The Default Y coordinate in 1024x768
**Syntax: <integer>

*'''+Parent:'''
**The parent gauge of the new custom gauge.
**Syntax: <string of up to 32 characters>

==<nowiki>#</nowiki>Main Gauges==
*Each list of main gauge definitions can start with one of two strings - $Resolution and $Default. A list started with $Resolution will only be used if the resolution FreeSpace 2 is started in is exactly the same as $Resolution. $Default lists will be loaded regardless of the resolution. Finally, all tags are '''additive''', so you can define some HUD gauges in a resolution tag and others in another and both will be loaded, provided the tags match up to the current resolution.
*In other words, a list starting with $Resolution: (1024 768) will only be used in 1024 768. However, a list starting with $Default: (640 480) will be scaled to any resolution, regardless of what the current resolution is.
*To have gauges be an absolute distance from the upper-left corner of the screen, regardless of resolution, use $Default: (0 0).
*Finally, gauges are loaded from first to last in the listing of resolution-specific and default gauge lists, so if any valid gauge settings are defined more than once, the last setting will be used. This means that $Default lists '''should always come first''', so that resolution-specific settings will override them, rather than the other way around.
'''IMPORTANT: Only $Default or $Resolution may be defined, NOT both.'''

===$Default:===
*Defines what resolution cooridinates are given in and scale them to the current resolution appropriately. If (0 0) is given, coordinates are assumed to be absolute numbers of pixels from the upper-left corner of the screen no matter what resolution is used in fs2_open.
*Syntax: (<integer> <integer>)
**Tip: Set to (100 100) to set coordinates using percentages.

===$Resolution:===
*Tells fs2_open that coordinates are for the specified resolution and that resolution only. These will not be used or scaled if the resolution fs2_open is started in is different.
*Syntax: (<integer> <integer>)

====$<Gauge name>:====
*Where <Gauge name> is the name of the gauge you want to move, moves the upper-left corner of the gauge to the specified position.
*Syntax: (<floating-point> <floating-point>)

*'''+Size:'''
**Defines the size of the gauge; usually not needed, unless the gauge should be centered (see +Percentage below).
**Syntax: (<integer> <integer>)

*'''+Percentage:'''
**Moves the '''center''' of the gauge by the given percent. Added onto the original coordinates given for the gauge.
**Syntax: (<floating-point> <floating-point>)

*'''+Image:'''
**What image or animation the gauge should use. If set for a custom gauge, this image will always be displayed at the gauge's coordinates unless a SEXP is called.
**Syntax: <animation filename of up to 32 characters>

*'''+Text:'''
**What text the gauge should use. If set for a custom gauge, the text will always be shown unless a SEXP is used.
**Syntax: <Text of up to 32 characters, although the limit varies for retail gauges>

*'''+Color:'''
**What color the gauge's image or text should be.
**Syntax: <red value from 0-255> <green value from 0-255> <blue value from 0-255>

==<nowiki>#</nowiki>Ship Main Gauges==
Basically the same as the <nowiki>#</nowiki>Main Gauges Section, the Ship Main Gauges adds a new variable - $Ship. This defines which ship the specified changes will apply to. So, if you set $Ship as "GTF Ulysses", whenever the player flies the Ulysses, s/he will see the HUD changes.
'''IMPORTANT: Only $Default or $Resolution may be defined, NOT both.'''

===$Ship:===
*Defines what ship class HUD attributes will apply to.
*Syntax: <string of up to 32 characters

===$Default:===
*Defines what resolution cooridinates are given in and scale them to the current resolution appropriately. If (0 0) is given, coordinates are assumed to be absolute numbers of pixels from the upper-left corner of the screen no matter what resolution is used in fs2_open.
*Syntax: (<integer> <integer>)
**Tip: Set to (100 100) to set coordinates using percentages.

===$Resolution:===
*Tells fs2_open that coordinates are for the specified resolution and that resolution only. These will not be used or scaled if the resolution fs2_open is started in is different.
*Syntax: (<integer> <integer>)

====$<Gauge name>:====
*Where <Gauge name> is the name of the gauge you want to move, moves the upper-left corner of the gauge to the specified position.
*Syntax: (<floating-point> <floating-point>)

*'''+Size:'''
**Defines the size of the gauge; usually not needed, unless the gauge should be centered (see +Percentage below).
**Syntax: (<integer> <integer>)

*'''+Percentage:'''
**Moves the '''center''' of the gauge by the given percent. Added onto the original coordinates given for the gauge.
**Syntax: (<floating-point> <floating-point>)

*'''+Image:'''
**What image or animation the gauge should use. If set for a custom gauge, this image will always be displayed at the gauge's coordinates unless a SEXP is called.
**Syntax: <animation filename of up to 32 characters>

*'''+Text:'''
**What text the gauge should use. If set for a custom gauge, the text will always be shown unless a SEXP is used.
**Syntax: <Text of up to 32 characters, although the limit varies for retail gauges>

*'''+Color:'''
**What color the gauge's image or text should be.
**Syntax: <red value from 0-255> <green value from 0-255> <blue value from 0-255>

==Sample==
$Max Escort Ships: 15

[[Category:Tables]]

Hud gauges.tbl

2006-05-04T03:35:44Z

Backslash: hud_gauges.tbl

hud_gauges.tbl (Originally direct paste from FSDoc 2004.12.19, continuing to clean up. Please, somebody who knows more about this table, or just Wiki standards, fix my mistakes!)

IMPORTANT: The information in this section is how hud_gauges.tbl '''should''' work. Some things may not work as this guide says they should; in that case, e-mail me (WMCoolmon) or send me a PM via the Forums.

hud_gauges.tbl is used for modifying the elements of the HUD. It is as of now currently unfinished. However, it can still be used to add custom gauges equivelant to something like the wingman status display.

==Gauge system overview==

*Many of the gauges in Freespace 2 are made up of individual images and text. To allow easy editing, these have been broken up into main gauges and child gauges. '''Main gauges''' (aka parent gauges) are a standalone part of the HUD, and may be one gauge or a collection of gauges. '''Child gauges''' are gauges that are dependant upon another gauge's position.
*For example, in the center of the screen of Freespace 2, there is a gauge that tells you your target's hud strength and shield status. The text is a child gauge, and the shield quadrant is a child gauge. Both of these together make up the main gauge. So, to move both to the corner, you would simply change the position of the main gauge.
*Finally, '''all coordinates are measured in pixels from the upper-left corner of the screen.''' (100 50) is 100 pixels to the right and 50 pixels down; this may seem unnatural at first, but is easy to get used to.

==Sections overview==

*hud_gauges.tbl contains six sections, the most of any table in Freespace. They are:
**Miscellaneous variables
***All miscellaneous variables go at the top of the hud_gauges.tbl file. Currently, the only variable here is the number of escort ships.
**<nowiki>#</nowiki>Custom Gauges
***This is where all custom gauges (and their default attributes) are defined.
**<nowiki>#</nowiki>Main Gauges
***Used to set the attributes of the main HUD gauges, such as the escort list or the shield status display.
**<nowiki>#</nowiki>Gauges
***Used to set individual child gauges' attributes
**<nowiki>#</nowiki>Ship Main Gauges
***Same as the <nowiki>#</nowiki>Main Gauges section, except it's used for overrides to the gauges for specific ships
**<nowiki>#</nowiki>Ship Gauges
***Again, this is the same as the <nowiki>#</nowiki>Gauges section, except for individual ship overrides

==Miscellaneous variables==
*All miscellaneous variables are defined at the top of hud_gauges.tbl. The complete list is as follows:

===$Max Escort Ships: <integer up to 20>===
*Sets the number of escort ships shown in the list. Entries more than 16 will cause the list to overflow into the weapons list under a resolution of 1024x768.

==<nowiki>#</nowiki>Custom Gauges==
*Custom Gauges are easy to use, and incredibly powerful with the hud-set SEXPs. Initially, they are completely blank; in order to see them you must set their text or image variable in one of the Gauges sections. In order to define a new custom gauge, only the name field is needed:

===$Name:===
*What the name of the custom gauge will be
*Syntax: <string of up to 32 characters>

*'''+Default640x:'''
**The Default X coordinate of the gauge in 640x480
**Syntax: <integer>

*'''+Default640y:'''
**The Default Y coordinate in 640x480
**Syntax: <integer>

*'''+Default1024x:'''
**The Default X coordinate in 1024x768
**Syntax: <integer>

*'''+Default1024y:'''
**The Default Y coordinate in 1024x768
**Syntax: <integer>

*'''+Parent:'''
**The parent gauge of the new custom gauge.
**Syntax: <string of up to 32 characters>

==<nowiki>#</nowiki>Main Gauges==
*Each list of main gauge definitions can start with one of two strings - $Resolution and $Default. A list started with $Resolution will only be used if the resolution FreeSpace 2 is started in is exactly the same as $Resolution. $Default lists will be loaded regardless of the resolution. Finally, all tags are '''additive''', so you can define some HUD gauges in a resolution tag and others in another and both will be loaded, provided the tags match up to the current resolution.
*In other words, a list starting with $Resolution: (1024 768) will only be used in 1024 768. However, a list starting with $Default: (640 480) will be scaled to any resolution, regardless of what the current resolution is.
*To have gauges be an absolute distance from the upper-left corner of the screen, regardless of resolution, use $Default: (0 0).
*Finally, gauges are loaded from first to last in the listing of resolution-specific and default gauge lists, so if any valid gauge settings are defined more than once, the last setting will be used. This means that $Default lists '''should always come first''', so that resolution-specific settings will override them, rather than the other way around.
'''IMPORTANT: Only $Default or $Resolution may be defined, NOT both.'''

===$Default:===
*Defines what resolution cooridinates are given in and scale them to the current resolution appropriately. If (0 0) is given, coordinates are assumed to be absolute numbers of pixels from the upper-left corner of the screen no matter what resolution is used in fs2_open.
*Syntax: (<integer> <integer>)
**Tip: Set to (100 100) to set coordinates using percentages.

===$Resolution:===
*Tells fs2_open that coordinates are for the specified resolution and that resolution only. These will not be used or scaled if the resolution fs2_open is started in is different.
*Syntax: (<integer> <integer>)

====$<Gauge name>:====
*Where <Gauge name> is the name of the gauge you want to move, moves the upper-left corner of the gauge to the specified position.
*Syntax: (<floating-point> <floating-point>)

*'''+Size:'''
**Defines the size of the gauge; usually not needed, unless the gauge should be centered (see +Percentage below).
**Syntax: (<integer> <integer>)

*'''+Percentage:'''
**Moves the '''center''' of the gauge by the given percent. Added onto the original coordinates given for the gauge.
**Syntax: (<floating-point> <floating-point>)

*'''+Image:'''
**What image or animation the gauge should use. If set for a custom gauge, this image will always be displayed at the gauge's coordinates unless a SEXP is called.
**Syntax: <animation filename of up to 32 characters>

*'''+Text:'''
**What text the gauge should use. If set for a custom gauge, the text will always be shown unless a SEXP is used.
**Syntax: <Text of up to 32 characters, although the limit varies for retail gauges>

*'''+Color:'''
**What color the gauge's image or text should be.
**Syntax: <red value from 0-255> <green value from 0-255> <blue value from 0-255>

==<nowiki>#</nowiki>Ship Main Gauges==
Basically the same as the <nowiki>#</nowiki>Main Gauges Section, the Ship Main Gauges adds a new variable - $Ship. This defines which ship the specified changes will apply to. So, if you set $Ship as "GTF Ulysses", whenever the player flies the Ulysses, s/he will see the HUD changes.
'''IMPORTANT: Only $Default or $Resolution may be defined, NOT both.'''

===$Ship:===
*Defines what ship class HUD attributes will apply to.
*Syntax: <string of up to 32 characters

===$Default:===
*Defines what resolution cooridinates are given in and scale them to the current resolution appropriately. If (0 0) is given, coordinates are assumed to be absolute numbers of pixels from the upper-left corner of the screen no matter what resolution is used in fs2_open.
*Syntax: (<integer> <integer>)
**Tip: Set to (100 100) to set coordinates using percentages.

===$Resolution:===
*Tells fs2_open that coordinates are for the specified resolution and that resolution only. These will not be used or scaled if the resolution fs2_open is started in is different.
*Syntax: (<integer> <integer>)

====$<Gauge name>:====
*Where <Gauge name> is the name of the gauge you want to move, moves the upper-left corner of the gauge to the specified position.
*Syntax: (<floating-point> <floating-point>)

*'''+Size:'''
**Defines the size of the gauge; usually not needed, unless the gauge should be centered (see +Percentage below).
**Syntax: (<integer> <integer>)

*'''+Percentage:'''
**Moves the '''center''' of the gauge by the given percent. Added onto the original coordinates given for the gauge.
**Syntax: (<floating-point> <floating-point>)

*'''+Image:'''
**What image or animation the gauge should use. If set for a custom gauge, this image will always be displayed at the gauge's coordinates unless a SEXP is called.
**Syntax: <animation filename of up to 32 characters>

*'''+Text:'''
**What text the gauge should use. If set for a custom gauge, the text will always be shown unless a SEXP is used.
**Syntax: <Text of up to 32 characters, although the limit varies for retail gauges>

*'''+Color:'''
**What color the gauge's image or text should be.
**Syntax: <red value from 0-255> <green value from 0-255> <blue value from 0-255>

User:Backslash

2006-04-15T07:16:48Z

Backslash: