Difference between revisions of "Iff defs.tbl"
From FreeSpace Wiki
Wildrosewolf (talk | contribs) (→Sample Entry) |
(→$Flags:) |
||
(11 intermediate revisions by 7 users not shown) | |||
Line 1: | Line 1: | ||
− | + | {{SCP_table}} | |
− | + | {{TableVersion|5307}} | |
− | The | + | The '''iff_defs.tbl''' (Identification Friend or Foe) table stores data on FS2's IFF (Identification Friend or Foe) 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. |
+ | |||
+ | |||
+ | [[Tables|List of Tables]] | ||
==General Format== | ==General Format== | ||
− | *IFF_defs table consist of the | + | *IFF_defs table consist of the generic definitions followed by actual iff definitions |
*Table begins with #'''IFFs''' | *Table begins with #'''IFFs''' | ||
− | * | + | *The traitor must be defined with '''$Traitor IFF:''' |
**This entry is used to define which IFF is used to represent the traitors IFF | **This entry is used to define which IFF is used to represent the traitors IFF | ||
− | |||
*Different IFFs entries begin with '''[[iff_defs.tbl#$IFF Name:|$IFF Name:]] | *Different IFFs entries begin with '''[[iff_defs.tbl#$IFF Name:|$IFF Name:]] | ||
*Table ends with #'''End''' | *Table ends with #'''End''' | ||
+ | |||
+ | |||
+ | ===$Traitor IFF:=== | ||
+ | *This entry is used to define which IFF is used to represent the traitors IFF | ||
+ | *Syntax: '''''String''''', IFF entry | ||
+ | |||
+ | |||
+ | ===$Selection Color: or $Selection Colour:=== | ||
+ | {{Table3611| | ||
+ | *Defines the color of the targeting brackets of selected targets (like asteroids and multi targeting targets and such) | ||
+ | *Syntax: '''Integer list''', values from 0 to 255, red, green and blue respectively}} | ||
+ | :*Default: ( 255, 255, 255 ) | ||
+ | |||
+ | |||
+ | ===$Message Color: or $Message Colour:=== | ||
+ | {{Table3611| | ||
+ | *Defines the color of the targeting brackets of the ship currently sending a message | ||
+ | *Syntax: '''Integer list''', values from 0 to 255, red, green and blue respectively}} | ||
+ | :*Default: ( 127, 127, 127 ) | ||
+ | |||
+ | |||
+ | ===$Tagged Color: or $Tagged Colour:=== | ||
+ | {{Table3611| | ||
+ | *Defines the color of the tagged targets | ||
+ | *Syntax: '''Integer list''', values from 0 to 255, red, green and blue respectively}} | ||
+ | :*Default: ( 255, 255, 0 ) | ||
+ | |||
+ | |||
+ | ===$Dimmed IFF brightness:=== | ||
+ | {{Table3611| | ||
+ | *Defines how much dimmer (transparent) are the dimmed objects of the HUD (most displays, distant targets on radar etc.) | ||
+ | *Syntax: '''Integer''', values from 0 to 15}} | ||
+ | :*Default: 4 | ||
+ | |||
+ | |||
+ | ===$Use Alternate Blip Coloring:=== | ||
+ | {{Table3611| | ||
+ | *If set forces all blips to use uniform transparency based 'dimming' method instead of using 1/2 brightness (non-transparent) on the non-ship blips | ||
+ | *Syntax: '''Boolean'''}} | ||
+ | :*Default: NO | ||
+ | |||
+ | |||
+ | ===$Missile Blip Color: or $Missile Blip Colour:=== | ||
+ | {{Table3611| | ||
+ | *Defines the color of the weapons (bombs) on radar screen. Dimmed color is 1/2 unless alternate blip coloring is in use. | ||
+ | *Syntax: '''Integer list''', values from 0 to 255, red, green and blue respectively}} | ||
+ | :*Default: ( 127, 127, 0 ) | ||
+ | |||
+ | |||
+ | ===$Navbuoy Blip Color: or $Navbuoy Blip Colour:=== | ||
+ | {{Table3611| | ||
+ | *Defines the color of the navbuoys on radar screen. Dimmed color is 1/2 unless alternate blip coloring is in use. | ||
+ | *Syntax: '''Integer list''', values from 0 to 255, red, green and blue respectively}} | ||
+ | :*Default: ( 127, 127, 127 ) | ||
+ | |||
+ | |||
+ | ===$Warping Blip Color: or $Warping Blip Colour:=== | ||
+ | {{Table3611| | ||
+ | *Defines the color of the warping ships on radar screen. Dimmed color is 1/2 unless alternate blip coloring is in use. | ||
+ | *Syntax: '''Integer list''', values from 0 to 255, red, green and blue respectively}} | ||
+ | :*Default: ( 0, 0, 255 ) | ||
+ | |||
+ | |||
+ | ===$Node Blip Color: or $Node Blip Colour:=== | ||
+ | {{Table3611| | ||
+ | *Defines the color of the jump nodes on radar screen. Dimmed color is 1/2 unless alternate blip coloring is in use. | ||
+ | *Syntax: '''Integer list''', values from 0 to 255, red, green and blue respectively}} | ||
+ | :*Default: ( 127, 127, 127 ) | ||
+ | |||
+ | |||
+ | ===$Tagged Blip Color: or $Tagged Blip Colour:=== | ||
+ | {{Table3611| | ||
+ | *Defines the color of the tagged targets on radar screen. Dimmed color is 1/2 unless alternate blip coloring is in use. | ||
+ | *Syntax: '''Integer list''', values from 0 to 255, red, green and blue respectively}} | ||
+ | :*Default: ( 255, 255, 0 ) | ||
+ | |||
+ | ===$Radar Target ID Flags:=== | ||
+ | {{Table3611| | ||
+ | *Defines the appearance of the currently targeted blip on radar screen. | ||
+ | *Syntax: ( '''"String"''' ), name of the flag | ||
+ | **List of flags: | ||
+ | ***''"crosshairs"'' | ||
+ | ***''"blink"'' | ||
+ | ***''"pulsate"'' | ||
+ | ***''"enlarge"''}} | ||
+ | |||
==$IFF Name:== | ==$IFF Name:== | ||
+ | |||
===$Colour: or $Color:=== | ===$Colour: or $Color:=== | ||
+ | {{Table3610| | ||
*Defines the color of the IFF as seen in by default (e.g. in briefing icons). | *Defines the color of the IFF as seen in by default (e.g. in briefing icons). | ||
− | *Syntax: ( '' | + | *Syntax: ( '''Color''' ), three '''integers''', values from 0 to 255; red, green and blue respectively |
− | **Example: ( 0, 255, 0 ) | + | **Example: ( 0, 255, 0 )}} |
+ | |||
===$Attacks:=== | ===$Attacks:=== | ||
+ | {{Table3610| | ||
*Defines the IFFs that are attacked by default | *Defines the IFFs that are attacked by default | ||
− | *Syntax: ( '' | + | *Syntax: ( '''String''' ), name of the IFF |
− | **Example: ( "Friendly" "Neutral" "Traitor" ) | + | **Example: ( "Friendly" "Neutral" "Traitor" )}} |
+ | |||
===+Sees ''IFF Name'' As:=== | ===+Sees ''IFF Name'' As:=== | ||
+ | {{Table3610| | ||
*IFF can be set to be seen as in different color than what that IFFS default color is. | *IFF can be set to be seen as in different color than what that IFFS default color is. | ||
− | *Same IFF may have multiple | + | *Same IFF may have multiple ''+Sees '''IFF Name''' As:'' entries |
*'''''IFF Name''''' defines the name of the IFF to have a different color. | *'''''IFF Name''''' defines the name of the IFF to have a different color. | ||
− | **Example: +Sees ''Hostile'' As: | + | **Example: +Sees '''Hostile''' As: |
− | *Syntax: ( '' | + | *Syntax: ( '''Color''' ), three '''integers''', values from 0 to 255; red, green and blue respectively |
− | **Example: ( 255, 0, 0 ) | + | **Example: ( 255, 0, 0 )}} |
+ | |||
===$Flags:=== | ===$Flags:=== | ||
+ | {{Table3610| | ||
*IFFs can have special flags assigned to them. | *IFFs can have special flags assigned to them. | ||
− | *Syntax: ( ''" | + | *Syntax: ( '''"String"''' ), name of the flag |
**Example: ( "support allowed" ) | **Example: ( "support allowed" ) | ||
− | **List of | + | **List of flags: |
***''"support allowed"'' | ***''"support allowed"'' | ||
+ | ****When a ship with this IFF is disabled and in a wing, it can call for support (normal behaviour for a disabled ship in a wing is to self-destruct) | ||
***''"exempt from all teams at war"'' | ***''"exempt from all teams at war"'' | ||
+ | ****As the name says, when the "All Teams at War" flag is set for a mission, ships belonging to this iff will follow normal rules when choosing targets | ||
+ | ***''"orders hidden"'' | ||
+ | ****The HUD will not show a targeted ship's orders | ||
+ | ***''"orders shown"'' | ||
+ | ****The HUD will show a targeted ship's orders (enabled by default for all friendly IFFs) | ||
+ | ***''"wing name hidden"'' | ||
+ | ****The HUD will not show a targeted ship's name if it is in a wing}} | ||
===$Default Ship Flags:=== | ===$Default Ship Flags:=== | ||
+ | {{Table3610| | ||
*Ships belonging to a particular IFF can have a default set of flags when created in FRED. | *Ships belonging to a particular IFF can have a default set of flags when created in FRED. | ||
− | *Syntax: ( ''" | + | *Syntax: ( '''"String" "String"''' ), names of the flags |
**Example: ( "cargo-known" ) | **Example: ( "cargo-known" ) | ||
− | **List of | + | **List of possible ship flags: |
***''"cargo-known"'' | ***''"cargo-known"'' | ||
***''"ignore-count"'' | ***''"ignore-count"'' | ||
Line 67: | Line 172: | ||
***''"guardian"'' | ***''"guardian"'' | ||
***''"special-warp"'' | ***''"special-warp"'' | ||
+ | ***''"vaporize"'' | ||
+ | ***''"stealth"'' | ||
+ | ***''"friendly-stealth-invisible"'' | ||
+ | ***''"don't-collide-invisible"''}} | ||
+ | |||
+ | |||
+ | ===$Default Ship Flags2:=== | ||
+ | {{Table3610| | ||
+ | *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== | ==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]] | [[Category:Tables]] |
Revision as of 12:57, 19 February 2017
This feature requires FreeSpace Open |
Revision information.....
- FSO Revision: 5307
Note: Please update the version when the page is updated. If your edit had nothing to do with new code entries then please do not edit the version
The iff_defs.tbl (Identification Friend or Foe) table stores data on FS2's IFF (Identification Friend or Foe) 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.
Contents
- 1 General Format
- 1.1 $Traitor IFF:
- 1.2 $Selection Color: or $Selection Colour:
- 1.3 $Message Color: or $Message Colour:
- 1.4 $Tagged Color: or $Tagged Colour:
- 1.5 $Dimmed IFF brightness:
- 1.6 $Use Alternate Blip Coloring:
- 1.7 $Missile Blip Color: or $Missile Blip Colour:
- 1.8 $Navbuoy Blip Color: or $Navbuoy Blip Colour:
- 1.9 $Warping Blip Color: or $Warping Blip Colour:
- 1.10 $Node Blip Color: or $Node Blip Colour:
- 1.11 $Tagged Blip Color: or $Tagged Blip Colour:
- 1.12 $Radar Target ID Flags:
- 2 $IFF Name:
- 3 Sample Entry
General Format
- IFF_defs table consist of the generic definitions followed by actual iff definitions
- Table begins with #IFFs
- The traitor must be defined with $Traitor IFF:
- This entry is used to define which IFF is used to represent the traitors IFF
- Different IFFs entries begin with $IFF Name:
- Table ends with #End
$Traitor IFF:
- This entry is used to define which IFF is used to represent the traitors IFF
- Syntax: String, IFF entry
$Selection Color: or $Selection Colour:
FS2 Open, 3.6.12:
- Defines the color of the targeting brackets of selected targets (like asteroids and multi targeting targets and such)
- Syntax: Integer list, values from 0 to 255, red, green and blue respectively
- Default: ( 255, 255, 255 )
$Message Color: or $Message Colour:
FS2 Open, 3.6.12:
- Defines the color of the targeting brackets of the ship currently sending a message
- Syntax: Integer list, values from 0 to 255, red, green and blue respectively
- Default: ( 127, 127, 127 )
$Tagged Color: or $Tagged Colour:
FS2 Open, 3.6.12:
- Defines the color of the tagged targets
- Syntax: Integer list, values from 0 to 255, red, green and blue respectively
- Default: ( 255, 255, 0 )
$Dimmed IFF brightness:
FS2 Open, 3.6.12:
- Defines how much dimmer (transparent) are the dimmed objects of the HUD (most displays, distant targets on radar etc.)
- Syntax: Integer, values from 0 to 15
- Default: 4
$Use Alternate Blip Coloring:
FS2 Open, 3.6.12:
- If set forces all blips to use uniform transparency based 'dimming' method instead of using 1/2 brightness (non-transparent) on the non-ship blips
- Syntax: Boolean
- Default: NO
$Missile Blip Color: or $Missile Blip Colour:
FS2 Open, 3.6.12:
- Defines the color of the weapons (bombs) on radar screen. Dimmed color is 1/2 unless alternate blip coloring is in use.
- Syntax: Integer list, values from 0 to 255, red, green and blue respectively
- Default: ( 127, 127, 0 )
FS2 Open, 3.6.12:
- Defines the color of the navbuoys on radar screen. Dimmed color is 1/2 unless alternate blip coloring is in use.
- Syntax: Integer list, values from 0 to 255, red, green and blue respectively
- Default: ( 127, 127, 127 )
$Warping Blip Color: or $Warping Blip Colour:
FS2 Open, 3.6.12:
- Defines the color of the warping ships on radar screen. Dimmed color is 1/2 unless alternate blip coloring is in use.
- Syntax: Integer list, values from 0 to 255, red, green and blue respectively
- Default: ( 0, 0, 255 )
$Node Blip Color: or $Node Blip Colour:
FS2 Open, 3.6.12:
- Defines the color of the jump nodes on radar screen. Dimmed color is 1/2 unless alternate blip coloring is in use.
- Syntax: Integer list, values from 0 to 255, red, green and blue respectively
- Default: ( 127, 127, 127 )
$Tagged Blip Color: or $Tagged Blip Colour:
FS2 Open, 3.6.12:
- Defines the color of the tagged targets on radar screen. Dimmed color is 1/2 unless alternate blip coloring is in use.
- Syntax: Integer list, values from 0 to 255, red, green and blue respectively
- Default: ( 255, 255, 0 )
$Radar Target ID Flags:
FS2 Open, 3.6.12:
- Defines the appearance of the currently targeted blip on radar screen.
- Syntax: ( "String" ), name of the flag
- List of flags:
- "crosshairs"
- "blink"
- "pulsate"
- "enlarge"
- List of flags:
$IFF Name:
$Colour: or $Color:
FS2 Open 3.6.10:
- 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:
FS2 Open 3.6.10:
- Defines the IFFs that are attacked by default
- Syntax: ( String ), name of the IFF
- Example: ( "Friendly" "Neutral" "Traitor" )
+Sees IFF Name As:
FS2 Open 3.6.10:
- 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:
FS2 Open 3.6.10:
- IFFs can have special flags assigned to them.
- Syntax: ( "String" ), name of the flag
- Example: ( "support allowed" )
- List of flags:
- "support allowed"
- When a ship with this IFF is disabled and in a wing, it can call for support (normal behaviour for a disabled ship in a wing is to self-destruct)
- "exempt from all teams at war"
- As the name says, when the "All Teams at War" flag is set for a mission, ships belonging to this iff will follow normal rules when choosing targets
- "orders hidden"
- The HUD will not show a targeted ship's orders
- "orders shown"
- The HUD will show a targeted ship's orders (enabled by default for all friendly IFFs)
- "wing name hidden"
- The HUD will not show a targeted ship's name if it is in a wing
- "support allowed"
$Default Ship Flags:
FS2 Open 3.6.10:
- 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:
FS2 Open 3.6.10:
- 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
#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