SCR_Stack< Class T > Class Reference

Protected Member Functions
void	Push (T item)
T	Pop ()
T	Top ()
T	Bottom ()
bool	IsEmpty ()
int	Count ()
	Returns the count of elements stored in this stack.

Protected Attributes
ref array< ref T >	m_aArray = {}

Detailed Description

Wrapper for array that works as a stack

• items are stored as 'first in, last out'
• items inside are always ref, so bear that in mind

Definition at line 5 of file SCR_Stack.c.

Member Function Documentation

Bottom()

T SCR_Stack< Class T >::Bottom ( )

inlineprotected

Get the first inserted and topmost element without popping it from the stack

Returns

the last inserted and topmost element, null if no element is present

Definition at line 47 of file SCR_Stack.c.

Count()

int SCR_Stack< Class T >::Count ( )

inlineprotected

Returns the count of elements stored in this stack.

Definition at line 64 of file SCR_Stack.c.

IsEmpty()

bool SCR_Stack< Class T >::IsEmpty ( )

inlineprotected

Returns

true if stack is empty, false otherwise

Definition at line 57 of file SCR_Stack.c.

Pop()

T SCR_Stack< Class T >::Pop ( )

inlineprotected

Pop an item from the top of the stack

Returns

the last inserted and topmost element, null if no element is present

Definition at line 20 of file SCR_Stack.c.

Push()

void SCR_Stack< Class T >::Push ( T item )

inlineprotected

Push an item to the end of the stack

Parameters

[in]

item

the item to push

Definition at line 12 of file SCR_Stack.c.

Top()

T SCR_Stack< Class T >::Top ( )

inlineprotected

Get the last inserted and topmost element without popping it from the stack

Returns

the last inserted and topmost element, null if no element is present

Definition at line 35 of file SCR_Stack.c.

Member Data Documentation

m_aArray

ref array<ref T> SCR_Stack< Class T >::m_aArray = {}

protected

Definition at line 7 of file SCR_Stack.c.

---

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

• scripts/Game/Utilities/SCR_Stack.c