Array Class Reference

A data structure holding indexed sequences of key/value pairs for script use. More...

#include <arrayObject.h>

Inheritance diagram for Array:

Classes
struct	Element

Public Member Functions
	Array ()
void	onRemove ()
	Called when the object is removed from the sim.
bool	onAdd ()
	Called when the object is added to the sim.
void	append (Array *obj)
S32	count ()
S32	countKey (StringTableEntry key)
S32	countValue (StringTableEntry value)
void	crop (Array *obj)
void	duplicate (Array *obj)
void	echo ()
void	empty ()
void	erase (S32 index)
S32	getCurrent ()
void	setCurrent (S32 idx)
S32	getIndexFromKey (StringTableEntry key)
S32	getIndexFromValue (StringTableEntry value)
S32	getIndexFromKeyValue (StringTableEntry key, StringTableEntry value)
StringTableEntry	getKeyFromIndex (S32 index)
StringTableEntry	getValueFromIndex (S32 index)
void	setKey (StringTableEntry key, S32 index)
void	setValue (StringTableEntry value, S32 index)
void	insert (StringTableEntry key, StringTableEntry value, S32 index)
S32	moveFirst ()
S32	moveLast ()
S32	moveNext ()
S32	movePrev ()
void	moveIndex (S32 prev, S32 index)
void	pop_back ()
void	pop_front ()
void	push_back (StringTableEntry key, StringTableEntry value)
void	push_front (StringTableEntry key, StringTableEntry value)
void	sort (bool valtest, bool desc, bool numeric)
void	uniqueKey ()
void	uniqueValue ()
	DECLARE_CONOBJECT (Array)
Public Member Functions inherited from SimObject
StringTableEntry	getClassNamespace () const
StringTableEntry	getSuperClassNamespace () const
void	setClassNamespace (const char *classNamespace)
void	setSuperClassNamespace (const char *superClassNamespace)
void	pushScriptCallbackGuard (void)
void	popScriptCallbackGuard (void)
S32	getScriptCallbackGuard (void)
virtual SimObject *	findObject (const char *name)
Namespace *	getNamespace ()
	Return the object's namespace.
const char *	tabComplete (const char *prevText, S32 baseLen, bool)
virtual void	dump ()
virtual void	dumpClassHierarchy ()
SimObject *	clone (const bool copyDynamicFields)
virtual void	copyTo (SimObject *object)
template<typename T >
bool	isType (void)
virtual bool	handlesConsoleMethod (const char *fname, S32 *routingId)
	DECLARE_CONOBJECT (SimObject)
Notify *	removeNotify (void *ptr, Notify::Type)
	Remove a notification from the list.
void	deleteNotify (SimObject *obj)
	Notify an object when we are deleted.
void	clearNotify (SimObject *obj)
	Notify an object when we are cleared.
void	clearAllNotifications ()
	Remove all notifications for this object.
void	processDeleteNotifies ()
	Send out deletion notifications.
void	registerReference (SimObject **obj)
void	unregisterReference (SimObject **obj)
void	addListener (std::string objID)
void	removeListener (std::string objID)
void	removeAllListeners ()
void	postEvent (std::string eventName, std::string data)
const char *	getDataField (StringTableEntry slotName, const char *array)
virtual void	setDataField (StringTableEntry slotName, const char *array, const char *value)
const char *	getPrefixedDataField (StringTableEntry fieldName, const char *array)
void	setPrefixedDataField (StringTableEntry fieldName, const char *array, const char *value)
const char *	getPrefixedDynamicDataField (StringTableEntry fieldName, const char *array, const S32 fieldType=-1)
void	setPrefixedDynamicDataField (StringTableEntry fieldName, const char *array, const char *value, const S32 fieldType=-1)
StringTableEntry	getDataFieldPrefix (StringTableEntry fieldName)
U32	getDataFieldType (StringTableEntry slotName, const char *array)
SimFieldDictionary *	getFieldDictionary ()
void	clearDynamicFields (void)
	Clear all dynamic fields.
void	setCanSaveDynamicFields (bool bCanSave)
	Set whether fields created at runtime should be saved. Default is true.
bool	getCanSaveDynamicFields (void) const
	Get whether fields created at runtime should be saved. Default is true.
void	setInternalName (const char *newname)
StringTableEntry	getInternalName ()
	Get the internal of of this control.
virtual bool	save (const char *pcFilePath, bool bOnlySelected=false)
	Save object as a TorqueScript File.
virtual bool	isMethod (const char *methodName)
	Check if a method exists in the objects current namespace.
SimObjectId	getId (void) const
StringTableEntry	getIdString (void) const
U32	getType () const
const StringTableEntry	getName (void) const
void	setId (SimObjectId id)
void	assignName (const char *name)
SimGroup *	getGroup () const
bool	isChildOfGroup (SimGroup *pGroup)
bool	isProperlyAdded () const
bool	isDeleted () const
bool	isRemoved () const
bool	isLocked () const
void	setLocked (bool b)
bool	isHidden () const
void	setHidden (bool b)
void	setProgenitorFile (const char *pFile)
StringTableEntry	getProgenitorFile (void) const
void	setPeriodicTimerID (const S32 timerID)
S32	getPeriodicTimerID (void) const
bool	isPeriodicTimerActive (void) const
bool	isSelected () const
bool	isExpanded () const
void	setSelected (bool sel)
void	setExpanded (bool exp)
void	setModDynamicFields (bool dyn)
void	setModStaticFields (bool sta)
	SimObject ()
virtual	~SimObject ()
virtual bool	processArguments (S32 argc, const char **argv)
	Process constructor options. (ie, new SimObject(1,2,3))
virtual void	onGroupAdd ()
	Called when the object is added to a SimGroup.
virtual void	onGroupRemove ()
	Called when the object is removed from a SimGroup.
virtual void	onNameChange (const char *name)
	Called when the object's name is changed.
virtual void	onStaticModified (const char *slotName, const char *newValue=NULL)
virtual void	inspectPreApply ()
virtual void	inspectPostApply ()
virtual void	onDeleteNotify (SimObject *object)
virtual void	onEditorEnable ()
	Called when the editor is activated.
virtual void	onEditorDisable ()
	Called when the editor is deactivated.
bool	registerObject ()
bool	registerObject (U32 id)
bool	registerObject (const char *name)
bool	registerObject (const char *name, U32 id)
void	unregisterObject ()
void	deleteObject ()
bool	addToSet (SimObjectId)
bool	addToSet (const char *)
bool	removeFromSet (SimObjectId)
bool	removeFromSet (const char *)
virtual bool	writeField (StringTableEntry fieldname, const char *value)
virtual void	write (Stream &stream, U32 tabStop, U32 flags=0)
virtual void	writeFields (Stream &stream, U32 tabStop)
virtual bool	writeObject (Stream *stream)
virtual bool	readObject (Stream *stream)
virtual void	buildFilterList ()
void	addFieldFilter (const char *fieldName)
void	removeFieldFilter (const char *fieldName)
void	clearFieldFilters ()
bool	isFiltered (const char *fieldName)
void	assignFieldsFrom (SimObject *obj)
void	assignDynamicFieldsFrom (SimObject *obj)
Public Member Functions inherited from ConsoleObject
const AbstractClassRep::Field *	findField (StringTableEntry fieldName) const
	Get a reference to a field by name.
virtual AbstractClassRep *	getClassRep () const
	Gets the ClassRep.
bool	setField (const char *fieldName, const char *value)
	Set the value of a field.
virtual	~ConsoleObject ()
const AbstractClassRep::FieldList &	getFieldList () const
	Get a list of all the fields. This information cannot be modified.
AbstractClassRep::FieldList &	getModifiableFieldList ()
bool &	getDynamicGroupExpand ()
S32	getClassId (U32 netClassGroup) const
const char *	getClassName () const

Public Attributes
S32	mCurrentIndex
Vector< Element >	mArray

Additional Inherited Members
Public Types inherited from SimObject
enum	WriteFlags { SelectedOnly = BIT(0) }
Static Public Member Functions inherited from SimObject
static void	initPersistFields ()
Static Public Member Functions inherited from ConsoleObject
static const char *	lookupClassName (const U32 in_classTag)
	Get the classname from a class tag.
static void	initPersistFields ()
static void	consoleInit ()
static AbstractClassRep *	getStaticClassRep ()
	Get the abstract class information for this class.
static AbstractClassRep *	getParentStaticClassRep ()
	Get the abstract class information for this class's superclass.
static ConsoleObject *	create (const char *in_pClassName)
static ConsoleObject *	create (const U32 groupId, const U32 typeId, const U32 in_classId)
Static Public Attributes inherited from SimObject
static bool	disableNameChanging = false
Protected Member Functions inherited from SimObject
virtual void	onTamlPreWrite (void)
	Taml callbacks.
virtual void	onTamlPostWrite (void)
	Called after Taml has finished writing the object.
virtual void	onTamlPreRead (void)
	Called prior to Taml reading the object.
virtual void	onTamlPostRead (const TamlCustomNodes &customNodes)
virtual void	onTamlAddParent (SimObject *pParentObject)
	Called after Taml has finished reading the object and has added the object to any parent.
virtual void	onTamlCustomWrite (TamlCustomNodes &customNodes)
	Called during the writing of the object to allow custom properties to be written.
virtual void	onTamlCustomRead (const TamlCustomNodes &customNodes)
	Called during the reading of the object to allow custom properties to be read.
void	linkNamespaces ()
void	unlinkNamespaces ()
Protected Member Functions inherited from ConsoleObject
	ConsoleObject ()
	ConsoleObject (const ConsoleObject &)
Static Protected Member Functions inherited from SimObject
static bool	setClass (void *obj, const char *data)
static bool	setSuperClass (void *obj, const char *data)
static bool	writeObjectName (void *obj, StringTableEntry pFieldName)
static bool	writeCanSaveDynamicFields (void *obj, StringTableEntry pFieldName)
static bool	writeInternalName (void *obj, StringTableEntry pFieldName)
static bool	setParentGroup (void *obj, const char *data)
static bool	writeParentGroup (void *obj, StringTableEntry pFieldName)
static bool	writeSuperclass (void *obj, StringTableEntry pFieldName)
static bool	writeClass (void *obj, StringTableEntry pFieldName)
static bool	setProtectedName (void *obj, const char *data)
static SimObject::Notify *	allocNotify ()
	Get a free Notify structure.
static void	freeNotify (SimObject::Notify *)
	Mark a Notify structure as free.
Static Protected Member Functions inherited from ConsoleObject
static void	addGroup (const char *in_pGroupname, const char *in_pGroupDocs=NULL)
static void	endGroup (const char *in_pGroupname)
static void	addField (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, const U32 in_elementCount=1, EnumTable *in_table=NULL, const char *in_pFieldDocs=NULL)
static void	addField (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, AbstractClassRep::WriteDataNotify in_writeDataFn, const U32 in_elementCount=1, EnumTable *in_table=NULL, const char *in_pFieldDocs=NULL)
static void	addField (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, const char *in_pFieldDocs)
static void	addField (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, AbstractClassRep::WriteDataNotify in_writeDataFn, const char *in_pFieldDocs)
static void	addFieldV (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, ConsoleTypeValidator *v, const char *in_pFieldDocs=NULL)
static void	addProtectedField (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, AbstractClassRep::SetDataNotify in_setDataFn, AbstractClassRep::GetDataNotify in_getDataFn=&defaultProtectedGetFn, const U32 in_elementCount=1, EnumTable *in_table=NULL, const char *in_pFieldDocs=NULL)
static void	addProtectedField (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, AbstractClassRep::SetDataNotify in_setDataFn, AbstractClassRep::GetDataNotify in_getDataFn=&defaultProtectedGetFn, AbstractClassRep::WriteDataNotify in_writeDataFn=&defaultProtectedWriteFn, const U32 in_elementCount=1, EnumTable *in_table=NULL, const char *in_pFieldDocs=NULL)
static void	addProtectedField (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, AbstractClassRep::SetDataNotify in_setDataFn, AbstractClassRep::GetDataNotify in_getDataFn=&defaultProtectedGetFn, const char *in_pFieldDocs=NULL)
static void	addProtectedField (const char *in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, AbstractClassRep::SetDataNotify in_setDataFn, AbstractClassRep::GetDataNotify in_getDataFn=&defaultProtectedGetFn, AbstractClassRep::WriteDataNotify in_writeDataFn=&defaultProtectedWriteFn, const char *in_pFieldDocs=NULL)
static void	addDepricatedField (const char *fieldName)
static bool	removeField (const char *in_pFieldname)
Protected Attributes inherited from SimObject
SimObjectId	mId
	Id number for this object.
StringTableEntry	mIdString
Namespace *	mNameSpace
U32	mTypeMask
S32	mScriptCallbackGuard
	Whether the object is executing a script callback.
bool	mCanSaveFieldDictionary
	true if dynamic fields (added at runtime) should be saved, defaults to true
StringTableEntry	mInternalName
	Stores object Internal Name.
StringTableEntry	mClassName
	Stores the class name to link script class namespaces.
StringTableEntry	mSuperClassName
	Stores super class name to link script class namespaces.
Static Protected Attributes inherited from SimObject
static SimObject::Notify *	mNotifyFreeList = NULL

Detailed Description

A data structure holding indexed sequences of key/value pairs for script use.

Constructor & Destructor Documentation

Array()

Array

(

)

Member Function Documentation

append()

void append

(

Array *

obj

)

count()

S32 count

(

)

countKey()

S32 countKey

(

StringTableEntry

key

)

countValue()

S32 countValue

(

StringTableEntry

value

)

crop()

void crop

(

Array *

obj

)

DECLARE_CONOBJECT()

DECLARE_CONOBJECT

(

Array

)

duplicate()

void duplicate

(

Array *

obj

)

echo()

void echo

(

)

empty()

void empty

(

)

erase()

void erase

(

S32

index

)

getCurrent()

S32 getCurrent

(

)

getIndexFromKey()

S32 getIndexFromKey

(

StringTableEntry

key

)

getIndexFromKeyValue()

S32 getIndexFromKeyValue	(	StringTableEntry	key,
		StringTableEntry	value
	)

getIndexFromValue()

S32 getIndexFromValue

(

StringTableEntry

value

)

getKeyFromIndex()

StringTableEntry getKeyFromIndex

(

S32

index

)

getValueFromIndex()

StringTableEntry getValueFromIndex

(

S32

index

)

insert()

void insert	(	StringTableEntry	key,
		StringTableEntry	value,
		S32	index
	)

moveFirst()

S32 moveFirst

(

)

moveIndex()

void moveIndex	(	S32	prev,
		S32	index
	)

moveLast()

S32 moveLast

(

)

moveNext()

S32 moveNext

(

)

movePrev()

S32 movePrev

(

)

onAdd()

bool onAdd ( void  )

virtual

Called when the object is added to the sim.

Reimplemented from SimObject.

onRemove()

void onRemove ( )

virtual

Called when the object is removed from the sim.

Reimplemented from SimObject.

pop_back()

void pop_back

(

)

pop_front()

void pop_front

(

)

push_back()

void push_back	(	StringTableEntry	key,
		StringTableEntry	value
	)

push_front()

void push_front	(	StringTableEntry	key,
		StringTableEntry	value
	)

setCurrent()

void setCurrent

(

S32

idx

)

setKey()

void setKey	(	StringTableEntry	key,
		S32	index
	)

setValue()

void setValue	(	StringTableEntry	value,
		S32	index
	)

sort()

void sort	(	bool	valtest,
		bool	desc,
		bool	numeric
	)

uniqueKey()

void uniqueKey

(

)

uniqueValue()

void uniqueValue

(

)

Member Data Documentation

mArray

Vector<Element> mArray

mCurrentIndex

S32 mCurrentIndex

---

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

• console/arrayObject.h
• console/arrayObject.cpp