Arma Reforger Explorer  1.1.0.42
Arma Reforger Code Explorer by Zeroy - Thanks to MisterOutofTime
Data Structures | Functions | Variables
SCR_CampaignBuildingEditorComponent.c File Reference

Go to the source code of this file.

Data Structures

class  SCR_CampaignBuildingEditorComponentClass
 

Functions

ScriptInvoker GetOnProviderChanged ()
 
ScriptInvokerBool GetOnObstructionEventTriggered ()
 
void AddProviderEntityEditorComponent (SCR_CampaignBuildingProviderComponent providerComponent)
 
void RemoveProviderEntityEditorComponent (SCR_CampaignBuildingProviderComponent providerComponent)
 
SCR_CampaignBuildingProviderComponent GetProviderComponent (bool getMasterProviderComponent=false)
 Return provider component of current provider. More...
 
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. More...
 
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. More...
 
bool GetProviderSuppliesComponent (out SCR_CampaignSuppliesComponent suppliesComponent)
 
SCR_FactionAffiliationComponent GetProviderFactionComponent ()
 
SCR_FreeRoamBuildingClientTriggerEntity GetTrigger ()
 
protected void AddRemoveFactionLabel (SCR_Faction faction, bool addLabel)
 
ScriptedGameTriggerEntity SpawnClientTrigger ()
 
override protected void EOnEditorActivate ()
 Make the area around where is possible to build composition visible for player. More...
 
bool CanBeShown (notnull SCR_EditorContentBrowserSaveStateDataUI tab)
 Check if the given tab can be shown. More...
 
bool TabContainLabel (SCR_EditorContentBrowserSaveStateDataUI tab)
 Check if the given tabUI contains any label set on provider. More...
 
bool IsProviderBase ()
 Returns true if the provider is a base. More...
 
void ToggleBuildingTool (bool mode)
 
protected void SetOnEnterEvent ()
 Set event to obstruct view when enemy character enters a building radius. More...
 
protected void EntityEnterTrigger (IEntity ent)
 
protected void EntityLeaveTrigger (IEntity ent)
 
protected 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. More...
 
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. More...
 
SCR_ECharacterRank GetUserRank ()
 
override protected void EOnEditorOpenServer ()
 
override protected void EOnEditorCloseServer ()
 
bool AssociateCompositionsToProvider (IEntity ent)
 
bool UnassignCompositionProvider (IEntity ent)
 
override protected void EOnEditorDeactivate ()
 Hide the area of building and remove the active faction. More...
 
IEntity GetProviderEntity (bool getMasterProvider=false)
 bool getMasterProvider default false. If true, tries to search for master provider entity. More...
 
IEntity GetMasterProviderEntity ()
 
void SetProviderFromRplID ()
 Set a provider, loaded from RPL ID. More...
 
override protected bool RplSave (ScriptBitWriter writer)
 
override protected bool RplLoad (ScriptBitReader reader)
 

Variables

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

Function Documentation

◆ AddProviderEntityEditorComponent()

void AddProviderEntityEditorComponent ( SCR_CampaignBuildingProviderComponent  providerComponent)

Definition at line 39 of file SCR_CampaignBuildingEditorComponent.c.

◆ AddRemoveFactionLabel()

protected void AddRemoveFactionLabel ( SCR_Faction  faction,
bool  addLabel 
)

Definition at line 226 of file SCR_CampaignBuildingEditorComponent.c.

◆ AssociateCompositionsToProvider()

bool AssociateCompositionsToProvider ( IEntity  ent)

Definition at line 559 of file SCR_CampaignBuildingEditorComponent.c.

◆ CanBeShown()

bool CanBeShown ( notnull SCR_EditorContentBrowserSaveStateDataUI  tab)

Check if the given tab can be shown.

Definition at line 326 of file SCR_CampaignBuildingEditorComponent.c.

◆ CanBlockView()

protected bool CanBlockView ( notnull IEntity  ent)

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

Parameters
[in]ententity to evaluate

Definition at line 453 of file SCR_CampaignBuildingEditorComponent.c.

◆ EntityEnterTrigger()

protected void EntityEnterTrigger ( IEntity  ent)

Definition at line 398 of file SCR_CampaignBuildingEditorComponent.c.

◆ EntityLeaveTrigger()

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

Definition at line 417 of file SCR_CampaignBuildingEditorComponent.c.

◆ EOnEditorActivate()

override protected void EOnEditorActivate ( )

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

Definition at line 264 of file SCR_CampaignBuildingEditorComponent.c.

◆ EOnEditorCloseServer()

override protected void EOnEditorCloseServer ( )

Definition at line 539 of file SCR_CampaignBuildingEditorComponent.c.

◆ EOnEditorDeactivate()

override protected void EOnEditorDeactivate ( )

Hide the area of building and remove the active faction.

Definition at line 595 of file SCR_CampaignBuildingEditorComponent.c.

◆ EOnEditorOpenServer()

override protected void EOnEditorOpenServer ( )

Definition at line 519 of file SCR_CampaignBuildingEditorComponent.c.

◆ GetMasterProviderEntity()

IEntity GetMasterProviderEntity ( )

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 635 of file SCR_CampaignBuildingEditorComponent.c.

◆ GetOnObstructionEventTriggered()

ScriptInvokerBool GetOnObstructionEventTriggered ( )

Definition at line 30 of file SCR_CampaignBuildingEditorComponent.c.

◆ GetOnProviderChanged()

ScriptInvoker GetOnProviderChanged ( )

Definition at line 21 of file SCR_CampaignBuildingEditorComponent.c.

◆ GetProviderComponent()

SCR_CampaignBuildingProviderComponent GetProviderComponent ( bool  getMasterProviderComponent = false)

Return provider component of current provider.

Definition at line 67 of file SCR_CampaignBuildingEditorComponent.c.

◆ GetProviderEntitiesCount()

int GetProviderEntitiesCount ( )

Definition at line 92 of file SCR_CampaignBuildingEditorComponent.c.

◆ GetProviderEntity()

IEntity GetProviderEntity ( bool  getMasterProvider = false)

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

Definition at line 620 of file SCR_CampaignBuildingEditorComponent.c.

◆ GetProviderFactionComponent()

SCR_FactionAffiliationComponent GetProviderFactionComponent ( )

Definition at line 174 of file SCR_CampaignBuildingEditorComponent.c.

◆ GetProviderResourceComponent()

bool GetProviderResourceComponent ( out SCR_ResourceComponent  resourceComponent)

Definition at line 114 of file SCR_CampaignBuildingEditorComponent.c.

◆ GetProviderSuppliesComponent()

bool GetProviderSuppliesComponent ( out SCR_CampaignSuppliesComponent  suppliesComponent)

Definition at line 152 of file SCR_CampaignBuildingEditorComponent.c.

◆ GetShownBudget()

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.

Definition at line 141 of file SCR_CampaignBuildingEditorComponent.c.

◆ GetTrigger()

SCR_FreeRoamBuildingClientTriggerEntity GetTrigger ( )

Definition at line 197 of file SCR_CampaignBuildingEditorComponent.c.

◆ GetUserRank()

SCR_ECharacterRank GetUserRank ( )

Definition at line 507 of file SCR_CampaignBuildingEditorComponent.c.

◆ IsActiveProvider()

bool IsActiveProvider ( notnull SCR_CampaignBuildingProviderComponent  providerComponent)

Definition at line 98 of file SCR_CampaignBuildingEditorComponent.c.

◆ IsProviderBase()

bool IsProviderBase ( )

Returns true if the provider is a base.

Definition at line 355 of file SCR_CampaignBuildingEditorComponent.c.

◆ RemoveOnEntityKilled()

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.

Definition at line 496 of file SCR_CampaignBuildingEditorComponent.c.

◆ RemoveProviderEntityEditorComponent()

void RemoveProviderEntityEditorComponent ( SCR_CampaignBuildingProviderComponent  providerComponent)

Definition at line 54 of file SCR_CampaignBuildingEditorComponent.c.

◆ RplLoad()

override protected bool RplLoad ( ScriptBitReader  reader)

Definition at line 694 of file SCR_CampaignBuildingEditorComponent.c.

◆ RplSave()

override protected bool RplSave ( ScriptBitWriter  writer)

Definition at line 673 of file SCR_CampaignBuildingEditorComponent.c.

◆ SetForcedProvider()

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.

Definition at line 86 of file SCR_CampaignBuildingEditorComponent.c.

◆ SetOnEnterEvent()

protected void SetOnEnterEvent ( )

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

Definition at line 387 of file SCR_CampaignBuildingEditorComponent.c.

◆ SetOnEntityKilled()

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.

Definition at line 484 of file SCR_CampaignBuildingEditorComponent.c.

◆ SetProviderFromRplID()

void SetProviderFromRplID ( )

Set a provider, loaded from RPL ID.

Definition at line 646 of file SCR_CampaignBuildingEditorComponent.c.

◆ SpawnClientTrigger()

ScriptedGameTriggerEntity SpawnClientTrigger ( )

Definition at line 235 of file SCR_CampaignBuildingEditorComponent.c.

◆ TabContainLabel()

bool TabContainLabel ( SCR_EditorContentBrowserSaveStateDataUI  tab)

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

Definition at line 336 of file SCR_CampaignBuildingEditorComponent.c.

◆ ToggleBuildingTool()

void ToggleBuildingTool ( bool  mode)

Definition at line 365 of file SCR_CampaignBuildingEditorComponent.c.

◆ UnassignCompositionProvider()

bool UnassignCompositionProvider ( IEntity  ent)

Definition at line 577 of file SCR_CampaignBuildingEditorComponent.c.

Variable Documentation

◆ m_aProvidersComponents

SCR_CampaignBuildingEditorComponentClass m_aProvidersComponents = {}

◆ m_aProvidersRplIds

protected ref array<RplId> m_aProvidersRplIds = {}

Definition at line 12 of file SCR_CampaignBuildingEditorComponent.c.

◆ m_bViewObstructed

protected bool m_bViewObstructed

Definition at line 15 of file SCR_CampaignBuildingEditorComponent.c.

◆ m_ContentBrowserManager

protected SCR_ContentBrowserEditorComponent m_ContentBrowserManager

Definition at line 13 of file SCR_CampaignBuildingEditorComponent.c.

◆ m_ForcedProviderComponent

protected SCR_CampaignBuildingProviderComponent m_ForcedProviderComponent

Definition at line 14 of file SCR_CampaignBuildingEditorComponent.c.

◆ m_OnObstructionEventTriggered

protected ref ScriptInvokerBool m_OnObstructionEventTriggered

Definition at line 18 of file SCR_CampaignBuildingEditorComponent.c.

◆ m_OnProviderChanged

protected ref ScriptInvoker m_OnProviderChanged

Definition at line 17 of file SCR_CampaignBuildingEditorComponent.c.