Difference between revisions of "Iff defs.tbl"

From FreeSpace Wiki
Jump to: navigation, search
($Default Ship Flags:)
(Sample Entry)
Line 80: Line 80:
 
   ; Friendly
 
   ; Friendly
 
   ;------------------------
 
   ;------------------------
   $IFF Name: Friendly
+
   $IFF Name: Hostile
 
   $Color: ( 0, 255, 0 )
 
   $Color: ( 0, 255, 0 )
 
   $Attacks: ( "Hostile" "Neutral" "Traitor" )
 
   $Attacks: ( "Hostile" "Neutral" "Traitor" )
Line 89: Line 89:
 
   ; Hostile
 
   ; Hostile
 
   ;------------------------
 
   ;------------------------
   $IFF Name: Hostile
+
   $IFF Name: Friendly
 
   $Color: ( 255, 0, 0 )
 
   $Color: ( 255, 0, 0 )
 
   $Attacks: ( "Friendly" "Neutral" "Traitor" )
 
   $Attacks: ( "Friendly" "Neutral" "Traitor" )

Revision as of 09:08, 27 July 2007

This feature requires SCP


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 Name:
  • Table ends with #End

$IFF Name:

$Colour: or $Color:

  • Defines the color of the IFF as seen in by default (e.g. in briefing icons).
  • Syntax: ( Value, Value, Value ), values from 0 to 255; red, green and blue respecticely
    • Example: ( 0, 255, 0 )

$Attacks:

  • Defines the IFFs that are attacked by default
  • Syntax: ( IFF Name )
    • Example: ( "Friendly" "Neutral" "Traitor" )

+Sees IFF Name As:

  • 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: ( Value, Value, Value ), values from 0 to 255; red, green and blue respecticely
    • Example: ( 255, 0, 0 )

$Flags:

  • IFFs can have special flags assigned to them.
  • Syntax: ( "Name" )
    • Example: ( "support allowed" )
    • List of
      • "support allowed"
      • "exempt from all teams at war"

$Default Ship Flags:

  • Ships belonging to a particular IFF can have a default set of flags when created in FRED.
  • Syntax: ( "Name" )
    • Example: ( "cargo-known" )
    • List of default 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"

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: Hostile														
  $Color: ( 0, 255, 0 )													
  $Attacks: ( "Hostile" "Neutral" "Traitor" )						
  $Flags: ( "support allowed" )											
  $Default Ship Flags: ( "cargo-known" )								
  	
  ;------------------------												
  ; Hostile																
  ;------------------------												
  $IFF Name: Friendly														
  $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