Arma Reforger Script API
Loading...
Searching...
No Matches
SCR_CampaignBuildingNetworkComponent Interface Reference
Inheritance diagram for SCR_CampaignBuildingNetworkComponent:

Public Member Functions

void AddBuildingValue (int buildingValue, notnull IEntity compositionOutline)
 
void RemoveEditorMode (int playerID, IEntity provider)
 
void RequestEnterBuildingMode (IEntity provider, int playerID, bool UserActionActivationOnly, bool UserActionUsed)
 
void DeleteCompositionByUserAction (notnull IEntity composition)
 Delete composition by a tool.
 
void SendDeleteNotification (notnull IEntity composition, int playerId, int callsign)
 Send a notification about deleted composition.
 
void SetClientLock (bool lock, IEntity provider)
 
void AddXPReward (int playerId)
 
IEntity GetProviderFormRplId (RplId rplProviderId)
 

Protected Member Functions

void RpcDo_SetClientLock (bool lock, RplId compId)
 Set a cooldown lock on client.
 
void RpcAsk_AddBuildingValue (int buildingValue, RplId compId)
 Add a building value to a composition outline.
 
void RpcAsk_RemoveEditorMode (int playerID, RplId compId)
 Delete given player building mode.
 
void RpcAsk_RequestEnterBuildingMode (RplId rplProviderId, int playerID, bool UserActionActivationOnly, bool UserActionUsed)
 Spawn a trigger as a child of the provider entity.
 
void RpcAsk_DeleteCompositionByUserAction (RplId rplCompositionId)
 Delete composition, executed from user action.
 
void RpcAsk_SendDeleteNotification (RplId rplCompositionId, int playerId, int callsign)
 Send delete notification.
 
void RpcAsk_AddXPReward (int playerId)
 Increase XP.
 

Member Function Documentation

◆ AddBuildingValue()

void SCR_CampaignBuildingNetworkComponent.AddBuildingValue ( int buildingValue,
notnull IEntity compositionOutline )
Parameters
[in]buildingValue
[in]compositionOutline

◆ AddXPReward()

void SCR_CampaignBuildingNetworkComponent.AddXPReward ( int playerId)
Parameters
[in]playerId

◆ DeleteCompositionByUserAction()

void SCR_CampaignBuildingNetworkComponent.DeleteCompositionByUserAction ( notnull IEntity composition)

Delete composition by a tool.

Parameters
[in]composition

◆ GetProviderFormRplId()

IEntity SCR_CampaignBuildingNetworkComponent.GetProviderFormRplId ( RplId rplProviderId)
Parameters
[in]rplProviderId
Returns

◆ RemoveEditorMode()

void SCR_CampaignBuildingNetworkComponent.RemoveEditorMode ( int playerID,
IEntity provider )
Parameters
[in]playerID
[in]provider

◆ RequestEnterBuildingMode()

void SCR_CampaignBuildingNetworkComponent.RequestEnterBuildingMode ( IEntity provider,
int playerID,
bool UserActionActivationOnly,
bool UserActionUsed )
Parameters
[in]provider
[in]playerID
[in]UserActionActivationOnly
[in]UserActionUsed

◆ RpcAsk_AddBuildingValue()

void SCR_CampaignBuildingNetworkComponent.RpcAsk_AddBuildingValue ( int buildingValue,
RplId compId )
protected

Add a building value to a composition outline.

Once the define value is reach, composition will be spawned.

Parameters
[in]buildingValue
[in]compId

◆ RpcAsk_AddXPReward()

void SCR_CampaignBuildingNetworkComponent.RpcAsk_AddXPReward ( int playerId)
protected

Increase XP.

Parameters
[in]playerId

◆ RpcAsk_DeleteCompositionByUserAction()

void SCR_CampaignBuildingNetworkComponent.RpcAsk_DeleteCompositionByUserAction ( RplId rplCompositionId)
protected

Delete composition, executed from user action.

Parameters
[in]rplCompositionId

◆ RpcAsk_RemoveEditorMode()

void SCR_CampaignBuildingNetworkComponent.RpcAsk_RemoveEditorMode ( int playerID,
RplId compId )
protected

Delete given player building mode.

Parameters
[in]playerID
[in]compId

◆ RpcAsk_RequestEnterBuildingMode()

void SCR_CampaignBuildingNetworkComponent.RpcAsk_RequestEnterBuildingMode ( RplId rplProviderId,
int playerID,
bool UserActionActivationOnly,
bool UserActionUsed )
protected

Spawn a trigger as a child of the provider entity.

Parameters
[in]rplProviderId
[in]playerID
[in]UserActionActivationOnly
[in]UserActionUse

◆ RpcAsk_SendDeleteNotification()

void SCR_CampaignBuildingNetworkComponent.RpcAsk_SendDeleteNotification ( RplId rplCompositionId,
int playerId,
int callsign )
protected

Send delete notification.

Parameters
[in]rplCompositionId
[in]playerId
[in]callsign

◆ RpcDo_SetClientLock()

void SCR_CampaignBuildingNetworkComponent.RpcDo_SetClientLock ( bool lock,
RplId compId )
protected

Set a cooldown lock on client.

◆ SendDeleteNotification()

void SCR_CampaignBuildingNetworkComponent.SendDeleteNotification ( notnull IEntity composition,
int playerId,
int callsign )

Send a notification about deleted composition.

Parameters
[in]composition
[in]playerId
[in]callsign

◆ SetClientLock()

void SCR_CampaignBuildingNetworkComponent.SetClientLock ( bool lock,
IEntity provider )

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