SCR_ResourceContainerStorageQueue Interface Reference

Inheritance diagram for SCR_ResourceContainerStorageQueue:

Public Member Functions
int	GetContainerCount ()
int	GetOffsetPosition ()
bool	IsEmpty ()
bool	ShouldContainerChangeCauseUpdate ()
int	RegisterContainer (notnull SCR_ResourceContainer container, notnull SCR_ResourceInteractor actor)
	Registers a container into the queue.
void	UnregisterFirstContainer ()
	Unegisters the first container in the queue.
void	UnregisterContainerAt (int position)
	Unegisters the container at a specific position in the queue.
int	ComputePosition (SCR_ResourceContainer container, SCR_ResourceInteractor actor)
int	InsertContainerAtEx (SCR_ResourceContainer container, int index)
void	SetOffsetPosition (int offset)
void	IncrementOffset (int increment)
void	DecrementOffset (int decrement)
void	Initialize (array< SCR_ResourceContainer > containers)
void	Reset (int offsetPosition=0)
void	DebugPrint ()
void	SCR_ResourceContainerStorage ()

Protected Member Functions
int	GetUpperOffsetPosition ()
SCR_ResourceContainer	GetContainerRelativeAt (int index)
SCR_ResourceContainer	GetContainerAt (int index)
int	InsertContainerAt (SCR_ResourceContainer container, int index)

Protected Attributes
int	m_iOffsetPosition
int	m_iContainerCount

Member Function Documentation

ComputePosition()

int SCR_ResourceContainerStorageQueue.ComputePosition	(	SCR_ResourceContainer	container,
		SCR_ResourceInteractor	actor )

Implemented in SCR_ResourceConsumerContainerStorageQueueExtended, SCR_ResourceEncapsulatorContainerStorageQueue, SCR_ResourceEncapsulatorContainerStorageQueueExtended, SCR_ResourceGeneratorContainerStorageQueue, and SCR_ResourceGeneratorContainerStorageQueueExtended.

DebugPrint()

void SCR_ResourceContainerStorageQueue.DebugPrint

(

)

DecrementOffset()

void SCR_ResourceContainerStorageQueue.DecrementOffset

(

int

decrement

)

GetContainerAt()

SCR_ResourceContainer SCR_ResourceContainerStorageQueue.GetContainerAt ( int index )

protected

GetContainerCount()

int SCR_ResourceContainerStorageQueue.GetContainerCount

(

)

GetContainerRelativeAt()

SCR_ResourceContainer SCR_ResourceContainerStorageQueue.GetContainerRelativeAt ( int index )

protected

GetOffsetPosition()

int SCR_ResourceContainerStorageQueue.GetOffsetPosition

(

)

GetUpperOffsetPosition()

int SCR_ResourceContainerStorageQueue.GetUpperOffsetPosition ( )

protected

IncrementOffset()

void SCR_ResourceContainerStorageQueue.IncrementOffset

(

int

increment

)

Initialize()

void SCR_ResourceContainerStorageQueue.Initialize

(

array< SCR_ResourceContainer >

containers

)

InsertContainerAt()

int SCR_ResourceContainerStorageQueue.InsertContainerAt ( SCR_ResourceContainer container, int index )

protected

InsertContainerAtEx()

int SCR_ResourceContainerStorageQueue.InsertContainerAtEx	(	SCR_ResourceContainer	container,
		int	index )

IsEmpty()

bool SCR_ResourceContainerStorageQueue.IsEmpty

(

)

RegisterContainer()

int SCR_ResourceContainerStorageQueue.RegisterContainer	(	notnull SCR_ResourceContainer	container,
		notnull SCR_ResourceInteractor	actor )

Registers a container into the queue.

Parameters

container

The container to be registered into the queue.

Returns

Returns the position of the container in the queue.

Implemented in SCR_ResourceEncapsulatorContainerStorageQueue.

Reset()

void SCR_ResourceContainerStorageQueue.Reset

(

int

offsetPosition = 0

)

SCR_ResourceContainerStorage()

void SCR_ResourceContainerStorageQueue.SCR_ResourceContainerStorage

(

)

SetOffsetPosition()

void SCR_ResourceContainerStorageQueue.SetOffsetPosition

(

int

offset

)

ShouldContainerChangeCauseUpdate()

bool SCR_ResourceContainerStorageQueue.ShouldContainerChangeCauseUpdate

(

)

Implemented in SCR_ResourceConsumerContainerStorageQueueExtended, SCR_ResourceEncapsulatorContainerStorageQueueExtended, and SCR_ResourceGeneratorContainerStorageQueueExtended.

UnregisterContainerAt()

void SCR_ResourceContainerStorageQueue.UnregisterContainerAt

(

int

position

)

Unegisters the container at a specific position in the queue.

UnregisterFirstContainer()

void SCR_ResourceContainerStorageQueue.UnregisterFirstContainer

(

)

Unegisters the first container in the queue.

Member Data Documentation

m_iContainerCount

int SCR_ResourceContainerStorageQueue.m_iContainerCount

protected

m_iOffsetPosition

int SCR_ResourceContainerStorageQueue.m_iOffsetPosition

protected

---

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

• Game/Sandbox/Resources/ContainerQueue/Storage/Queue/SCR_ResourceContainerStorageQueue.c