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

Public Member 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)
 
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.
 
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.
 
void RPC_AskRemoveAIAgent (RplId characterID, int playerID)
 
void RemoveAiFromSlaveGroup (notnull IEntity controlledEntity, SCR_AIGroup group)
 Should be only called on the server.
 
void RequestRemoveAgent (SCR_ChimeraCharacter character, int playerID)
 
override void OnPostInit (IEntity owner)
 
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)
 

Static Public Member Functions

static SCR_PlayerControllerGroupComponent GetPlayerControllerComponent (int playerID)
 
static SCR_PlayerControllerGroupComponent GetLocalPlayerControllerGroupComponent ()
 

Protected Member Functions

void OnGroupChangedDelayed (int groupId)
 

Protected Attributes

int m_iGroupID = -1
 
ref map< int, ref array< int > > m_mPlayerInvitesToGroups
 
ref ScriptInvoker< int, int > m_OnInviteReceived
 
ref ScriptInvoker< int > m_OnInviteAccepted
 
ref ScriptInvoker< int > m_OnInviteCancelled
 
ref ScriptInvoker< int > m_OnGroupChanged
 
int m_iUISelectedGroupID = -1
 
int m_iGroupInviteID = -1
 
int m_iGroupInviteFromPlayerID = -1
 
string m_sGroupInviteFromPlayerName
 

Static Protected Attributes

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

Member Function Documentation

◆ AcceptInvite()

void SCR_PlayerControllerGroupComponent.AcceptInvite ( )

◆ AcceptJoinPrivateGroup()

void SCR_PlayerControllerGroupComponent.AcceptJoinPrivateGroup ( int  playerID,
bool  accept 
)
Parameters
[in]playerID
[in]accept

◆ AddAIToSlaveGroup()

void SCR_PlayerControllerGroupComponent.AddAIToSlaveGroup ( notnull IEntity  controlledEntity,
SCR_AIGroup  group 
)

Should be only called on the server.

Parameters
[in]controlledEntity
[in]group

◆ CanInvitePlayer()

bool SCR_PlayerControllerGroupComponent.CanInvitePlayer ( int  playerID)
Parameters
[in]playerID
Returns

◆ CanPlayerJoinGroup()

bool SCR_PlayerControllerGroupComponent.CanPlayerJoinGroup ( int  playerID,
notnull SCR_AIGroup  group 
)
Parameters
[in]playerID
[in]group
Returns

◆ ClearAllRequesters()

void SCR_PlayerControllerGroupComponent.ClearAllRequesters ( RplId  groupID)
Parameters
[in]groupID

◆ CreateAndJoinGroup()

void SCR_PlayerControllerGroupComponent.CreateAndJoinGroup ( Faction  faction)
Parameters
[in]faction

◆ EOnDiag()

override void SCR_PlayerControllerGroupComponent.EOnDiag ( IEntity  owner,
float  timeSlice 
)

◆ GetActualGroupFrequency()

int SCR_PlayerControllerGroupComponent.GetActualGroupFrequency ( )
Returns

◆ GetGroupID()

int SCR_PlayerControllerGroupComponent.GetGroupID ( )
Returns

◆ GetGroupInviteFromPlayerID()

int SCR_PlayerControllerGroupComponent.GetGroupInviteFromPlayerID ( )
Returns

◆ GetGroupInviteFromPlayerName()

string SCR_PlayerControllerGroupComponent.GetGroupInviteFromPlayerName ( )
Returns

◆ GetGroupInviteID()

int SCR_PlayerControllerGroupComponent.GetGroupInviteID ( )
Returns

◆ GetLocalPlayerControllerGroupComponent()

static SCR_PlayerControllerGroupComponent SCR_PlayerControllerGroupComponent.GetLocalPlayerControllerGroupComponent ( )
static
Returns

◆ GetOnGroupChanged()

ScriptInvoker SCR_PlayerControllerGroupComponent.GetOnGroupChanged ( )
Returns

◆ GetOnInviteAccepted()

ScriptInvoker SCR_PlayerControllerGroupComponent.GetOnInviteAccepted ( )
Returns

◆ GetOnInviteCancelled()

ScriptInvoker SCR_PlayerControllerGroupComponent.GetOnInviteCancelled ( )
Returns

◆ GetOnInviteReceived()

ScriptInvoker SCR_PlayerControllerGroupComponent.GetOnInviteReceived ( )
Returns

◆ GetPlayerControllerComponent()

static SCR_PlayerControllerGroupComponent SCR_PlayerControllerGroupComponent.GetPlayerControllerComponent ( int  playerID)
static
Parameters
[in]playerID
Returns

◆ GetPlayerID()

int SCR_PlayerControllerGroupComponent.GetPlayerID ( )
Returns

◆ GetPlayersGroup()

SCR_AIGroup SCR_PlayerControllerGroupComponent.GetPlayersGroup ( )
Returns

◆ GetSelectedGroupID()

int SCR_PlayerControllerGroupComponent.GetSelectedGroupID ( )
Returns

◆ InitiateComponents()

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

◆ InvitePlayer()

void SCR_PlayerControllerGroupComponent.InvitePlayer ( int  playerID)
Parameters
[in]playerID

◆ InviteThisPlayer()

void SCR_PlayerControllerGroupComponent.InviteThisPlayer ( int  groupID,
int  fromPlayerID 
)
Parameters
[in]groupID
[in]fromPlayerID

◆ IsAICharacterInAnyGroup()

bool SCR_PlayerControllerGroupComponent.IsAICharacterInAnyGroup ( SCR_ChimeraCharacter  character,
SCR_Faction  faction 
)
Parameters
[in]character
[in]faction
Returns

◆ IsPlayerLeader()

bool SCR_PlayerControllerGroupComponent.IsPlayerLeader ( int  playerID,
notnull SCR_AIGroup  group 
)
Parameters
[in]playerID
[in]group
Returns

◆ IsPlayerLeaderOwnGroup()

bool SCR_PlayerControllerGroupComponent.IsPlayerLeaderOwnGroup ( )
Returns

◆ ListGroupsFromFaction()

void SCR_PlayerControllerGroupComponent.ListGroupsFromFaction ( Faction  faction)
Parameters
[in]faction

◆ OnDelete()

override void SCR_PlayerControllerGroupComponent.OnDelete ( IEntity  owner)

◆ OnGroupChangedDelayed()

void SCR_PlayerControllerGroupComponent.OnGroupChangedDelayed ( int  groupId)
protected

◆ OnGroupDeleted()

void SCR_PlayerControllerGroupComponent.OnGroupDeleted ( SCR_AIGroup  group)
Parameters
[in]group

◆ OnPostInit()

override void SCR_PlayerControllerGroupComponent.OnPostInit ( IEntity  owner)

◆ PlayerRequestToJoinPrivateGroup()

void SCR_PlayerControllerGroupComponent.PlayerRequestToJoinPrivateGroup ( int  playerID,
RplId  groupID 
)
Parameters
[in]playerID
[in]groupID

◆ RemoveAiFromSlaveGroup()

void SCR_PlayerControllerGroupComponent.RemoveAiFromSlaveGroup ( notnull IEntity  controlledEntity,
SCR_AIGroup  group 
)

Should be only called on the server.

Parameters
[in]controlledEntity
[in]group

◆ RequestAddAIAgent()

void SCR_PlayerControllerGroupComponent.RequestAddAIAgent ( SCR_ChimeraCharacter  character,
int  playerID 
)
Parameters
[in]character
[in]playerID

◆ RequestCreateGroup()

void SCR_PlayerControllerGroupComponent.RequestCreateGroup ( )

◆ RequestCreateSlaveGroup()

void SCR_PlayerControllerGroupComponent.RequestCreateSlaveGroup ( RplId  rplCompID)
Parameters
[in]rplCompID

◆ RequestJoinGroup()

void SCR_PlayerControllerGroupComponent.RequestJoinGroup ( int  groupID)
Parameters
[in]groupID

◆ RequestKickPlayer()

void SCR_PlayerControllerGroupComponent.RequestKickPlayer ( int  playerID)
Parameters
[in]playerID

◆ RequestPrivateGroupChange()

void SCR_PlayerControllerGroupComponent.RequestPrivateGroupChange ( int  playerID,
bool  isPrivate 
)
Parameters
[in]playerID
[in]isPrivate

◆ RequestPromoteLeader()

void SCR_PlayerControllerGroupComponent.RequestPromoteLeader ( int  playerID)
Parameters
[in]playerID

◆ RequestRemoveAgent()

void SCR_PlayerControllerGroupComponent.RequestRemoveAgent ( SCR_ChimeraCharacter  character,
int  playerID 
)
Parameters
[in]character
[in]playerID

◆ RequestSetCanPlayersChangeAttributes()

void SCR_PlayerControllerGroupComponent.RequestSetCanPlayersChangeAttributes ( bool  isAllowed)
Parameters
[in]isAllowed

◆ RequestSetCustomFrequency()

void SCR_PlayerControllerGroupComponent.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
[in]groupID
[in]frequency

◆ RequestSetCustomGroupDescription()

void SCR_PlayerControllerGroupComponent.RequestSetCustomGroupDescription ( int  groupID,
string  desc 
)
Parameters
[in]groupID
[in]desc

◆ RequestSetCustomGroupName()

void SCR_PlayerControllerGroupComponent.RequestSetCustomGroupName ( int  groupID,
string  name 
)
Parameters
[in]groupID
[in]name

◆ RequestSetGroupFlag()

void SCR_PlayerControllerGroupComponent.RequestSetGroupFlag ( int  groupID,
int  flagIndex,
bool  isFromImageset 
)
Parameters
[in]groupID
[in]flagIndex
[in]isFromImageset

◆ RequestSetGroupMaxMembers()

void SCR_PlayerControllerGroupComponent.RequestSetGroupMaxMembers ( int  groupID,
int  maxMembers 
)
Parameters
[in]groupID
[in]maxMembers

◆ RequestSetNewGroupsAllowed()

void SCR_PlayerControllerGroupComponent.RequestSetNewGroupsAllowed ( bool  isAllowed)
Parameters
[in]isAllowed

◆ RPC_AskAddAIAgent()

void SCR_PlayerControllerGroupComponent.RPC_AskAddAIAgent ( RplId  characterID,
int  playerID 
)
Parameters
[in]characterID
[in]playerID

◆ RPC_AskCreateGroup()

void SCR_PlayerControllerGroupComponent.RPC_AskCreateGroup ( )

◆ RPC_AskCreateSlaveGroup()

void SCR_PlayerControllerGroupComponent.RPC_AskCreateSlaveGroup ( RplId  rplCompID)
Parameters
[in]rplCompID

◆ RPC_AskInvitePlayer()

void SCR_PlayerControllerGroupComponent.RPC_AskInvitePlayer ( int  playerID)
Parameters
[in]playerID

◆ RPC_AskJoinGroup()

void SCR_PlayerControllerGroupComponent.RPC_AskJoinGroup ( int  groupID)
Parameters
[in]groupID

◆ RPC_AskKickPlayer()

void SCR_PlayerControllerGroupComponent.RPC_AskKickPlayer ( int  playerID)
Parameters
[in]playerID

◆ RPC_AskPromoteLeader()

void SCR_PlayerControllerGroupComponent.RPC_AskPromoteLeader ( int  playerID)
Parameters
[in]playerID

◆ RPC_AskRemoveAIAgent()

void SCR_PlayerControllerGroupComponent.RPC_AskRemoveAIAgent ( RplId  characterID,
int  playerID 
)
Parameters
[in]characterID
[in]playerID

◆ RPC_AskSetCanPlayersChangeAttributes()

void SCR_PlayerControllerGroupComponent.RPC_AskSetCanPlayersChangeAttributes ( bool  isAllowed)
Parameters
[in]isAllowed

◆ RPC_AskSetCustomDescription()

void SCR_PlayerControllerGroupComponent.RPC_AskSetCustomDescription ( int  groupID,
string  desc,
int  authorID 
)
Parameters
[in]groupID
[in]desc
[in]authorID

◆ RPC_AskSetCustomName()

void SCR_PlayerControllerGroupComponent.RPC_AskSetCustomName ( int  groupID,
string  name,
int  authorID 
)
Parameters
[in]groupID
[in]name
[in]authorID

◆ RPC_AskSetFrequency()

void SCR_PlayerControllerGroupComponent.RPC_AskSetFrequency ( int  groupID,
int  frequency 
)
Parameters
[in]groupID
[in]frequency

◆ RPC_AskSetGroupFlag()

void SCR_PlayerControllerGroupComponent.RPC_AskSetGroupFlag ( int  groupID,
int  flagIndex,
bool  isFromImageset 
)
Parameters
[in]groupID
[in]flagIndex
[in]isFromImageset

◆ RPC_AskSetGroupMaxMembers()

void SCR_PlayerControllerGroupComponent.RPC_AskSetGroupMaxMembers ( int  groupID,
int  maxMembers 
)
Parameters
[in]groupID
[in]maxMembers

◆ RPC_AskSetNewGroupsAllowed()

void SCR_PlayerControllerGroupComponent.RPC_AskSetNewGroupsAllowed ( bool  isAllowed)
Parameters
[in]isAllowed

◆ RPC_CancelJoinPrivateGroup()

void SCR_PlayerControllerGroupComponent.RPC_CancelJoinPrivateGroup ( int  playerID,
int  groupID 
)
Parameters
[in]playerID
[in]groupID

◆ RPC_ChangePrivateGroup()

void SCR_PlayerControllerGroupComponent.RPC_ChangePrivateGroup ( int  playerID,
bool  isPrivate 
)
Parameters
[in]playerID
[in]isPrivate

◆ RPC_ClearAllRequesters()

void SCR_PlayerControllerGroupComponent.RPC_ClearAllRequesters ( RplId  groupID)
Parameters
[in]groupID

◆ RPC_ConfirmJoinPrivateGroup()

void SCR_PlayerControllerGroupComponent.RPC_ConfirmJoinPrivateGroup ( int  playerID,
int  groupID 
)
Parameters
[in]playerID
[in]groupID

◆ RPC_DoChangeGroupID()

void SCR_PlayerControllerGroupComponent.RPC_DoChangeGroupID ( int  groupID)
Parameters
[in]groupID

◆ RPC_DoInvitePlayer()

void SCR_PlayerControllerGroupComponent.RPC_DoInvitePlayer ( int  groupID,
int  fromPlayerID 
)
Parameters
[in]groupID
[in]fromPlayerID

◆ RPC_PlayerRequestToJoinPrivateGroup()

void SCR_PlayerControllerGroupComponent.RPC_PlayerRequestToJoinPrivateGroup ( int  playerID,
RplId  groupID 
)
Parameters
[in]playerID
[in]groupID

◆ SetGroupInviteID()

void SCR_PlayerControllerGroupComponent.SetGroupInviteID ( int  value)
Parameters
[in]value

◆ SetSelectedGroupID()

void SCR_PlayerControllerGroupComponent.SetSelectedGroupID ( int  groupID)
Parameters
[in]groupID

◆ WasAlreadyInvited()

bool SCR_PlayerControllerGroupComponent.WasAlreadyInvited ( int  playerID)
Parameters
[in]playerID
Returns

Member Data Documentation

◆ DEFAULT_COLOR

const ref Color SCR_PlayerControllerGroupComponent.DEFAULT_COLOR = new Color(0, 0, 0, 0.4)
staticprotected

◆ m_iGroupID

int SCR_PlayerControllerGroupComponent.m_iGroupID = -1
protected

◆ m_iGroupInviteFromPlayerID

int SCR_PlayerControllerGroupComponent.m_iGroupInviteFromPlayerID = -1
protected

◆ m_iGroupInviteID

int SCR_PlayerControllerGroupComponent.m_iGroupInviteID = -1
protected

◆ m_iUISelectedGroupID

int SCR_PlayerControllerGroupComponent.m_iUISelectedGroupID = -1
protected

◆ m_mPlayerInvitesToGroups

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

◆ m_OnGroupChanged

ref ScriptInvoker<int> SCR_PlayerControllerGroupComponent.m_OnGroupChanged
protected

◆ m_OnInviteAccepted

ref ScriptInvoker<int> SCR_PlayerControllerGroupComponent.m_OnInviteAccepted
protected

◆ m_OnInviteCancelled

ref ScriptInvoker<int> SCR_PlayerControllerGroupComponent.m_OnInviteCancelled
protected

◆ m_OnInviteReceived

ref ScriptInvoker<int, int> SCR_PlayerControllerGroupComponent.m_OnInviteReceived
protected

◆ m_sGroupInviteFromPlayerName

string SCR_PlayerControllerGroupComponent.m_sGroupInviteFromPlayerName
protected
The documentation for this interface was generated from the following file:
Generated by doxygen 1.9.6