SCR_BaseRoleCallsign Interface Reference

Inheritance diagram for SCR_BaseRoleCallsign:

Public Member Functions
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.

Protected Attributes
bool	m_bEnabled
LocalizedString	m_sRoleName
SCR_ERoleAvailableForCharacterType	m_eRoleAvailableForCharacterType
bool	m_bIsUnique

Member Function Documentation

GetRoleIndex()

int SCR_BaseRoleCallsign.GetRoleIndex

(

)

Get Role index.

Returns

int role index

Implemented in SCR_LeaderRoleCallsign, SCR_PlayerLeaderRoleCallsign, and SCR_RadioOperatorRoleCallsign.

GetRoleName()

string SCR_BaseRoleCallsign.GetRoleName

(

)

Get Role name.

Returns

string role localized name

IsValidRole()

bool SCR_BaseRoleCallsign.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

	character	IEntity of character to assign callsign (Can be player or AI)
	playerID	If character is a player then player ID can be used to check if valid
	group	SCR_AIGroup group of which character is a part of
	occupiedRoles	roles already occupied by AI for the group the character is part of
	occupiedRoles	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)

Returns

bool true if callsign found, else it returns false

Implemented in SCR_LeaderRoleCallsign, SCR_PlayerLeaderRoleCallsign, and SCR_RadioOperatorRoleCallsign.

Member Data Documentation

m_bEnabled

bool SCR_BaseRoleCallsign.m_bEnabled

protected

m_bIsUnique

bool SCR_BaseRoleCallsign.m_bIsUnique

protected

m_eRoleAvailableForCharacterType

SCR_ERoleAvailableForCharacterType SCR_BaseRoleCallsign.m_eRoleAvailableForCharacterType

protected

m_sRoleName

LocalizedString SCR_BaseRoleCallsign.m_sRoleName

protected

---

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

• Game/Callsign/RoleCallsigns/SCR_BaseRoleCallsign.c