SCR_ResourceActor Interface Reference

Inheritance diagram for SCR_ResourceActor:

Public 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)
	Method used to perform a periodic/iterative update on the state of the resource actor.
void	Update (WorldTimestamp timestamp)
	Method used to perform a periodic/iterative update on the state of the resource actor.
void	UpdateInner (float timeslice)
void	Clear ()
void	~SCR_ResourceActor ()

Public Attributes
string	m_sDebugName

Static Public Attributes
static const float	RESOURCES_LOWER_LIMIT = 0.0

Protected Attributes
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

Constructor & Destructor Documentation

~SCR_ResourceActor()

void SCR_ResourceActor.~SCR_ResourceActor

(

)

Member Function Documentation

Clear()

void SCR_ResourceActor.Clear

(

)

Implemented in SCR_ResourceConsumer, SCR_ResourceConsumerServicePoint, SCR_ResourceContainer, SCR_ResourceEncapsulator, SCR_ResourceGenerator, SCR_ResourceGeneratorServicePoint, and SCR_ResourceInteractor.

GetComponent()

SCR_ResourceComponent SCR_ResourceActor.GetComponent

(

)

Returns

GetDebugColor()

Color SCR_ResourceActor.GetDebugColor

(

)

Returns

GetDebugName()

string SCR_ResourceActor.GetDebugName

(

)

Returns

GetDebugNameHash()

int SCR_ResourceActor.GetDebugNameHash

(

)

Returns

GetGridUpdateId()

int SCR_ResourceActor.GetGridUpdateId

(

)

Returns

Implemented in SCR_ResourceInteractor.

GetOwner()

IEntity SCR_ResourceActor.GetOwner

(

)

Returns

GetOwnerOrigin()

vector SCR_ResourceActor.GetOwnerOrigin

(

)

Returns

GetResourceRight()

EResourceRights SCR_ResourceActor.GetResourceRight

(

)

Returns

IsGridUpdateIdGreaterThan()

bool SCR_ResourceActor.IsGridUpdateIdGreaterThan

(

int

gridUpdateId

)

Parameters

[in]

gridUpdateId

Returns

Implemented in SCR_ResourceInteractor.

IsIsolated()

bool SCR_ResourceActor.IsIsolated

(

)

Returns

Implemented in SCR_ResourceContainer.

SetGridUpdateId()

void SCR_ResourceActor.SetGridUpdateId

(

int

gridUpdateId

)

Parameters

[in]

gridUpdateId

Implemented in SCR_ResourceInteractor.

SetResourceRights()

void SCR_ResourceActor.SetResourceRights

(

EResourceRights

rights

)

Parameters

[in]

rights

ShouldUpdate()

bool SCR_ResourceActor.ShouldUpdate

(

)

Returns

Implemented in SCR_ResourceConsumer, SCR_ResourceContainer, and SCR_ResourceEncapsulator.

Update() [1/2]

void SCR_ResourceActor.Update

(

float

timeslice

)

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

)

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.

Implemented in SCR_ResourceContainer.

UpdateInner()

void SCR_ResourceActor.UpdateInner

(

float

timeslice

)

Parameters

[in]

timeslice

Member Data Documentation

CODEC_GENERATOR_PACKET_BYTESIZE

const int SCR_ResourceActor.CODEC_GENERATOR_PACKET_BYTESIZE = 32

staticprotected

m_eResourceRights

EResourceRights SCR_ResourceActor.m_eResourceRights

protected

m_eResourceType

EResourceType SCR_ResourceActor.m_eResourceType

protected

m_Owner

IEntity SCR_ResourceActor.m_Owner

protected

m_ResourceComponent

SCR_ResourceComponent SCR_ResourceActor.m_ResourceComponent

protected

m_sDebugName

string SCR_ResourceActor.m_sDebugName

RESOURCES_LOWER_LIMIT

const float SCR_ResourceActor.RESOURCES_LOWER_LIMIT = 0.0

static

UPDATE_PERIOD

const float SCR_ResourceActor.UPDATE_PERIOD = 10.0 / 60.0

staticprotected

---

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

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