SCR_BaseRoleCallsign Class Reference

Inheritance diagram for SCR_BaseRoleCallsign:

Protected Member Functions
bool	IsValidRole (IEntity character, int playerID, SCR_AIGroup group, inout int roleCallsignIndex, out bool isUnique)
string	GetRoleName ()
int	GetRoleIndex ()

Protected Attributes
bool	m_bEnabled
LocalizedString	m_sRoleName
SCR_ERoleAvailableForCharacterType	m_eRoleAvailableForCharacterType
bool	m_bIsUnique

Detailed Description

Definition at line 2 of file SCR_BaseRoleCallsign.c.

Member Function Documentation

GetRoleIndex()

int SCR_BaseRoleCallsign::GetRoleIndex ( )

inlineprotected

Get Role index

Returns

int role index

Definition at line 91 of file SCR_BaseRoleCallsign.c.

GetRoleName()

string SCR_BaseRoleCallsign::GetRoleName ( )

inlineprotected

Get Role name

Returns

string role localized name

Definition at line 81 of file SCR_BaseRoleCallsign.c.

IsValidRole()

bool SCR_BaseRoleCallsign::IsValidRole ( IEntity character, int playerID, SCR_AIGroup group, inout int roleCallsignIndex, out bool isUnique )

inlineprotected

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

Definition at line 28 of file SCR_BaseRoleCallsign.c.

Member Data Documentation

m_bEnabled

bool SCR_BaseRoleCallsign::m_bEnabled

protected

Definition at line 5 of file SCR_BaseRoleCallsign.c.

m_bIsUnique

bool SCR_BaseRoleCallsign::m_bIsUnique

protected

Definition at line 14 of file SCR_BaseRoleCallsign.c.

m_eRoleAvailableForCharacterType

SCR_ERoleAvailableForCharacterType SCR_BaseRoleCallsign::m_eRoleAvailableForCharacterType

protected

Definition at line 11 of file SCR_BaseRoleCallsign.c.

m_sRoleName

LocalizedString SCR_BaseRoleCallsign::m_sRoleName

protected

Definition at line 8 of file SCR_BaseRoleCallsign.c.

---

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

• scripts/Game/Callsign/RoleCallsigns/SCR_BaseRoleCallsign.c