SCR_CampaignBuildingBudgetEditorComponent.c File Reference

Go to the source code of this file.

Data Structures
class	SCR_CampaignBuildingBudgetEditorComponentClass

Functions
protected override void	EOnEditorActivateServer ()
protected override void	EOnEditorActivate ()
protected override void	EOnEditorDeactivate ()
protected void	OnResourceTypeEnabledChanged (array< EResourceType > disabledResourceTypes)
protected bool	RefreshSuppliesComponent ()
protected void	OnBaseResourcesChanged (SCR_ResourceConsumer consumer, int previousValue)
protected void	OnBaseSuppliesChanged (int supplies)
protected void	OnTargetBaseChanged (IEntity targetEntity)
override bool	GetMaxBudgetValue (EEditableEntityBudget type, out int maxBudget)
override int	GetCurrentBudgetValue (EEditableEntityBudget type)
int	GetProviderMaxValue (EEditableEntityBudget budget)
bool	HasCooldownTime ()
	Return current cooldown timer state. More...
int	GetCooldownTime ()
SCR_ECharacterRank	GetUserRank ()
protected override void	OnEntityCoreBudgetUpdatedOwner (EEditableEntityBudget entityBudget, int budgetValue, int budgetChange, bool sendBudgetMaxEvent, bool budgetMaxReached)
protected bool	RefreshResourcesComponent ()
protected override void	RefreshBudgetSettings ()
override bool	CanPlaceEntitySource (IEntityComponentSource editableEntitySource, out EEditableEntityBudget blockingBudget, bool isPlacingPlayer=false, bool updatePreview=true, bool showNotification=true)
protected bool	CanPlaceResultCampaignBuilding (bool canPlace, bool showNotification, EEditableEntityBudget blockingBudget)
void	CanPlaceOwnerCampaignBuilding (bool canPlace, EEditableEntityBudget blockingBudget)
override bool	GetMaxBudget (EEditableEntityBudget type, out SCR_EntityBudgetValue budget)
override bool	CanPlace (notnull array< ref SCR_EntityBudgetValue > budgetCosts, out EEditableEntityBudget blockingBudget)
bool	IsBudgetCapEnabled (EEditableEntityBudget blockingBudget)
override bool	GetEntityPreviewBudgetCosts (SCR_EditableEntityUIInfo entityUIInfo, out notnull array< ref SCR_EntityBudgetValue > budgetCosts)

Variables
SCR_CampaignBuildingBudgetEditorComponentClass	m_ResourceComponent
protected SCR_CampaignBuildingEditorComponent	m_CampaignBuildingComponent
protected SCR_CampaignSuppliesComponent	m_SuppliesComponent
protected SCR_ECharacterRank	m_eHighestRank

Function Documentation

CanPlace()

override bool CanPlace	(	notnull array< ref SCR_EntityBudgetValue >	budgetCosts,
		out EEditableEntityBudget	blockingBudget
	)

Definition at line 494 of file SCR_CampaignBuildingBudgetEditorComponent.c.

CanPlaceEntitySource()

override bool CanPlaceEntitySource	(	IEntityComponentSource	editableEntitySource,
		out EEditableEntityBudget	blockingBudget,
		bool	isPlacingPlayer = false,
		bool	updatePreview = true,
		bool	showNotification = true
	)

Definition at line 330 of file SCR_CampaignBuildingBudgetEditorComponent.c.

CanPlaceOwnerCampaignBuilding()

void CanPlaceOwnerCampaignBuilding	(	bool	canPlace,
		EEditableEntityBudget	blockingBudget
	)

Parameters

[in]	canPlace
[in]	blockingBudget

Definition at line 366 of file SCR_CampaignBuildingBudgetEditorComponent.c.

CanPlaceResultCampaignBuilding()

protected bool CanPlaceResultCampaignBuilding	(	bool	canPlace,
		bool	showNotification,
		EEditableEntityBudget	blockingBudget
	)

Definition at line 352 of file SCR_CampaignBuildingBudgetEditorComponent.c.

EOnEditorActivate()

protected override void EOnEditorActivate

(

)

Definition at line 41 of file SCR_CampaignBuildingBudgetEditorComponent.c.

EOnEditorActivateServer()

protected override void EOnEditorActivateServer

(

)

Definition at line 16 of file SCR_CampaignBuildingBudgetEditorComponent.c.

EOnEditorDeactivate()

protected override void EOnEditorDeactivate

(

)

Definition at line 56 of file SCR_CampaignBuildingBudgetEditorComponent.c.

GetCooldownTime()

int GetCooldownTime

(

)

Definition at line 247 of file SCR_CampaignBuildingBudgetEditorComponent.c.

GetCurrentBudgetValue()

override int GetCurrentBudgetValue

(

EEditableEntityBudget

type

)

Definition at line 171 of file SCR_CampaignBuildingBudgetEditorComponent.c.

GetEntityPreviewBudgetCosts()

override bool GetEntityPreviewBudgetCosts	(	SCR_EditableEntityUIInfo	entityUIInfo,
		out notnull array< ref SCR_EntityBudgetValue >	budgetCosts
	)

Definition at line 559 of file SCR_CampaignBuildingBudgetEditorComponent.c.

GetMaxBudget()

override bool GetMaxBudget	(	EEditableEntityBudget	type,
		out SCR_EntityBudgetValue	budget
	)

Definition at line 418 of file SCR_CampaignBuildingBudgetEditorComponent.c.

GetMaxBudgetValue()

override bool GetMaxBudgetValue	(	EEditableEntityBudget	type,
		out int	maxBudget
	)

Definition at line 120 of file SCR_CampaignBuildingBudgetEditorComponent.c.

GetProviderMaxValue()

int GetProviderMaxValue

(

EEditableEntityBudget

budget

)

Returns

max prop value for a current provider. This number limits the number of prefabs (compositions) buildable with this provider.

Definition at line 217 of file SCR_CampaignBuildingBudgetEditorComponent.c.

GetUserRank()

SCR_ECharacterRank GetUserRank

(

)

Returns

Definition at line 261 of file SCR_CampaignBuildingBudgetEditorComponent.c.

HasCooldownTime()

bool HasCooldownTime

(

)

Return current cooldown timer state.

Definition at line 231 of file SCR_CampaignBuildingBudgetEditorComponent.c.

IsBudgetCapEnabled()

bool IsBudgetCapEnabled

(

EEditableEntityBudget

blockingBudget

)

Check if the given budget is on the list of budgets used by a provider.

Parameters

[in]

blockingBudget

Returns

Definition at line 546 of file SCR_CampaignBuildingBudgetEditorComponent.c.

OnBaseResourcesChanged()

protected void OnBaseResourcesChanged	(	SCR_ResourceConsumer	consumer,
		int	previousValue
	)

Definition at line 101 of file SCR_CampaignBuildingBudgetEditorComponent.c.

OnBaseSuppliesChanged()

protected void OnBaseSuppliesChanged

(

int

supplies

)

Definition at line 108 of file SCR_CampaignBuildingBudgetEditorComponent.c.

OnEntityCoreBudgetUpdatedOwner()

protected override void OnEntityCoreBudgetUpdatedOwner	(	EEditableEntityBudget	entityBudget,
		int	budgetValue,
		int	budgetChange,
		bool	sendBudgetMaxEvent,
		bool	budgetMaxReached
	)

Definition at line 274 of file SCR_CampaignBuildingBudgetEditorComponent.c.

OnResourceTypeEnabledChanged()

protected void OnResourceTypeEnabledChanged

(

array< EResourceType >

disabledResourceTypes

)

Definition at line 67 of file SCR_CampaignBuildingBudgetEditorComponent.c.

OnTargetBaseChanged()

protected void OnTargetBaseChanged

(

IEntity

targetEntity

)

Definition at line 114 of file SCR_CampaignBuildingBudgetEditorComponent.c.

RefreshBudgetSettings()

protected override void RefreshBudgetSettings

(

)

Definition at line 302 of file SCR_CampaignBuildingBudgetEditorComponent.c.

RefreshResourcesComponent()

protected bool RefreshResourcesComponent

(

)

Definition at line 296 of file SCR_CampaignBuildingBudgetEditorComponent.c.

RefreshSuppliesComponent()

protected bool RefreshSuppliesComponent

(

)

Definition at line 74 of file SCR_CampaignBuildingBudgetEditorComponent.c.

Variable Documentation

m_CampaignBuildingComponent

protected SCR_CampaignBuildingEditorComponent m_CampaignBuildingComponent

Definition at line 9 of file SCR_CampaignBuildingBudgetEditorComponent.c.

m_eHighestRank

protected SCR_ECharacterRank m_eHighestRank

Definition at line 11 of file SCR_CampaignBuildingBudgetEditorComponent.c.

m_ResourceComponent

SCR_CampaignBuildingBudgetEditorComponentClass m_ResourceComponent

m_SuppliesComponent

protected SCR_CampaignSuppliesComponent m_SuppliesComponent

Definition at line 10 of file SCR_CampaignBuildingBudgetEditorComponent.c.