SimObjectList

Engine/source/console/simObjectList.h

A vector of SimObjects.

More...

Private Static Attributes

The script callback function for the active sort.

Private Static Functions

The script callback comparision callback.

The SimObjectId comparision sort callback.

Public Functions

at(S32 index)
bool

Add the SimObject* to the end of the list, unless it's already in the list.

bool

Add the SimObject* to the end of the list, moving it there if it's already present in the list.

bool

Add the SimObject* to the start of the list.

bool

Remove the SimObject* from the list; may disrupt order of the list.

bool

Remove the SimObject* from the list; guaranteed to preserve list order.

scriptSort(const String & scriptCallback)

Performs a sort of the objects in the set using a script callback function to do the comparision.

Performs a simple sort by SimObjectId.

Detailed Description

A vector of SimObjects.

As this inherits from VectorPtr, it has the full range of vector methods.

Private Static Attributes

String smSortScriptCallbackFn 

The script callback function for the active sort.

Private Static Functions

_callbackSort(const void * a, const void * b)

The script callback comparision callback.

_compareId(const void * a, const void * b)

The SimObjectId comparision sort callback.

see:

Public Functions

at(S32 index)

pushBack(SimObject * )

Add the SimObject* to the end of the list, unless it's already in the list.

pushBackForce(SimObject * )

Add the SimObject* to the end of the list, moving it there if it's already present in the list.

pushFront(SimObject * )

Add the SimObject* to the start of the list.

remove(SimObject * )

Remove the SimObject* from the list; may disrupt order of the list.

removeStable(SimObject * pObject)

Remove the SimObject* from the list; guaranteed to preserve list order.

scriptSort(const String & scriptCallback)

Performs a sort of the objects in the set using a script callback function to do the comparision.

sortId()

Performs a simple sort by SimObjectId.