Arma Reforger Script API
|
Stores the Callsign information data for the faction. More...
Public Member Functions | |
string | GetCallsignFormat (bool includeCharacter, int characterRole=-1) |
Get callsign format. | |
bool | GetIsAssignedRandomly () |
Get callsign format. | |
void | GetCompanyArray (notnull array< ref SCR_CallsignInfo > companyArray) |
Get Company array. | |
void | GetPlatoonArray (notnull array< ref SCR_CallsignInfo > platoonArray) |
Get Platoon array. | |
void | GetSquadArray (notnull array< ref SCR_CallsignInfo > squadArray) |
Get Squad array. | |
string | GetCompanyCallsignName (int index) |
Get the company name using index. | |
int | GetCompanyOverflowIndex () |
Gets the index at which overflow companies start. | |
string | GetPlatoonCallsignName (int index) |
Get the Platoon name using index. | |
string | GetSquadCallsignName (int index) |
Get the Squad name using index. | |
string | GetCharacterRoleCallsignName (int index) |
Get the character role callsign using index. | |
bool | GetRandomCallsign (out int company, out int platoon, out int squad) |
Get random call sign. | |
bool | GetCharacterRoleCallsign (IEntity character, int playerID, SCR_AIGroup group, inout int roleCallsignIndex, out bool isUnique) |
Loops through all availible roles for the faction and grabs the first availible role for that character. | |
Protected Attributes | |
bool | m_bIsAssignedRandomly |
ref array< ref SCR_CallsignInfo > | m_aCompanyNames |
int | m_iCompanyOverflowIndex |
ref array< ref SCR_CallsignInfo > | m_aPlatoonNames |
ref array< ref SCR_CallsignInfo > | m_aSquadNames |
LocalizedString | m_sCallsignGroupFormat |
LocalizedString | m_sCallsignCharacterFormat |
LocalizedString | m_sCallsignCharacterWithRoleFormat |
ref array< ref SCR_BaseRoleCallsign > | m_aCharacterRoleCallsigns |
Stores the Callsign information data for the faction.
string SCR_FactionCallsignInfo.GetCallsignFormat | ( | bool | includeCharacter, |
int | characterRole = -1 |
||
) |
Get callsign format.
bool SCR_FactionCallsignInfo.GetCharacterRoleCallsign | ( | IEntity | character, |
int | playerID, | ||
SCR_AIGroup | group, | ||
inout int | roleCallsignIndex, | ||
out bool | isUnique | ||
) |
Loops through all availible roles for the faction and grabs the first availible role for that character.
character | IEntity of character to assign callsign | |
playerID | if entity is a player then ID is also given | |
group | SCR_AIGroup group of which character is a part of | |
occupiedAIRoles | roles already occupied by AI for the group the character is part of | |
occupiedPlayerRoles | roles already occupied by Player for the group the character is part of | |
[out] | roleCallsignIndex | the return index of the found character role. Can be given a value to look for a specific role to assign |
[out] | isUnique | If true than only one character can have the role in the group (as well as any attached master and slave groups) |
string SCR_FactionCallsignInfo.GetCharacterRoleCallsignName | ( | int | index | ) |
Get the character role callsign using index.
index | of character role |
void SCR_FactionCallsignInfo.GetCompanyArray | ( | notnull array< ref SCR_CallsignInfo > | companyArray | ) |
Get Company array.
string SCR_FactionCallsignInfo.GetCompanyCallsignName | ( | int | index | ) |
Get the company name using index.
index | of company name |
int SCR_FactionCallsignInfo.GetCompanyOverflowIndex | ( | ) |
Gets the index at which overflow companies start.
bool SCR_FactionCallsignInfo.GetIsAssignedRandomly | ( | ) |
Get callsign format.
void SCR_FactionCallsignInfo.GetPlatoonArray | ( | notnull array< ref SCR_CallsignInfo > | platoonArray | ) |
Get Platoon array.
string SCR_FactionCallsignInfo.GetPlatoonCallsignName | ( | int | index | ) |
Get the Platoon name using index.
index | of Platoon name |
bool SCR_FactionCallsignInfo.GetRandomCallsign | ( | out int | company, |
out int | platoon, | ||
out int | squad | ||
) |
Get random call sign.
[out] | company | random company name index |
[out] | platoon | random platoon name index |
[out] | squad | random squad name index |
void SCR_FactionCallsignInfo.GetSquadArray | ( | notnull array< ref SCR_CallsignInfo > | squadArray | ) |
Get Squad array.
string SCR_FactionCallsignInfo.GetSquadCallsignName | ( | int | index | ) |
Get the Squad name using index.
index | of Squad name |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |