SMG FormationMember

The SMG_FormationMember logic component holds formation member data.

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


back to top

Properties

Name	Description	MaxValue	MinValue	DisplayName	UnitType	UnitName
PROP_FORMATION_MEMBER_ROLE_NAME	Formation member role name	0	0		Default	Default

back to top

Attributes

Name	Description	Param1	Param2	DisplayName	UnitType	UnitName
ATT_FORMATION_GET_MEMBER_ID_BY_INDEX	Return the member Id according to index - only answered by leader	const int	int &		Default	Default
ATT_FORMATION_IS_IN_FORMATION	Return true if I'm inside the formation	bool &			Default	Default
ATT_FORMATION_IS_LEADER	Return true if I'm the leader	bool &			Default	Default
ATT_FORMATION_LEADER_ID	Get leader Id	int &			Default	Default
ATT_FORMATION_LOCATION	Get the entity location within the formation	int &			Default	Default
ATT_FORMATION_MEMBER_DATA_DIRTY_TRIGGER	Indicate that the formation member data is dirty.	int &			Default	Default
ATT_FORMATION_MEMBER_GROUP_ID	Formation group ID	int &			Default	Default
ATT_FORMATION_MEMBER_IS_LEADER	Return true if Im the leader	bool &			Default	Default
ATT_FORMATION_MEMBER_LEADER_ID	Formation leader id	int &			Default	Default
ATT_FORMATION_MEMBER_NUM_MEMBERS	The number of members in the formation	int &			Default	Default
ATT_FORMATION_MEMBER_NUMBER_IN_FORMATION	Holds number in formation for this member	int &			Default	Default
ATT_FORMATION_MEMBER_RELATIVE_POSITION	Holds relative offset position from the leader for this formation member	LinearVec &			Default	Default
ATT_FORMATION_MEMBER_ROLE_NAME	Formation member role name	string &			Default	Default
ATT_FORMATION_MEMBER_TYPE	Holds the formation member type (self navigate / keep relative from leader / keep relative from previous member)	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 &			Default	Default
ATT_FORMATION_PREVIOUS_MEMBER_RELATIVE_POSITION	Holds relative offset position from previous member for this formation member	LinearVec &			Default	Default
ATT_FORMATION_PREVIOUS_MEMBER_RELATIVE_TIME_BEHIND	Time (seconds) relative to previous member	float &			Default	Default
ATT_FORMATION_TYPE	Get the formation type (Echelon/Free/Wedge etc.	string &			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

Actions

Name	Description	Param1	Param2	DisplayName	UnitType	UnitName
ACTION_FORMATION_MEMBER_DATA_DIRTY_TRIGGER	Formation member data trigger				Default	Default
ACTION_REMOVE_FORMATION_MEMBER_FROM_FORMATION	Remove formation member from formation				Default	Default
ACTION_SET_FORMATION_GROUP_ID	Set formation group ID	const int			Default	Default
ACTION_SET_FORMATION_LEADER_ID	Set entity formation leader ID	const int			Default	Default
ACTION_SET_FORMATION_MEMBER_NUMBER_IN_FORMATION	Set number in formation	const int			Default	Default
ACTION_SET_FORMATION_MEMBER_RELATIVE_POSITION	Set formation member relative position.	const LinearVec &			Default	Default
ACTION_SET_FORMATION_MEMBER_TYPE	Set the formation member type (self navigate / keep relative from leader / keep relative from previous member)	const int			Default	Default
ACTION_SET_FORMATION_NUM_MEMBERS	Set entity formation number members	const int			Default	Default
ACTION_SET_FORMATION_PREVIOUS_MEMBER_RELATIVE_POSITION	Set formation previous member relative position.	const LinearVec &			Default	Default
ACTION_SET_RELATIVE_TO_PREVIOUS_FORMATION_MEMBER_TIME_BEHIND	Time (seconds) relative to previous member	const float			Default	Default

back to top

Required Attributes

Name
ATT_NUMBER_IN_FORMATION_TO_ENTITY_ID
ATT_UNIQUE_NAME

back to top,