AircraftFormation

From SIMboxWiki
Jump to navigation Jump to search

The AircraftFormation logic component handles the logic for aircraft formations.

Type: Logic Object Component
File: AircraftFormation.slc
Version: 450.1000.342.1


back to top

Icon properties.png Properties

NameDescriptionMaxValueMinValueDisplayNameUnitTypeUnitName
PROP_FORMATION_NAME  Name of the formation  Formation Call Sign  Default  Default 
PROP_FORMATION_NUM_MEMBERS  Number of members in the formation    Default  Default 
PROP_FORMATION_TYPE  Formation type name.    Default  Default 
PROP_IS_LEADER  Is this object a leader?  Is Leader  Default  Default 
PROP_LEADER_NAME  The name of the leader  Leader Entity CallSign  Default  Default 
PROP_NUMBER_IN_FORMATION  Number in the formation  Formation Number  Default  Default 
PROP_OFFSET_FROM_LEADER_X  X offset from the leader  Offset from leader X  Default  Default 
PROP_OFFSET_FROM_LEADER_Y  Y offset from the leader  Offset from leader Y  Default  Default 
PROP_OFFSET_FROM_LEADER_Z  Z offset from the leader  Offset from leader Z  Default  Default 

back to top

Icon attributes.png Attributes

NameDescriptionParam1Param2DisplayNameUnitTypeUnitName
ATT_FORMATION_DISTANCE_FROM_LEADER  Get the distance between me and the formation's leader  LinearVec &    Distance From Formation Leader  Length  Meter 
ATT_FORMATION_DISTANCE_TO_POSITION_IN_FORMATION  The distance to the position that the member should be  float &    Distance To Formation Position  Length  Meter 
ATT_FORMATION_GET_MEMBER_ID_BY_INDEX  Return the member Id according to index - only answered by leader  const int  int &    Entity Identifier  Entity ID 
ATT_FORMATION_IS_IN_FORMATION  Return true if I'm inside the formation  bool &    Flying in Fomration  Default  Default 
ATT_FORMATION_IS_IN_SPECIFIC_FORMATION  Return true if I'm in the given formation  const string &  bool &    Default  Default 
ATT_FORMATION_IS_LEADER  Return true if I'm the leader  bool &    Am I formation leader?  Default  Default 
ATT_FORMATION_LEADER_AA_TARGET  Get the AA target ordered by the leader  int &      Entity Identifier  Entity ID 
ATT_FORMATION_LEADER_AG_TARGET  Get the AG target ordered by the leader  int &      Entity Identifier  Entity ID 
ATT_FORMATION_LEADER_ID  The entity id of the leader  int &    Leader ID  Entity Identifier  Entity ID 
ATT_FORMATION_LOCATION  Get the entity location within the formation  int &      Default  Default 
ATT_FORMATION_NAME  Get the formation name  string &      Default  Default 
ATT_FORMATION_NUM_MEMBERS  Return the number of members in the formation - only answered by leader  int &    Number of members in formation  Default  Default 
ATT_FORMATION_OFFSET_FROM_POSITION_IN_FORMATION_X  The X offset from the position that the member should be  float &      Length  Meter 
ATT_FORMATION_OFFSET_FROM_POSITION_IN_FORMATION_Y  The Y offset from the position that the member should be  float &      Length  Meter 
ATT_FORMATION_OFFSET_FROM_POSITION_IN_FORMATION_Z  The Z offset from the position that the member should be  float &      Length  Meter 
ATT_FORMATION_SWITCH_MANEUVER  Switch formation to maneuver [SQL:NONE|NONE|CCRP|CCRP|DOG_FIGHT|DOG_FIGHT]  string &    Current Maneuver  Default  Default 
ATT_FORMATION_TYPE  Get the formation type (Echelon/Free/Wedge etc.  string &    Formation Type  Default  Default 
ATT_IS_TACTICAL_FORMATION  Return true if is tactical formation  bool &      Default  Default 
ATT_NUMBER_IN_FORMATION  Holds number in formation  int &      Default  Default 

back to top

Icon actions.png Actions

NameDescriptionParam1Param2DisplayNameUnitTypeUnitName
ACTION_FORMATION_SWITCH_MANEUVER  Switch formation maneuver [SQL:NONE|NONE|CCRP|CCRP|DOG_FIGHT|DOG_FIGHT]  const string &      Default  Default 
ACTION_SET_FORMATION_AA_TARGET_ID  Set the formation AA target ID  const int      Entity Identifier  Entity ID 
ACTION_SET_FORMATION_AG_TARGET_ID  Set the formation AG target ID  const int      Entity Identifier  Entity ID 
ACTION_SET_FORMATION_NAME  Set entity formation name  const string &      Default  Default 
ACTION_SET_FORMATION_TYPE  Set entity formation type  const string &      Default  Default 
ACTION_SET_FREE_FORMATION  Set free formation  const int  const int    Default  Default 
ACTION_SET_IS_IN_FORMATION  Set if entity is in formation  const bool      Default  Default 
ACTION_SET_IS_LEADER  Set if entity is leader  const bool      Default  Default 
ACTION_SET_LEADER_ID  Set the leader entity ID  const int      Entity Identifier  Entity ID 
ACTION_SET_MEMBER  Set the entity in leader array  const int  const int    Default  Default 
ACTION_SET_NUMBER_IN_FORMATION  Set the position within the formation  const int      Default  Default 
ACTION_SET_OFFSET_FROM_LEADER  Set the distance from the leader  const LinearVec &      Length  Meter 
ACTION_SET_X_DISTANCE_FROM_LEADER  Set the X distance from the leader (meters)  const int      Length  Meter 
ACTION_SET_Y_DISTANCE_FROM_LEADER  Set the Y distance from the leader (meters)  const int      Length  Meter 
ACTION_SET_Z_DISTANCE_FROM_LEADER  Set the Z distance from the leader (meters)  const int      Length  Meter 
DO_ECHELON_FORMATION  Formation - Echelon  const int  const int    Default  Default 
DO_FREE_FORMATION  Formation - no formation (free)  const int  const int    Default  Default 
DO_LINE_FORMATION  Formation - Line  const int  const int    Default  Default 
DO_TRAIL_FORMATION  Formation - Trail  const int  const int    Default  Default 
DO_WEDGE_FORMATION  Formation - Wedge  const int  const int    Default  Default 
FORMATION_DO_CCRP_MANEUVER  Formation - switch to CCRP maneuver   const int  const int    Default  Default 
FORMATION_DO_DOG_FIGHT_MANEUVER  Formation - switch to Dog Fight maneuver   const int  const int    Default  Default 
TOGGLE_TACTICAL_CLOSE_FORMATION  Formation - toggle tactical/closed formation  const int  const int    Default  Default 

back to top

Icon attributes.png Required Attributes

Name
ATT_FORMATION_RELATIVE_POSITION 
ATT_PARENT_GROUP_ID 
ATT_RADAR_NUMBER_OF_TARGETS 
ATT_RADAR_PRIMARY_TARGET 
ATT_RADAR_REQUESTED_TARGET 
ATT_TYPE_NAME 

back to top

Icon actions.png Required Actions

Name
ACTION_SET_NAME 

back to top