Arma Reforger Script API
Loading...
Searching...
No Matches
Public Member Functions | List of all members
SCR_LeaderRoleCallsign Interface Reference
Inheritance diagram for SCR_LeaderRoleCallsign:
[legend]

Public Member Functions

override bool IsValidRole (IEntity character, int playerID, SCR_AIGroup group, inout int roleCallsignIndex, out bool isUnique)
 Checks if AI can be assigned a role (or a specific role if roleCallsignIndex is given a value)
 
override int GetRoleIndex ()
 Get Role index.
 
- Public Member Functions inherited from SCR_BaseRoleCallsign
bool IsValidRole (IEntity character, int playerID, SCR_AIGroup group, inout int roleCallsignIndex, out bool isUnique)
 Checks if AI can be assigned a role (or a specific role if roleCallsignIndex is given a value)
 
string GetRoleName ()
 Get Role name.
 
int GetRoleIndex ()
 Get Role index.
 

Additional Inherited Members

- Protected Attributes inherited from SCR_BaseRoleCallsign
bool m_bEnabled
 
LocalizedString m_sRoleName
 
SCR_ERoleAvailableForCharacterType m_eRoleAvailableForCharacterType
 
bool m_bIsUnique
 

Member Function Documentation

◆ GetRoleIndex()

override int SCR_LeaderRoleCallsign.GetRoleIndex ( )

Get Role index.

Returns
int role index

Implements SCR_BaseRoleCallsign.

◆ IsValidRole()

override bool SCR_LeaderRoleCallsign.IsValidRole ( IEntity  character,
int  playerID,
SCR_AIGroup  group,
inout int  roleCallsignIndex,
out bool  isUnique 
)

Checks if AI can be assigned a role (or a specific role if roleCallsignIndex is given a value)

Parameters
characterIEntity of character to assign callsign (Can be player or AI)
playerIDIf character is a player then player ID can be used to check if valid
groupSCR_AIGroup group of which character is a part of
occupiedRolesroles already occupied by AI for the group the character is part of
occupiedRolesroles already occupied by Player for the group the character is part of
[out]roleCallsignIndexthe return index of the found character role. Can be given a value to look for a specific role to assign
[out]isUniqueIf true than only one character can have the role in the group (as well as any attached master and slave groups)
Returns
bool true if callsign found, else it returns false

Implements SCR_BaseRoleCallsign.


The documentation for this interface was generated from the following file: