SCR_ResourceActor Class Reference

Inheritance diagram for SCR_ResourceActor:

Protected Member Functions
Color	GetDebugColor ()
int	GetGridUpdateId ()
vector	GetOwnerOrigin ()
string	GetDebugName ()
int	GetDebugNameHash ()
SCR_ResourceComponent	GetComponent ()
IEntity	GetOwner ()
EResourceRights	GetResourceRight ()
bool	ShouldUpdate ()
bool	IsIsolated ()
bool	IsGridUpdateIdGreaterThan (int gridUpdateId)
void	SetResourceRights (EResourceRights rights)
void	SetGridUpdateId (int gridUpdateId)
void	Update (float timeslice)
void	Update (WorldTimestamp timestamp)
void	UpdateInner (float timeslice)
void	Clear ()
void	~SCR_ResourceActor ()

Protected Attributes
string	m_sDebugName
EResourceRights	m_eResourceRights
EResourceType	m_eResourceType
SCR_ResourceComponent	m_ResourceComponent
IEntity	m_Owner

Static Protected Attributes
static const float	UPDATE_PERIOD = 10.0 / 60.0
static const int	CODEC_GENERATOR_PACKET_BYTESIZE = 32

Detailed Description

Definition at line 2 of file SCR_ResourceConsumer.c.

Constructor & Destructor Documentation

~SCR_ResourceActor()

void SCR_ResourceActor::~SCR_ResourceActor ( )

inlineprotected

Definition at line 145 of file SCR_ResourceConsumer.c.

Member Function Documentation

Clear()

void SCR_ResourceActor::Clear ( )

inlineprotected

Definition at line 138 of file SCR_ResourceConsumer.c.

GetComponent()

SCR_ResourceComponent SCR_ResourceActor::GetComponent ( )

inlineprotected

Returns

Definition at line 61 of file SCR_ResourceConsumer.c.

GetDebugColor()

Color SCR_ResourceActor::GetDebugColor ( )

inlineprotected

Returns

Definition at line 22 of file SCR_ResourceConsumer.c.

GetDebugName()

string SCR_ResourceActor::GetDebugName ( )

inlineprotected

Returns

Definition at line 47 of file SCR_ResourceConsumer.c.

GetDebugNameHash()

int SCR_ResourceActor::GetDebugNameHash ( )

inlineprotected

Returns

Definition at line 54 of file SCR_ResourceConsumer.c.

GetGridUpdateId()

int SCR_ResourceActor::GetGridUpdateId ( )

inlineprotected

Returns

Definition at line 29 of file SCR_ResourceConsumer.c.

GetOwner()

IEntity SCR_ResourceActor::GetOwner ( )

inlineprotected

Returns

Definition at line 68 of file SCR_ResourceConsumer.c.

GetOwnerOrigin()

vector SCR_ResourceActor::GetOwnerOrigin ( )

inlineprotected

Returns

Definition at line 36 of file SCR_ResourceConsumer.c.

GetResourceRight()

EResourceRights SCR_ResourceActor::GetResourceRight ( )

inlineprotected

Returns

Definition at line 75 of file SCR_ResourceConsumer.c.

IsGridUpdateIdGreaterThan()

bool SCR_ResourceActor::IsGridUpdateIdGreaterThan ( int gridUpdateId )

inlineprotected

Parameters

[in]

gridUpdateId

Returns

Definition at line 98 of file SCR_ResourceConsumer.c.

IsIsolated()

bool SCR_ResourceActor::IsIsolated ( )

inlineprotected

Returns

Definition at line 90 of file SCR_ResourceConsumer.c.

SetGridUpdateId()

void SCR_ResourceActor::SetGridUpdateId ( int gridUpdateId )

inlineprotected

Parameters

[in]

gridUpdateId

Definition at line 112 of file SCR_ResourceConsumer.c.

SetResourceRights()

void SCR_ResourceActor::SetResourceRights ( EResourceRights rights )

inlineprotected

Parameters

[in]

rights

Definition at line 105 of file SCR_ResourceConsumer.c.

ShouldUpdate()

bool SCR_ResourceActor::ShouldUpdate ( )

inlineprotected

Returns

Definition at line 83 of file SCR_ResourceConsumer.c.

Update() [1/2]

void SCR_ResourceActor::Update ( float timeslice )

protected

Method used to perform a periodic/iterative update on the state of the resource actor.

Parameters

[in]

timeslice

Delta time of the moment when the method was called.

Update() [2/2]

void SCR_ResourceActor::Update ( WorldTimestamp timestamp )

protected

Method used to perform a periodic/iterative update on the state of the resource actor.

Parameters

[in]

timestamp

WorldTimestamp object of the moment when the method was called.

UpdateInner()

void SCR_ResourceActor::UpdateInner ( float timeslice )

inlineprotected

Parameters

[in]

timeslice

Definition at line 131 of file SCR_ResourceConsumer.c.

Member Data Documentation

CODEC_GENERATOR_PACKET_BYTESIZE

const int SCR_ResourceActor::CODEC_GENERATOR_PACKET_BYTESIZE = 32

staticprotected

Definition at line 6 of file SCR_ResourceConsumer.c.

m_eResourceRights

EResourceRights SCR_ResourceActor::m_eResourceRights

protected

Definition at line 12 of file SCR_ResourceConsumer.c.

m_eResourceType

EResourceType SCR_ResourceActor::m_eResourceType

protected

Definition at line 15 of file SCR_ResourceConsumer.c.

m_Owner

IEntity SCR_ResourceActor::m_Owner

protected

Definition at line 18 of file SCR_ResourceConsumer.c.

m_ResourceComponent

SCR_ResourceComponent SCR_ResourceActor::m_ResourceComponent

protected

Definition at line 17 of file SCR_ResourceConsumer.c.

m_sDebugName

string SCR_ResourceActor::m_sDebugName

protected

Definition at line 9 of file SCR_ResourceConsumer.c.

UPDATE_PERIOD

const float SCR_ResourceActor::UPDATE_PERIOD = 10.0 / 60.0

staticprotected

Definition at line 5 of file SCR_ResourceConsumer.c.

---

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

• scripts/Game/Sandbox/Resources/Consumer/SCR_ResourceConsumer.c