Arma Reforger Explorer 1.7.0.54
Arma Reforger Code Explorer by Zeroy - Thanks to MisterOutofTime
Loading...
Searching...
No Matches
SCR_CampaignBuildingEditorComponent.c File Reference

Go to the source code of this file.

Classes

class  SCR_CampaignBuildingEditorComponentClass

Functions

ScriptInvoker GetOnProviderChanged ()
ScriptInvokerBool GetOnObstructionEventTriggered ()
void AddProviderEntityEditorComponent (notnull SCR_CampaignBuildingProviderComponent providerComponent)
void RemoveProviderEntityEditorComponent (SCR_CampaignBuildingProviderComponent providerComponent)
SCR_CampaignBuildingProviderComponent GetProviderComponent (bool getMasterProviderComponent=false)
 Return provider component of current provider.
void SetForcedProvider (SCR_CampaignBuildingProviderComponent forcedProviderComponent=null)
 Used when player initiate a building mode via user action - forced provider is an entity owning the user action.
int GetProviderEntitiesCount ()
bool IsActiveProvider (notnull SCR_CampaignBuildingProviderComponent providerComponent)
bool GetProviderResourceComponent (out SCR_ResourceComponent resourceComponent)
EEditableEntityBudget GetShownBudget ()
 Check current provider and return budget marked as a budget to be shown in UI progress bar. If more budgets are marked, the 1st one found is used.
bool GetProviderSuppliesComponent (out SCR_CampaignSuppliesComponent suppliesComponent)
SCR_FactionAffiliationComponent GetProviderFactionComponent ()
ScriptedGameTriggerEntity GetTrigger ()
void AddRemoveFactionLabel (SCR_Faction faction, bool addLabel)
ScriptedGameTriggerEntity SpawnClientTrigger ()
void EOnEditorActivate ()
 Make the area around where is possible to build composition visible for player.
bool CanBeShown (notnull SCR_EditorContentBrowserSaveStateDataUI tab)
 Check if the given tab can be shown.
bool IsViewObstructed ()
 returns true if the view should be obsctructed
bool TabContainLabel (SCR_EditorContentBrowserSaveStateDataUI tab)
 Check if the given tabUI contains any label set on provider.
bool IsProviderBase ()
 Returns true if the provider is a base.
void ToggleBuildingTool (bool mode)
void SetOnEnterEvent ()
 Set event to obstruct view when enemy character enters a building radius.
void EntityEnterTrigger (IEntity ent)
void EntityLeaveTrigger (IEntity ent)
bool CanBlockView (notnull IEntity ent)
void SetOnEntityKilled (IEntity ent)
 Set an event called when entity which can block view in Free Roam Building enters the area of Free Roam Building.
void RemoveOnEntityKilled (IEntity ent)
 Remove an event called when entity which can block view in Free Roam Building is killed / leave the area of Free Roam Building.
SCR_ECharacterRank GetUserRank ()
void EOnEditorOpenServer ()
void EOnEditorCloseServer ()
bool AssociateCompositionsToProvider (IEntity ent)
bool UnassignCompositionProvider (IEntity ent)
void EOnEditorPostActivate ()
void SendProviders_S ()
 Authority method for replicating information about currently used providers to the client who owns this editor.
void RpcDo_SyncBuildModeProviders (array< RplId > providers, RplId forcedProvider)
void EOnEditorDeactivate ()
 Hide the area of building and remove the active faction.
void OnMilitaryBaseRegistrationChanged (SCR_MilitaryBaseLogicComponent baseComponent)
void UpdateTabs ()
 Update tabs.
IEntity GetProviderEntity (bool getMasterProvider=false)
 bool getMasterProvider default false. If true, tries to search for master provider entity.
IEntity GetMasterProviderEntity ()
void SetProviderFromRplID ()
 Set a provider, loaded from RPL ID.
bool RplSave (ScriptBitWriter writer)
bool RplLoad (ScriptBitReader reader)

Variables

SCR_CampaignBuildingEditorComponentClass m_aProvidersComponents = {}
ref array< RplId > m_aProvidersRplIds = {}
SCR_ContentBrowserEditorComponent m_ContentBrowserManager
SCR_CampaignBuildingProviderComponent m_ForcedProviderComponent
bool m_bViewObstructed
ScriptedGameTriggerEntity m_BuildingAreaTrigger
ref ScriptInvoker m_OnProviderChanged
ref ScriptInvokerBool m_OnObstructionEventTriggered

Function Documentation

◆ AddProviderEntityEditorComponent()

void AddProviderEntityEditorComponent ( notnull SCR_CampaignBuildingProviderComponent providerComponent)
protected

Definition at line 40 of file SCR_CampaignBuildingEditorComponent.c.

◆ AddRemoveFactionLabel()

void AddRemoveFactionLabel ( SCR_Faction faction,
bool addLabel )
protected

Definition at line 199 of file SCR_CampaignBuildingEditorComponent.c.

◆ AssociateCompositionsToProvider()

bool AssociateCompositionsToProvider ( IEntity ent)
protected

Definition at line 565 of file SCR_CampaignBuildingEditorComponent.c.

◆ CanBeShown()

bool CanBeShown ( notnull SCR_EditorContentBrowserSaveStateDataUI tab)
protected

Check if the given tab can be shown.

Definition at line 321 of file SCR_CampaignBuildingEditorComponent.c.

◆ CanBlockView()

bool CanBlockView ( notnull IEntity ent)
protected

Check the entity can block playeres view in Free Roam Building.

Parameters
[in]ententity to evaluate

Definition at line 457 of file SCR_CampaignBuildingEditorComponent.c.

◆ EntityEnterTrigger()

void EntityEnterTrigger ( IEntity ent)
protected

Definition at line 402 of file SCR_CampaignBuildingEditorComponent.c.

◆ EntityLeaveTrigger()

void EntityLeaveTrigger ( IEntity ent)
protected
Parameters
[in]ententity removed from the trigger. Can be null when event is triggered from deleted or killed entity.

Definition at line 421 of file SCR_CampaignBuildingEditorComponent.c.

◆ EOnEditorActivate()

void EOnEditorActivate ( )
protected

Make the area around where is possible to build composition visible for player.

Definition at line 238 of file SCR_CampaignBuildingEditorComponent.c.

◆ EOnEditorCloseServer()

void EOnEditorCloseServer ( )
protected

Definition at line 544 of file SCR_CampaignBuildingEditorComponent.c.

◆ EOnEditorDeactivate()

void EOnEditorDeactivate ( )
protected

Hide the area of building and remove the active faction.

Definition at line 685 of file SCR_CampaignBuildingEditorComponent.c.

◆ EOnEditorOpenServer()

void EOnEditorOpenServer ( )
protected

Definition at line 523 of file SCR_CampaignBuildingEditorComponent.c.

◆ EOnEditorPostActivate()

void EOnEditorPostActivate ( )
protected

Definition at line 600 of file SCR_CampaignBuildingEditorComponent.c.

◆ GetMasterProviderEntity()

IEntity GetMasterProviderEntity ( )
protected

Return the HQ entity of the base to which the current provider can be registered to. For an example provider is a living area but this one is registered to a base so the base entity is returned. If the living area is standalone, the entity of living area is returned.

Definition at line 779 of file SCR_CampaignBuildingEditorComponent.c.

◆ GetOnObstructionEventTriggered()

ScriptInvokerBool GetOnObstructionEventTriggered ( )
protected

Definition at line 31 of file SCR_CampaignBuildingEditorComponent.c.

◆ GetOnProviderChanged()

ScriptInvoker GetOnProviderChanged ( )
protected

Definition at line 22 of file SCR_CampaignBuildingEditorComponent.c.

◆ GetProviderComponent()

SCR_CampaignBuildingProviderComponent GetProviderComponent ( bool getMasterProviderComponent = false)
protected

Return provider component of current provider.

Definition at line 68 of file SCR_CampaignBuildingEditorComponent.c.

◆ GetProviderEntitiesCount()

int GetProviderEntitiesCount ( )
protected

Definition at line 93 of file SCR_CampaignBuildingEditorComponent.c.

◆ GetProviderEntity()

IEntity GetProviderEntity ( bool getMasterProvider = false)
protected

bool getMasterProvider default false. If true, tries to search for master provider entity.

Definition at line 764 of file SCR_CampaignBuildingEditorComponent.c.

◆ GetProviderFactionComponent()

SCR_FactionAffiliationComponent GetProviderFactionComponent ( )
protected

Definition at line 172 of file SCR_CampaignBuildingEditorComponent.c.

◆ GetProviderResourceComponent()

bool GetProviderResourceComponent ( out SCR_ResourceComponent resourceComponent)
protected

Definition at line 115 of file SCR_CampaignBuildingEditorComponent.c.

◆ GetProviderSuppliesComponent()

bool GetProviderSuppliesComponent ( out SCR_CampaignSuppliesComponent suppliesComponent)
protected

Definition at line 153 of file SCR_CampaignBuildingEditorComponent.c.

◆ GetShownBudget()

EEditableEntityBudget GetShownBudget ( )
protected

Check current provider and return budget marked as a budget to be shown in UI progress bar. If more budgets are marked, the 1st one found is used.

Definition at line 142 of file SCR_CampaignBuildingEditorComponent.c.

◆ GetTrigger()

ScriptedGameTriggerEntity GetTrigger ( )
protected

Definition at line 192 of file SCR_CampaignBuildingEditorComponent.c.

◆ GetUserRank()

SCR_ECharacterRank GetUserRank ( )
protected

Definition at line 511 of file SCR_CampaignBuildingEditorComponent.c.

◆ IsActiveProvider()

bool IsActiveProvider ( notnull SCR_CampaignBuildingProviderComponent providerComponent)
protected

Definition at line 99 of file SCR_CampaignBuildingEditorComponent.c.

◆ IsProviderBase()

bool IsProviderBase ( )
protected

Returns true if the provider is a base.

Definition at line 359 of file SCR_CampaignBuildingEditorComponent.c.

◆ IsViewObstructed()

bool IsViewObstructed ( )
protected

returns true if the view should be obsctructed

Definition at line 331 of file SCR_CampaignBuildingEditorComponent.c.

◆ OnMilitaryBaseRegistrationChanged()

void OnMilitaryBaseRegistrationChanged ( SCR_MilitaryBaseLogicComponent baseComponent)
protected

Definition at line 730 of file SCR_CampaignBuildingEditorComponent.c.

◆ RemoveOnEntityKilled()

void RemoveOnEntityKilled ( IEntity ent)
protected

Remove an event called when entity which can block view in Free Roam Building is killed / leave the area of Free Roam Building.

Definition at line 500 of file SCR_CampaignBuildingEditorComponent.c.

◆ RemoveProviderEntityEditorComponent()

void RemoveProviderEntityEditorComponent ( SCR_CampaignBuildingProviderComponent providerComponent)
protected

Definition at line 55 of file SCR_CampaignBuildingEditorComponent.c.

◆ RpcDo_SyncBuildModeProviders()

void RpcDo_SyncBuildModeProviders ( array< RplId > providers,
RplId forcedProvider )
protected

Definition at line 651 of file SCR_CampaignBuildingEditorComponent.c.

◆ RplLoad()

bool RplLoad ( ScriptBitReader reader)
protected

Definition at line 863 of file SCR_CampaignBuildingEditorComponent.c.

◆ RplSave()

bool RplSave ( ScriptBitWriter writer)
protected

Definition at line 824 of file SCR_CampaignBuildingEditorComponent.c.

◆ SendProviders_S()

void SendProviders_S ( )
protected

Authority method for replicating information about currently used providers to the client who owns this editor.

Definition at line 615 of file SCR_CampaignBuildingEditorComponent.c.

◆ SetForcedProvider()

void SetForcedProvider ( SCR_CampaignBuildingProviderComponent forcedProviderComponent = null)
protected

Used when player initiate a building mode via user action - forced provider is an entity owning the user action.

Definition at line 87 of file SCR_CampaignBuildingEditorComponent.c.

◆ SetOnEnterEvent()

void SetOnEnterEvent ( )
protected

Set event to obstruct view when enemy character enters a building radius.

Definition at line 391 of file SCR_CampaignBuildingEditorComponent.c.

◆ SetOnEntityKilled()

void SetOnEntityKilled ( IEntity ent)
protected

Set an event called when entity which can block view in Free Roam Building enters the area of Free Roam Building.

Definition at line 488 of file SCR_CampaignBuildingEditorComponent.c.

◆ SetProviderFromRplID()

void SetProviderFromRplID ( )
protected

Set a provider, loaded from RPL ID.

Definition at line 790 of file SCR_CampaignBuildingEditorComponent.c.

◆ SpawnClientTrigger()

ScriptedGameTriggerEntity SpawnClientTrigger ( )
protected

Definition at line 208 of file SCR_CampaignBuildingEditorComponent.c.

◆ TabContainLabel()

bool TabContainLabel ( SCR_EditorContentBrowserSaveStateDataUI tab)
protected

Check if the given tabUI contains any label set on provider.

Definition at line 338 of file SCR_CampaignBuildingEditorComponent.c.

◆ ToggleBuildingTool()

void ToggleBuildingTool ( bool mode)
protected

Definition at line 369 of file SCR_CampaignBuildingEditorComponent.c.

◆ UnassignCompositionProvider()

bool UnassignCompositionProvider ( IEntity ent)
protected

Definition at line 583 of file SCR_CampaignBuildingEditorComponent.c.

◆ UpdateTabs()

void UpdateTabs ( )
protected

Update tabs.

Definition at line 741 of file SCR_CampaignBuildingEditorComponent.c.

Variable Documentation

◆ m_aProvidersComponents

SCR_CampaignBuildingEditorComponentClass m_aProvidersComponents = {}

◆ m_aProvidersRplIds

ref array<RplId> m_aProvidersRplIds = {}
protected

Definition at line 12 of file SCR_CampaignBuildingEditorComponent.c.

◆ m_BuildingAreaTrigger

ScriptedGameTriggerEntity m_BuildingAreaTrigger
protected

Definition at line 16 of file SCR_CampaignBuildingEditorComponent.c.

◆ m_bViewObstructed

bool m_bViewObstructed
protected

Definition at line 15 of file SCR_CampaignBuildingEditorComponent.c.

◆ m_ContentBrowserManager

SCR_ContentBrowserEditorComponent m_ContentBrowserManager
protected

Definition at line 13 of file SCR_CampaignBuildingEditorComponent.c.

◆ m_ForcedProviderComponent

SCR_CampaignBuildingProviderComponent m_ForcedProviderComponent
protected

Definition at line 14 of file SCR_CampaignBuildingEditorComponent.c.

◆ m_OnObstructionEventTriggered

ref ScriptInvokerBool m_OnObstructionEventTriggered
protected

Definition at line 19 of file SCR_CampaignBuildingEditorComponent.c.

◆ m_OnProviderChanged

ref ScriptInvoker m_OnProviderChanged
protected

Definition at line 18 of file SCR_CampaignBuildingEditorComponent.c.