Data Structures
class	SCR_PlayerControllerGroupComponentClass

Functions
int	GetGroupID ()

void	RequestCreateGroup ()

void	RequestKickPlayer (int playerID)

void	RequestPromoteLeader (int playerID)

void	RequestPrivateGroupChange (int playerID, bool isPrivate)

void	PlayerRequestToJoinPrivateGroup (int playerID, RplId groupID)

void	ClearAllRequesters (RplId groupID)

int	GetPlayerID ()

bool	CanPlayerJoinGroup (int playerID, notnull SCR_AIGroup group)

bool	IsPlayerLeader (int playerID, notnull SCR_AIGroup group)

bool	IsPlayerLeaderOwnGroup ()

bool	CanInvitePlayer (int playerID)

bool	WasAlreadyInvited (int playerID)

void	AcceptJoinPrivateGroup (int playerID, bool accept)

void	InvitePlayer (int playerID)

void	InviteThisPlayer (int groupID, int fromPlayerID)

void	AcceptInvite ()

ScriptInvoker	GetOnInviteReceived ()

void	OnGroupDeleted (SCR_AIGroup group)

void	RPC_PlayerRequestToJoinPrivateGroup (int playerID, RplId groupID)

void	RPC_ConfirmJoinPrivateGroup (int playerID, int groupID)

void	RPC_CancelJoinPrivateGroup (int playerID, int groupID)

void	RPC_DoInvitePlayer (int groupID, int fromPlayerID)

void	RPC_AskInvitePlayer (int playerID)

void	RPC_AskCreateGroup ()

void	RPC_AskKickPlayer (int playerID)

void	RPC_AskPromoteLeader (int playerID)

void	RPC_ChangePrivateGroup (int playerID, bool isPrivate)

void	RequestJoinGroup (int groupID)

void	RPC_DoChangeGroupID (int groupID)

protected void	OnGroupChangedDelayed (int groupId)

void	RPC_AskJoinGroup (int groupID)

bool	InitiateComponents (int playerID, out SCR_GroupsManagerComponent groupsManager, out SCR_PlayerControllerGroupComponent playerGroupController, out SCR_AIGroup group)

int	GetSelectedGroupID ()

ScriptInvoker	GetOnInviteAccepted ()

ScriptInvoker	GetOnGroupChanged ()

ScriptInvoker	GetOnInviteCancelled ()

int	GetGroupInviteID ()

void	SetGroupInviteID (int value)

int	GetGroupInviteFromPlayerID ()

string	GetGroupInviteFromPlayerName ()

void	SetSelectedGroupID (int groupID)

void	RequestSetCustomGroupDescription (int groupID, string desc)

void	RPC_AskSetCustomDescription (int groupID, string desc, int authorID)

void	RequestSetGroupMaxMembers (int groupID, int maxMembers)

void	RPC_AskSetGroupMaxMembers (int groupID, int maxMembers)

void	RequestSetCustomFrequency (int groupID, int frequency)
	Sets custom frequency (KHz) for a group. Can set frequency that is already claimed. Claims set frequency if not already claimed. Frequency set by this method will not be used by automatically created groups. More...

void	RequestSetNewGroupsAllowed (bool isAllowed)

void	RequestSetCanPlayersChangeAttributes (bool isAllowed)

void	RequestSetCustomGroupName (int groupID, string name)

void	RPC_AskSetCustomName (int groupID, string name, int authorID)

void	RPC_AskSetNewGroupsAllowed (bool isAllowed)

void	RPC_AskSetCanPlayersChangeAttributes (bool isAllowed)

void	RPC_AskSetFrequency (int groupID, int frequency)

void	RequestSetGroupFlag (int groupID, int flagIndex, bool isFromImageset)

void	RPC_AskSetGroupFlag (int groupID, int flagIndex, bool isFromImageset)

void	RPC_ClearAllRequesters (RplId groupID)

void	RequestCreateSlaveGroup (RplId rplCompID)

void	RPC_AskCreateSlaveGroup (RplId rplCompID)

bool	IsAICharacterInAnyGroup (SCR_ChimeraCharacter character, SCR_Faction faction)

void	RequestAddAIAgent (SCR_ChimeraCharacter character, int playerID)

void	RPC_AskAddAIAgent (RplId characterID, int playerID)

void	AddAIToSlaveGroup (notnull IEntity controlledEntity, SCR_AIGroup group)
	Should be only called on the server. More...

void	RPC_AskRemoveAIAgent (RplId characterID, int playerID)

void	RemoveAiFromSlaveGroup (notnull IEntity controlledEntity, SCR_AIGroup group)
	Should be only called on the server. More...

void	RequestRemoveAgent (SCR_ChimeraCharacter character, int playerID)

override void	OnPostInit (IEntity owner)
	Editable Mine. More...

override void	OnDelete (IEntity owner)

SCR_AIGroup	GetPlayersGroup ()

int	GetActualGroupFrequency ()

override void	EOnDiag (IEntity owner, float timeSlice)

void	ListGroupsFromFaction (Faction faction)

void	CreateAndJoinGroup (Faction faction)

Variables
SCR_PlayerControllerGroupComponentClass	m_iGroupID = -1

protected ref map< int, ref array< int > >	m_mPlayerInvitesToGroups

protected ref ScriptInvoker< int, int >	m_OnInviteReceived

protected ref ScriptInvoker< int >	m_OnInviteAccepted

protected ref ScriptInvoker< int >	m_OnInviteCancelled

protected ref ScriptInvoker< int >	m_OnGroupChanged

protected int	m_iUISelectedGroupID = -1

protected int	m_iGroupInviteID = -1

protected int	m_iGroupInviteFromPlayerID = -1

protected string	m_sGroupInviteFromPlayerName

const protected ref Color	DEFAULT_COLOR = new Color(0, 0, 0, 0.4)

Function Documentation

◆ AcceptInvite()

void AcceptInvite ( )

Definition at line 378 of file SCR_PlayerControllerGroupComponent.c.

◆ AcceptJoinPrivateGroup()

void AcceptJoinPrivateGroup	(	int	playerID,
		bool	accept
	)

Parameters

[in]	playerID
[in]	accept

Definition at line 321 of file SCR_PlayerControllerGroupComponent.c.

◆ AddAIToSlaveGroup()

void AddAIToSlaveGroup	(	notnull IEntity	controlledEntity,
		SCR_AIGroup	group
	)

Should be only called on the server.

Parameters

[in]	controlledEntity
[in]	group

Definition at line 1141 of file SCR_PlayerControllerGroupComponent.c.

◆ CanInvitePlayer()

bool CanInvitePlayer ( int playerID )

Parameters

[in] playerID

Returns

Definition at line 271 of file SCR_PlayerControllerGroupComponent.c.

◆ CanPlayerJoinGroup()

bool CanPlayerJoinGroup	(	int	playerID,
		notnull SCR_AIGroup	group
	)

Parameters

[in]	playerID
[in]	group

Returns

Definition at line 119 of file SCR_PlayerControllerGroupComponent.c.

◆ ClearAllRequesters()

void ClearAllRequesters ( RplId groupID )

Parameters

[in] groupID

Definition at line 97 of file SCR_PlayerControllerGroupComponent.c.

◆ CreateAndJoinGroup()

void CreateAndJoinGroup ( Faction faction )

Parameters

[in] faction

Definition at line 1361 of file SCR_PlayerControllerGroupComponent.c.

◆ GetActualGroupFrequency()

int GetActualGroupFrequency ( )

Returns

Definition at line 1280 of file SCR_PlayerControllerGroupComponent.c.

◆ GetGroupID()

int GetGroupID ( )

Returns

Definition at line 48 of file SCR_PlayerControllerGroupComponent.c.

◆ GetGroupInviteFromPlayerID()

int GetGroupInviteFromPlayerID ( )

Returns

Definition at line 756 of file SCR_PlayerControllerGroupComponent.c.

◆ GetGroupInviteFromPlayerName()

string GetGroupInviteFromPlayerName ( )

Returns

Definition at line 763 of file SCR_PlayerControllerGroupComponent.c.

◆ GetGroupInviteID()

int GetGroupInviteID ( )

Returns

Definition at line 742 of file SCR_PlayerControllerGroupComponent.c.

◆ GetOnGroupChanged()

ScriptInvoker GetOnGroupChanged ( )

Returns

Definition at line 722 of file SCR_PlayerControllerGroupComponent.c.

◆ GetOnInviteAccepted()

ScriptInvoker GetOnInviteAccepted ( )

Returns

Definition at line 712 of file SCR_PlayerControllerGroupComponent.c.

◆ GetOnInviteCancelled()

ScriptInvoker GetOnInviteCancelled ( )

Returns

Definition at line 732 of file SCR_PlayerControllerGroupComponent.c.

◆ GetOnInviteReceived()

ScriptInvoker GetOnInviteReceived ( )

Returns

Definition at line 401 of file SCR_PlayerControllerGroupComponent.c.

◆ GetPlayerID()

int GetPlayerID ( )

Returns

Definition at line 105 of file SCR_PlayerControllerGroupComponent.c.

◆ GetPlayersGroup()

SCR_AIGroup GetPlayersGroup ( )

Returns

Definition at line 1269 of file SCR_PlayerControllerGroupComponent.c.

◆ GetSelectedGroupID()

int GetSelectedGroupID ( )

Returns

Definition at line 705 of file SCR_PlayerControllerGroupComponent.c.

◆ InitiateComponents()

bool InitiateComponents	(	int	playerID,
		out SCR_GroupsManagerComponent	groupsManager,
		out SCR_PlayerControllerGroupComponent	playerGroupController,
		out SCR_AIGroup	group
	)

Parameters

[in]	playerID
[out]	groupsManager
[out]	playerGroupController
[out]	group

Returns

Definition at line 687 of file SCR_PlayerControllerGroupComponent.c.

◆ InvitePlayer()

void InvitePlayer ( int playerID )

Parameters

[in] playerID

Definition at line 340 of file SCR_PlayerControllerGroupComponent.c.

◆ InviteThisPlayer()

void InviteThisPlayer	(	int	groupID,
		int	fromPlayerID
	)

Parameters

[in]	groupID
[in]	fromPlayerID

Definition at line 371 of file SCR_PlayerControllerGroupComponent.c.

◆ IsAICharacterInAnyGroup()

bool IsAICharacterInAnyGroup	(	SCR_ChimeraCharacter	character,
		SCR_Faction	faction
	)

Parameters

[in]	character
[in]	faction

Returns

Definition at line 1078 of file SCR_PlayerControllerGroupComponent.c.

◆ IsPlayerLeader()

bool IsPlayerLeader	(	int	playerID,
		notnull SCR_AIGroup	group
	)

Parameters

[in]	playerID
[in]	group

Returns

Definition at line 240 of file SCR_PlayerControllerGroupComponent.c.

◆ IsPlayerLeaderOwnGroup()

bool IsPlayerLeaderOwnGroup ( )

Returns

Definition at line 248 of file SCR_PlayerControllerGroupComponent.c.

◆ ListGroupsFromFaction()

void ListGroupsFromFaction ( Faction faction )

Parameters

[in] faction

Definition at line 1342 of file SCR_PlayerControllerGroupComponent.c.

◆ OnGroupChangedDelayed()

protected void OnGroupChangedDelayed ( int groupId )

Definition at line 648 of file SCR_PlayerControllerGroupComponent.c.

◆ OnGroupDeleted()

void OnGroupDeleted ( SCR_AIGroup group )

Parameters

[in] group

Definition at line 411 of file SCR_PlayerControllerGroupComponent.c.

◆ PlayerRequestToJoinPrivateGroup()

void PlayerRequestToJoinPrivateGroup	(	int	playerID,
		RplId	groupID
	)

Parameters

[in]	playerID
[in]	groupID

Definition at line 89 of file SCR_PlayerControllerGroupComponent.c.

◆ RemoveAiFromSlaveGroup()

void RemoveAiFromSlaveGroup	(	notnull IEntity	controlledEntity,
		SCR_AIGroup	group
	)

Should be only called on the server.

Parameters

[in]	controlledEntity
[in]	group

Definition at line 1199 of file SCR_PlayerControllerGroupComponent.c.

◆ RequestAddAIAgent()

void RequestAddAIAgent	(	SCR_ChimeraCharacter	character,
		int	playerID
	)

Parameters

[in]	character
[in]	playerID

Definition at line 1101 of file SCR_PlayerControllerGroupComponent.c.

◆ RequestCreateGroup()

void RequestCreateGroup ( )

Definition at line 55 of file SCR_PlayerControllerGroupComponent.c.

◆ RequestCreateSlaveGroup()

void RequestCreateSlaveGroup ( RplId rplCompID )

Parameters

[in] rplCompID

Definition at line 1039 of file SCR_PlayerControllerGroupComponent.c.

◆ RequestJoinGroup()

void RequestJoinGroup ( int groupID )

Parameters

[in] groupID

Definition at line 624 of file SCR_PlayerControllerGroupComponent.c.

◆ RequestKickPlayer()

void RequestKickPlayer ( int playerID )

Parameters

[in] playerID

Definition at line 63 of file SCR_PlayerControllerGroupComponent.c.

◆ RequestPrivateGroupChange()

void RequestPrivateGroupChange	(	int	playerID,
		bool	isPrivate
	)

Parameters

[in]	playerID
[in]	isPrivate

Definition at line 80 of file SCR_PlayerControllerGroupComponent.c.

◆ RequestPromoteLeader()

void RequestPromoteLeader ( int playerID )

Parameters

[in] playerID

Definition at line 71 of file SCR_PlayerControllerGroupComponent.c.

◆ RequestRemoveAgent()

void RequestRemoveAgent	(	SCR_ChimeraCharacter	character,
		int	playerID
	)

Parameters

[in]	character
[in]	playerID

Definition at line 1231 of file SCR_PlayerControllerGroupComponent.c.

◆ RequestSetCanPlayersChangeAttributes()

void RequestSetCanPlayersChangeAttributes ( bool isAllowed )

Parameters

[in] isAllowed

Definition at line 881 of file SCR_PlayerControllerGroupComponent.c.

◆ RequestSetCustomFrequency()

void RequestSetCustomFrequency	(	int	groupID,
		int	frequency
	)

Sets custom frequency (KHz) for a group. Can set frequency that is already claimed. Claims set frequency if not already claimed. Frequency set by this method will not be used by automatically created groups.

Parameters