SCR_ResourceGrid Class Reference

Inheritance diagram for SCR_ResourceGrid:

Protected Member Functions
int	GetGridUpdateId ()
int	GetFrameBudget ()
void	ResetFrameBudget ()
int	IncreaseGridUpdateId ()
void	FlagResourceItem (notnull SCR_ResourceComponent item)
void	UnflagResourceItem (notnull SCR_ResourceComponent item)
void	ProcessFlaggedItems ()
	Registers all resource components that are flagged into the grid.
void	UpdateResourceItem (notnull SCR_ResourceComponent item)
bool	ProcessResourceItem (notnull SCR_ResourceComponent item)
void	UnregisterResourceItem (notnull SCR_ResourceComponent item)
void	UpdateInteractor (notnull SCR_ResourceInteractor interactor, bool useFrameBudget=false)

Protected Attributes
ref array< SCR_ResourceComponent >	m_aFlaggedItems = {}
ref set< SCR_ResourceContainer >	m_aQueriedContainers = new set<SCR_ResourceContainer>()
int	m_iGridUpdateId = int.MIN
int	m_iFrameBudget

Detailed Description

Definition at line 1 of file SCR_ResourceGrid.c.

Member Function Documentation

FlagResourceItem()

void SCR_ResourceGrid::FlagResourceItem ( notnull SCR_ResourceComponent item )

inlineprotected

Flags a resource component (Considered items in this context) to be registered into the grid.

Parameters

[in]

item

The resource component to flag for registration.

Definition at line 47 of file SCR_ResourceGrid.c.

GetFrameBudget()

int SCR_ResourceGrid::GetFrameBudget ( )

inlineprotected

Returns

The current frame budget remaining for the amount of containers to process in the iteration.

Definition at line 20 of file SCR_ResourceGrid.c.

GetGridUpdateId()

int SCR_ResourceGrid::GetGridUpdateId ( )

inlineprotected

Returns

The latest update ID of the grid.

Definition at line 12 of file SCR_ResourceGrid.c.

IncreaseGridUpdateId()

int SCR_ResourceGrid::IncreaseGridUpdateId ( )

inlineprotected

Increases the update ID of the grid by 1.

Returns

The latest update ID of the grid.

Definition at line 35 of file SCR_ResourceGrid.c.

ProcessFlaggedItems()

void SCR_ResourceGrid::ProcessFlaggedItems ( )

inlineprotected

Registers all resource components that are flagged into the grid.

Definition at line 63 of file SCR_ResourceGrid.c.

ProcessResourceItem()

bool SCR_ResourceGrid::ProcessResourceItem ( notnull SCR_ResourceComponent item )

inlineprotected

Registers a resource component (Considered items in this context) in the grid.

Parameters

[in]

item

The resource component to register.

Definition at line 104 of file SCR_ResourceGrid.c.

ResetFrameBudget()

void SCR_ResourceGrid::ResetFrameBudget ( )

inlineprotected

Definition at line 26 of file SCR_ResourceGrid.c.

UnflagResourceItem()

void SCR_ResourceGrid::UnflagResourceItem ( notnull SCR_ResourceComponent item )

inlineprotected

Unflags a resource component (Considered items in this context) from being registered into the grid.

Parameters

[in]

item

The resource component to unflag from registration.

Definition at line 56 of file SCR_ResourceGrid.c.

UnregisterResourceItem()

void SCR_ResourceGrid::UnregisterResourceItem ( notnull SCR_ResourceComponent item )

inlineprotected

Unregisters a resource component (Considered items in this context) from the grid.

Parameters

[in]

item

The resource component to unregister.

Definition at line 130 of file SCR_ResourceGrid.c.

UpdateInteractor()

void SCR_ResourceGrid::UpdateInteractor ( notnull SCR_ResourceInteractor interactor, bool useFrameBudget = false )

inlineprotected

Attempts to update the state of a resource interactor, basically will try to perform a query on the grid for containers it can reach with it's detection radius and then perform a check to see if it can be registered as valid container for the interactor. It will also recheck the current queue of containers to see if anything should be kept.

Parameters

[in]	interactor	The resource interactor to update.
[in]	useFrameBudget	If the frame budgeting should be used.

Definition at line 150 of file SCR_ResourceGrid.c.

UpdateResourceItem()

void SCR_ResourceGrid::UpdateResourceItem ( notnull SCR_ResourceComponent item )

inlineprotected

Updates the state of a resource component (Considered items in this context) in the grid.

Parameters

[in]

item

The resource component to update.

Definition at line 85 of file SCR_ResourceGrid.c.

Member Data Documentation

m_aFlaggedItems

ref array<SCR_ResourceComponent> SCR_ResourceGrid::m_aFlaggedItems = {}

protected

Definition at line 5 of file SCR_ResourceGrid.c.

m_aQueriedContainers

ref set<SCR_ResourceContainer> SCR_ResourceGrid::m_aQueriedContainers = new set<SCR_ResourceContainer>()

protected

Definition at line 6 of file SCR_ResourceGrid.c.

m_iFrameBudget

int SCR_ResourceGrid::m_iFrameBudget

protected

Definition at line 8 of file SCR_ResourceGrid.c.

m_iGridUpdateId

int SCR_ResourceGrid::m_iGridUpdateId = int.MIN

protected

Definition at line 7 of file SCR_ResourceGrid.c.

---

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

• scripts/Game/Sandbox/Resources/SCR_ResourceGrid.c