SCR_ResourceEncapsulator Class Reference

Inheritance diagram for SCR_ResourceEncapsulator:

Protected Member Functions
override float	GetAggregatedResourceValue ()
override float	GetAggregatedMaxResourceValue ()
override int	GetContainerCount ()
override SCR_ResourceContainerQueueBase	GetContainerQueue ()
SCR_ResourceContainer	GetContainerRepresentative ()
array< ref SCR_ResourceEncapsulatorActionBase >	GetActions ()
override bool	IsAllowed (notnull SCR_ResourceContainer container)
bool	IsContainerRepresentative (notnull SCR_ResourceContainer container)
override bool	ShouldUpdate ()
override int	FindContainer (notnull SCR_ResourceContainer container)
void	SetContainerRepresentative (notnull SCR_ResourceContainer container)
override bool	RegisterContainer (notnull SCR_ResourceContainer container)
override bool	RegisterContainerForced (notnull SCR_ResourceContainer container)
override bool	UnregisterContainer (int containerIndex)
override bool	UnregisterContainer (notnull SCR_ResourceContainer container)
void	RequestConsumtion (float resourceCost, bool notifyChange=true)
void	RequestGeneration (float resourceAmount, bool notifyChange=true)
void	DebugDraw ()
override void	UpdateContainerResourceValue (SCR_ResourceContainer container, float previousValue)
override void	UpdateContainerMaxResourceValue (SCR_ResourceContainer container, float previousValue)
override void	Initialize (notnull IEntity owner)
override void	Clear ()
override void	OnResourcesChanged (float previousValue)
override void	OnMaxResourcesChanged (float previousValue)
override void	OnContainerRegistered (notnull SCR_ResourceContainer container)
override void	OnContainerUnregistered (notnull SCR_ResourceContainer container)

Protected Attributes
SCR_ResourceContainer	m_ContainerRepresentative
ref SCR_ResourceEncapsulatorContainerQueue	m_ContainerQueue
ref array< ref SCR_ResourceEncapsulatorActionBase >	m_aActions

Detailed Description

Definition at line 1 of file SCR_ResourceEncapsulator.c.

Member Function Documentation

Clear()

override void SCR_ResourceEncapsulator::Clear ( )

inlineprotected

Definition at line 222 of file SCR_ResourceEncapsulator.c.

DebugDraw()

void SCR_ResourceEncapsulator::DebugDraw ( )

inlineprotected

Definition at line 180 of file SCR_ResourceEncapsulator.c.

FindContainer()

override int SCR_ResourceEncapsulator::FindContainer ( notnull SCR_ResourceContainer container )

inlineprotected

Definition at line 75 of file SCR_ResourceEncapsulator.c.

GetActions()

array< ref SCR_ResourceEncapsulatorActionBase > SCR_ResourceEncapsulator::GetActions ( )

inlineprotected

Definition at line 51 of file SCR_ResourceEncapsulator.c.

GetAggregatedMaxResourceValue()

override float SCR_ResourceEncapsulator::GetAggregatedMaxResourceValue ( )

inlineprotected

Definition at line 21 of file SCR_ResourceEncapsulator.c.

GetAggregatedResourceValue()

override float SCR_ResourceEncapsulator::GetAggregatedResourceValue ( )

inlineprotected

Definition at line 12 of file SCR_ResourceEncapsulator.c.

GetContainerCount()

override int SCR_ResourceEncapsulator::GetContainerCount ( )

inlineprotected

Definition at line 30 of file SCR_ResourceEncapsulator.c.

GetContainerQueue()

override SCR_ResourceContainerQueueBase SCR_ResourceEncapsulator::GetContainerQueue ( )

inlineprotected

Definition at line 39 of file SCR_ResourceEncapsulator.c.

GetContainerRepresentative()

SCR_ResourceContainer SCR_ResourceEncapsulator::GetContainerRepresentative ( )

inlineprotected

Definition at line 45 of file SCR_ResourceEncapsulator.c.

Initialize()

override void SCR_ResourceEncapsulator::Initialize ( notnull IEntity owner )

inlineprotected

Definition at line 211 of file SCR_ResourceEncapsulator.c.

IsAllowed()

override bool SCR_ResourceEncapsulator::IsAllowed ( notnull SCR_ResourceContainer container )

inlineprotected

Definition at line 57 of file SCR_ResourceEncapsulator.c.

IsContainerRepresentative()

bool SCR_ResourceEncapsulator::IsContainerRepresentative ( notnull SCR_ResourceContainer container )

inlineprotected

Definition at line 63 of file SCR_ResourceEncapsulator.c.

OnContainerRegistered()

override void SCR_ResourceEncapsulator::OnContainerRegistered ( notnull SCR_ResourceContainer container )

inlineprotected

Definition at line 254 of file SCR_ResourceEncapsulator.c.

OnContainerUnregistered()

override void SCR_ResourceEncapsulator::OnContainerUnregistered ( notnull SCR_ResourceContainer container )

inlineprotected

Definition at line 277 of file SCR_ResourceEncapsulator.c.

OnMaxResourcesChanged()

override void SCR_ResourceEncapsulator::OnMaxResourcesChanged ( float previousValue )

inlineprotected

Definition at line 243 of file SCR_ResourceEncapsulator.c.

OnResourcesChanged()

override void SCR_ResourceEncapsulator::OnResourcesChanged ( float previousValue )

inlineprotected

Definition at line 231 of file SCR_ResourceEncapsulator.c.

RegisterContainer()

override bool SCR_ResourceEncapsulator::RegisterContainer ( notnull SCR_ResourceContainer container )

inlineprotected

Definition at line 93 of file SCR_ResourceEncapsulator.c.

RegisterContainerForced()

override bool SCR_ResourceEncapsulator::RegisterContainerForced ( notnull SCR_ResourceContainer container )

inlineprotected

Definition at line 108 of file SCR_ResourceEncapsulator.c.

RequestConsumtion()

void SCR_ResourceEncapsulator::RequestConsumtion ( float resourceCost, bool notifyChange = true )

inlineprotected

Definition at line 133 of file SCR_ResourceEncapsulator.c.

RequestGeneration()

void SCR_ResourceEncapsulator::RequestGeneration ( float resourceAmount, bool notifyChange = true )

inlineprotected

Definition at line 156 of file SCR_ResourceEncapsulator.c.

SetContainerRepresentative()

void SCR_ResourceEncapsulator::SetContainerRepresentative ( notnull SCR_ResourceContainer container )

inlineprotected

Definition at line 84 of file SCR_ResourceEncapsulator.c.

ShouldUpdate()

override bool SCR_ResourceEncapsulator::ShouldUpdate ( )

inlineprotected

Definition at line 69 of file SCR_ResourceEncapsulator.c.

UnregisterContainer() [1/2]

override bool SCR_ResourceEncapsulator::UnregisterContainer ( int containerIndex )

inlineprotected

Definition at line 121 of file SCR_ResourceEncapsulator.c.

UnregisterContainer() [2/2]

override bool SCR_ResourceEncapsulator::UnregisterContainer ( notnull SCR_ResourceContainer container )

inlineprotected

Definition at line 127 of file SCR_ResourceEncapsulator.c.

UpdateContainerMaxResourceValue()

override void SCR_ResourceEncapsulator::UpdateContainerMaxResourceValue ( SCR_ResourceContainer container, float previousValue )

inlineprotected

Definition at line 203 of file SCR_ResourceEncapsulator.c.

UpdateContainerResourceValue()

override void SCR_ResourceEncapsulator::UpdateContainerResourceValue ( SCR_ResourceContainer container, float previousValue )

inlineprotected

Definition at line 195 of file SCR_ResourceEncapsulator.c.

Member Data Documentation

m_aActions

ref array<ref SCR_ResourceEncapsulatorActionBase> SCR_ResourceEncapsulator::m_aActions

protected

Definition at line 9 of file SCR_ResourceEncapsulator.c.

m_ContainerQueue

ref SCR_ResourceEncapsulatorContainerQueue SCR_ResourceEncapsulator::m_ContainerQueue

protected

Definition at line 6 of file SCR_ResourceEncapsulator.c.

m_ContainerRepresentative

SCR_ResourceContainer SCR_ResourceEncapsulator::m_ContainerRepresentative

protected

Definition at line 3 of file SCR_ResourceEncapsulator.c.

---

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

• scripts/Game/Sandbox/Resources/Encapsulator/SCR_ResourceEncapsulator.c