DynamicConsoleMethodComponent Class Reference

#include <dynamicConsoleMethodComponent_ScriptBinding.h>

Inherits SimComponent.

Inherited by BehaviorComponent.

Public Member Functions
String	callOnBehaviors (methodName, argi)
Public Member Functions inherited from SimComponent
Boolean	addComponents (compObjName, compObjName2,...)
Integer	getComponent (idx)
Integer	getComponentCount ()
Boolean	isEnabled ()
Boolean	removeComponents (compObjName, compObjName2,...)
void	setEnabled (enabled)
Public Member Functions inherited from SimObject
void	assignFieldsFrom (SimObject)
Integer	clone ([copyDynamicFields=false]?)
void	delete ()
Integer	getId ()
void	setName (newName)
String	getName ()
String	getClassNamespace ()
String	getSuperClassNamespace ()
void	setClassNamespace (nameSpace)
void	setSuperClassNamespace ()
Boolean	isMethod (string methodName)
String	call (methodName, [args] *)
void	dumpClassHierarchy ()
void	dump ()
Boolean	isMemberOfClass (string classname)
String	getClassName ()
String	getFieldValue (fieldName)
Boolean	setFieldValue (fieldName, value)
Boolean	setEditFieldValue (fieldName, value)
Integer	getDynamicFieldCount ()
String	getDynamicField (index)
Integer	getFieldCount ()
String	getField (int index)
void	setProgenitorFile (file)
String	getProgenitorFile ()
Integer	getType ()
String	getFieldType (fieldName)
void	setInternalName (string InternalName)
String	getInternalName ()
Boolean	isChildOfGroup (groupID)
Integer	getGroup ()
Boolean	startTimer (callbackFunction, float timePeriod, [repeat]?)
void	stopTimer ()
Boolean	isTimerActive ()
Integer	schedule (time, command, [arg] *)
void	startListening (SimObject)
void	stopListening (SimObject)
void	addListener (SimObject)
void	removeListener (SimObject)
void	removeAllListeners ()
void	postEvent (String eventName, String data)
Boolean	save (fileName, [selectedOnly]?)
void	addFieldFilter (fieldName)
void	removeFieldFilter (fieldName)

Member Function Documentation

callOnBehaviors()

String callOnBehaviors	(	methodName	,
		argi
	)

Calls script defined method on first behavior that defines it.

Parameters

methodName	The method's name as a string
argi	Any arguments to pass to the method

Returns

Any returned value from the behavior that handles the method, or the string 'ERR_CALL_NOT_HANDLED' if no behavior can handle the method.