|
Arma Reforger Script API
|
Public Member Functions | |
| int | GetGroupID () |
| void | RequestCreateGroup () |
| void | RequestCreateGroupWithData (SCR_EGroupRole groupRole, bool isPrivate, string name, string description, bool joinGroup=true, bool deleteIfNoPlayer=true) |
| Request server to create new group with specific groupRole. | |
| 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 | CanPlayerRemoveGroup (int playerID, notnull SCR_AIGroup group) |
| Can player remove 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 | RpcAsk_CreateGroupWithData (SCR_EGroupRole groupRole, bool isPrivate, string name, string description, bool joinGroup, bool deleteIfNoPlayer) |
| 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) |
| void | RequestRemoveGroup (int groupID) |
| Remove group. | |
| void | RpcAsk_RemoveGroup (int groupID) |
| Ask the server to remove a group. | |
| bool | InitiateComponents (int playerID, out SCR_GroupsManagerComponent groupsManager, out SCR_PlayerControllerGroupComponent playerGroupController, out SCR_AIGroup group) |
| int | GetSelectedGroupID () |
| ScriptInvoker | GetOnInviteAccepted () |
| ScriptInvoker | GetOnGroupChanged () |
| ScriptInvoker | GetOnInviteCancelled () |
| ScriptInvokerInt | GetOnSetSelectedGroupID () |
| int | GetGroupInviteID () |
| void | SetGroupInviteID (int value) |
| int | GetGroupInviteFromPlayerID () |
| int | GetPreviousGroupID () |
| 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) |
| void | RequestGroupLeaderVote (int playerID) |
| void | SetGroupLeader (int playerID) |
| void | SetRallyPoint (notnull SCR_MilitaryBaseComponent base, bool force) |
| void | RemoveRallyPoint () |
| void | SetTransportUnitSourceBase (notnull SCR_TransportUnitComponent transportUnit, SCR_CampaignMilitaryBaseComponent base) |
| 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) |
| void | SetCustomNameAndDescription (SCR_AIGroup group, string name, string description, int playerId) |
| void | RpcDo_SetGroupLeader (int playerID) |
| void | RpcAsk_SetRallyPoint (int playerID, int callsignId, bool force) |
| void | RpcAsk_RemoveRallyPoint (int playerID) |
| void | RpcDo_AskSetTransportUnitSourceBase (int baseCallsign, RplId rplIdTransportUnitComponent) |
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 |
| ref ScriptInvokerInt | m_OnSetSelectedGroupID |
| int | m_iUISelectedGroupID = -1 |
| int | m_iGroupInviteID = -1 |
| int | m_iGroupInviteFromPlayerID = -1 |
| int | m_iPreviousGroupID = -1 |
| string | m_sGroupInviteFromPlayerName |
Static Protected Attributes | |
| static const ref Color | DEFAULT_COLOR = new Color(0, 0, 0, 0.4) |
| void SCR_PlayerControllerGroupComponent.AcceptInvite | ( | ) |
| void SCR_PlayerControllerGroupComponent.AcceptJoinPrivateGroup | ( | int | playerID, |
| bool | accept ) |
| [in] | playerID | |
| [in] | accept |
| void SCR_PlayerControllerGroupComponent.AddAIToSlaveGroup | ( | notnull IEntity | controlledEntity, |
| SCR_AIGroup | group ) |
Should be only called on the server.
| [in] | controlledEntity | |
| [in] | group |
| bool SCR_PlayerControllerGroupComponent.CanInvitePlayer | ( | int | playerID | ) |
| [in] | playerID |
| bool SCR_PlayerControllerGroupComponent.CanPlayerJoinGroup | ( | int | playerID, |
| notnull SCR_AIGroup | group ) |
| [in] | playerID | |
| [in] | group |
| bool SCR_PlayerControllerGroupComponent.CanPlayerRemoveGroup | ( | int | playerID, |
| notnull SCR_AIGroup | group ) |
Can player remove group.
| [in] | playerID | |
| [in] | group |
| void SCR_PlayerControllerGroupComponent.ClearAllRequesters | ( | RplId | groupID | ) |
| [in] | groupID |
| void SCR_PlayerControllerGroupComponent.CreateAndJoinGroup | ( | Faction | faction | ) |
| [in] | faction |
| override void SCR_PlayerControllerGroupComponent.EOnDiag | ( | IEntity | owner, |
| float | timeSlice ) |
| int SCR_PlayerControllerGroupComponent.GetActualGroupFrequency | ( | ) |
| int SCR_PlayerControllerGroupComponent.GetGroupID | ( | ) |
| int SCR_PlayerControllerGroupComponent.GetGroupInviteFromPlayerID | ( | ) |
| string SCR_PlayerControllerGroupComponent.GetGroupInviteFromPlayerName | ( | ) |
| int SCR_PlayerControllerGroupComponent.GetGroupInviteID | ( | ) |
|
static |
| ScriptInvoker SCR_PlayerControllerGroupComponent.GetOnGroupChanged | ( | ) |
| ScriptInvoker SCR_PlayerControllerGroupComponent.GetOnInviteAccepted | ( | ) |
| ScriptInvoker SCR_PlayerControllerGroupComponent.GetOnInviteCancelled | ( | ) |
| ScriptInvoker SCR_PlayerControllerGroupComponent.GetOnInviteReceived | ( | ) |
| ScriptInvokerInt SCR_PlayerControllerGroupComponent.GetOnSetSelectedGroupID | ( | ) |
|
static |
| [in] | playerID |
| int SCR_PlayerControllerGroupComponent.GetPlayerID | ( | ) |
| SCR_AIGroup SCR_PlayerControllerGroupComponent.GetPlayersGroup | ( | ) |
| int SCR_PlayerControllerGroupComponent.GetPreviousGroupID | ( | ) |
| int SCR_PlayerControllerGroupComponent.GetSelectedGroupID | ( | ) |
| bool SCR_PlayerControllerGroupComponent.InitiateComponents | ( | int | playerID, |
| out SCR_GroupsManagerComponent | groupsManager, | ||
| out SCR_PlayerControllerGroupComponent | playerGroupController, | ||
| out SCR_AIGroup | group ) |
| [in] | playerID | |
| [out] | groupsManager | |
| [out] | playerGroupController | |
| [out] | group |
| void SCR_PlayerControllerGroupComponent.InvitePlayer | ( | int | playerID | ) |
| [in] | playerID |
| void SCR_PlayerControllerGroupComponent.InviteThisPlayer | ( | int | groupID, |
| int | fromPlayerID ) |
| [in] | groupID | |
| [in] | fromPlayerID |
| bool SCR_PlayerControllerGroupComponent.IsAICharacterInAnyGroup | ( | SCR_ChimeraCharacter | character, |
| SCR_Faction | faction ) |
| [in] | character | |
| [in] | faction |
| bool SCR_PlayerControllerGroupComponent.IsPlayerLeader | ( | int | playerID, |
| notnull SCR_AIGroup | group ) |
| [in] | playerID | |
| [in] | group |
| bool SCR_PlayerControllerGroupComponent.IsPlayerLeaderOwnGroup | ( | ) |
| void SCR_PlayerControllerGroupComponent.ListGroupsFromFaction | ( | Faction | faction | ) |
| [in] | faction |
| override void SCR_PlayerControllerGroupComponent.OnDelete | ( | IEntity | owner | ) |
|
protected |
| void SCR_PlayerControllerGroupComponent.OnGroupDeleted | ( | SCR_AIGroup | group | ) |
| [in] | group |
| override void SCR_PlayerControllerGroupComponent.OnPostInit | ( | IEntity | owner | ) |
| void SCR_PlayerControllerGroupComponent.PlayerRequestToJoinPrivateGroup | ( | int | playerID, |
| RplId | groupID ) |
| [in] | playerID | |
| [in] | groupID |
| void SCR_PlayerControllerGroupComponent.RemoveAiFromSlaveGroup | ( | notnull IEntity | controlledEntity, |
| SCR_AIGroup | group ) |
Should be only called on the server.
| [in] | controlledEntity | |
| [in] | group |
| void SCR_PlayerControllerGroupComponent.RemoveRallyPoint | ( | ) |
| void SCR_PlayerControllerGroupComponent.RequestAddAIAgent | ( | SCR_ChimeraCharacter | character, |
| int | playerID ) |
| [in] | character | |
| [in] | playerID |
| void SCR_PlayerControllerGroupComponent.RequestCreateGroup | ( | ) |
| void SCR_PlayerControllerGroupComponent.RequestCreateGroupWithData | ( | SCR_EGroupRole | groupRole, |
| bool | isPrivate, | ||
| string | name, | ||
| string | description, | ||
| bool | joinGroup = true, | ||
| bool | deleteIfNoPlayer = true ) |
Request server to create new group with specific groupRole.
| [in] | groupRole | |
| [in] | isPrivate | |
| [in] | name | |
| [in] | description | |
| [in] | joinGroup | |
| [in] | deleteIfNoPlayer |
| void SCR_PlayerControllerGroupComponent.RequestCreateSlaveGroup | ( | RplId | rplCompID | ) |
| [in] | rplCompID |
| void SCR_PlayerControllerGroupComponent.RequestGroupLeaderVote | ( | int | playerID | ) |
| void SCR_PlayerControllerGroupComponent.RequestJoinGroup | ( | int | groupID | ) |
| [in] | groupID |
| void SCR_PlayerControllerGroupComponent.RequestKickPlayer | ( | int | playerID | ) |
| [in] | playerID |
| void SCR_PlayerControllerGroupComponent.RequestPrivateGroupChange | ( | int | playerID, |
| bool | isPrivate ) |
| [in] | playerID | |
| [in] | isPrivate |
| void SCR_PlayerControllerGroupComponent.RequestPromoteLeader | ( | int | playerID | ) |
| [in] | playerID |
| void SCR_PlayerControllerGroupComponent.RequestRemoveAgent | ( | SCR_ChimeraCharacter | character, |
| int | playerID ) |
| [in] | character | |
| [in] | playerID |
| void SCR_PlayerControllerGroupComponent.RequestRemoveGroup | ( | int | groupID | ) |
Remove group.
| [in] | groupID |
| void SCR_PlayerControllerGroupComponent.RequestSetCanPlayersChangeAttributes | ( | bool | isAllowed | ) |
| [in] | isAllowed |
| 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.
| [in] | groupID | |
| [in] | frequency |
| void SCR_PlayerControllerGroupComponent.RequestSetCustomGroupDescription | ( | int | groupID, |
| string | desc ) |
| [in] | groupID | |
| [in] | desc |
| void SCR_PlayerControllerGroupComponent.RequestSetCustomGroupName | ( | int | groupID, |
| string | name ) |
| [in] | groupID | |
| [in] | name |
| void SCR_PlayerControllerGroupComponent.RequestSetGroupFlag | ( | int | groupID, |
| int | flagIndex, | ||
| bool | isFromImageset ) |
| [in] | groupID | |
| [in] | flagIndex | |
| [in] | isFromImageset |
| void SCR_PlayerControllerGroupComponent.RequestSetGroupMaxMembers | ( | int | groupID, |
| int | maxMembers ) |
| [in] | groupID | |
| [in] | maxMembers |
| void SCR_PlayerControllerGroupComponent.RequestSetNewGroupsAllowed | ( | bool | isAllowed | ) |
| [in] | isAllowed |
| void SCR_PlayerControllerGroupComponent.RPC_AskAddAIAgent | ( | RplId | characterID, |
| int | playerID ) |
| [in] | characterID | |
| [in] | playerID |
| void SCR_PlayerControllerGroupComponent.RPC_AskCreateGroup | ( | ) |
| void SCR_PlayerControllerGroupComponent.RPC_AskCreateSlaveGroup | ( | RplId | rplCompID | ) |
| [in] | rplCompID |
| void SCR_PlayerControllerGroupComponent.RPC_AskInvitePlayer | ( | int | playerID | ) |
| [in] | playerID |
| void SCR_PlayerControllerGroupComponent.RPC_AskJoinGroup | ( | int | groupID | ) |
| [in] | groupID |
| void SCR_PlayerControllerGroupComponent.RPC_AskKickPlayer | ( | int | playerID | ) |
| [in] | playerID |
| void SCR_PlayerControllerGroupComponent.RPC_AskPromoteLeader | ( | int | playerID | ) |
| [in] | playerID |
| void SCR_PlayerControllerGroupComponent.RPC_AskRemoveAIAgent | ( | RplId | characterID, |
| int | playerID ) |
| [in] | characterID | |
| [in] | playerID |
| void SCR_PlayerControllerGroupComponent.RPC_AskSetCanPlayersChangeAttributes | ( | bool | isAllowed | ) |
| [in] | isAllowed |
| void SCR_PlayerControllerGroupComponent.RPC_AskSetCustomDescription | ( | int | groupID, |
| string | desc, | ||
| int | authorID ) |
| [in] | groupID | |
| [in] | desc | |
| [in] | authorID |
| void SCR_PlayerControllerGroupComponent.RPC_AskSetCustomName | ( | int | groupID, |
| string | name, | ||
| int | authorID ) |
| [in] | groupID | |
| [in] | name | |
| [in] | authorID |
| void SCR_PlayerControllerGroupComponent.RPC_AskSetFrequency | ( | int | groupID, |
| int | frequency ) |
| [in] | groupID | |
| [in] | frequency |
| void SCR_PlayerControllerGroupComponent.RPC_AskSetGroupFlag | ( | int | groupID, |
| int | flagIndex, | ||
| bool | isFromImageset ) |
| [in] | groupID | |
| [in] | flagIndex | |
| [in] | isFromImageset |
| void SCR_PlayerControllerGroupComponent.RPC_AskSetGroupMaxMembers | ( | int | groupID, |
| int | maxMembers ) |
| [in] | groupID | |
| [in] | maxMembers |
| void SCR_PlayerControllerGroupComponent.RPC_AskSetNewGroupsAllowed | ( | bool | isAllowed | ) |
| [in] | isAllowed |
| void SCR_PlayerControllerGroupComponent.RPC_CancelJoinPrivateGroup | ( | int | playerID, |
| int | groupID ) |
| [in] | playerID | |
| [in] | groupID |
| void SCR_PlayerControllerGroupComponent.RPC_ChangePrivateGroup | ( | int | playerID, |
| bool | isPrivate ) |
| [in] | playerID | |
| [in] | isPrivate |
| void SCR_PlayerControllerGroupComponent.RPC_ClearAllRequesters | ( | RplId | groupID | ) |
| [in] | groupID |
| void SCR_PlayerControllerGroupComponent.RPC_ConfirmJoinPrivateGroup | ( | int | playerID, |
| int | groupID ) |
| [in] | playerID | |
| [in] | groupID |
| void SCR_PlayerControllerGroupComponent.RPC_DoChangeGroupID | ( | int | groupID | ) |
| [in] | groupID |
| void SCR_PlayerControllerGroupComponent.RPC_DoInvitePlayer | ( | int | groupID, |
| int | fromPlayerID ) |
| [in] | groupID | |
| [in] | fromPlayerID |
| void SCR_PlayerControllerGroupComponent.RPC_PlayerRequestToJoinPrivateGroup | ( | int | playerID, |
| RplId | groupID ) |
| [in] | playerID | |
| [in] | groupID |
| void SCR_PlayerControllerGroupComponent.RpcAsk_CreateGroupWithData | ( | SCR_EGroupRole | groupRole, |
| bool | isPrivate, | ||
| string | name, | ||
| string | description, | ||
| bool | joinGroup, | ||
| bool | deleteIfNoPlayer ) |
| void SCR_PlayerControllerGroupComponent.RpcAsk_RemoveGroup | ( | int | groupID | ) |
Ask the server to remove a group.
| [in] | groupID |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
| void SCR_PlayerControllerGroupComponent.SetGroupInviteID | ( | int | value | ) |
| [in] | value |
| void SCR_PlayerControllerGroupComponent.SetGroupLeader | ( | int | playerID | ) |
| void SCR_PlayerControllerGroupComponent.SetRallyPoint | ( | notnull SCR_MilitaryBaseComponent | base, |
| bool | force ) |
| void SCR_PlayerControllerGroupComponent.SetSelectedGroupID | ( | int | groupID | ) |
| [in] | groupID |
| void SCR_PlayerControllerGroupComponent.SetTransportUnitSourceBase | ( | notnull SCR_TransportUnitComponent | transportUnit, |
| SCR_CampaignMilitaryBaseComponent | base ) |
| bool SCR_PlayerControllerGroupComponent.WasAlreadyInvited | ( | int | playerID | ) |
| [in] | playerID |
|
staticprotected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |