Inherits SimObject, and SimObject.

Inherited by DynamicConsoleMethodComponent, and DynamicConsoleMethodComponent.

Methods
bool	addComponents (%compObjName,%compObjName2,...)

bool	addComponents (%compObjName,%compObjName2,...)

int	getComponent (idx)

int	getComponent (idx)

int	getComponentCount ()

int	getComponentCount ()

bool	isEnabled ()

bool	isEnabled ()

bool	removeComponents (%compObjName,%compObjName2,...)

bool	removeComponents (%compObjName,%compObjName2,...)

void	setEnabled (enabled)

void	setEnabled (enabled)

Methods inherited from SimObject
void	addFieldFilter (fieldName)

void	addFieldFilter (fieldName)

string	call (%args)

string	call (%args)

int	clone ([bool copyDynamicFields?=false])

int	clone ([bool copyDynamicFields?=false])

void	delete ()

void	delete ()

void	dump ()

void	dump ()

void	dumpClassHierarchy ()

void	dumpClassHierarchy ()

string	getClassName ()

string	getClassName ()

string	getClassNamespace ()

string	getClassNamespace ()

string	getDynamicField (index)

string	getDynamicField (index)

int	getDynamicFieldCount ()

int	getDynamicFieldCount ()

string	getField (int index)

string	getField (int index)

int	getFieldCount ()

int	getFieldCount ()

string	getFieldType (fieldName)

string	getFieldType (fieldName)

string	getFieldValue (fieldName)

string	getFieldValue (fieldName)

int	getGroup ()

int	getGroup ()

int	getId ()

int	getId ()

string	getInternalName ()

string	getInternalName ()

string	getName ()

string	getName ()

string	getProgenitorFile ()

string	getProgenitorFile ()

string	getSuperClassNamespace ()

string	getSuperClassNamespace ()

int	getType ()

int	getType ()

bool	isChildOfGroup ()

bool	isChildOfGroup ()

bool	isMemberOfClass (string classname)

bool	isMemberOfClass (string classname)

bool	isMethod (string method name)

bool	isMethod (string method name)

bool	isTimerActive ()

bool	isTimerActive ()

void	removeFieldFilter (fieldName)

void	removeFieldFilter (fieldName)

bool	save (fileName,[selectedOnly])

bool	save (fileName,[selectedOnly])

int	schedule (time, command,< arg1...argN >)

int	schedule (time, command,< arg1...argN >)

void	setClassNamespace ()

void	setClassNamespace ()

bool	setFieldValue (fieldName, value)

bool	setFieldValue (fieldName, value)

void	setInternalName ()

void	setInternalName ()

void	setName (newName)

void	setName (newName)

void	setProgenitorFile (file)

void	setProgenitorFile (file)

void	setSuperClassNamespace ()

void	setSuperClassNamespace ()

bool	startTimer (callbackFunction, float timePeriod,[repeat])

bool	startTimer (callbackFunction, float timePeriod,[repeat])

void	stopTimer ()

void	stopTimer ()

Fields
bool	Enabled

SimBase
bool	canSaveDynamicFields

string	internalName

SimObjectPtr	parentGroup

Namespace Linking
string	superclass

string	class

Fields inherited from SimObject
bool	canSaveDynamicFields

string	internalName

SimObjectPtr	parentGroup

string	superclass

string	class

Methods

bool SimComponent::addComponents	(	%	compObjName,
		%	compObjName2,
			...
	)

bool SimComponent::addComponents	(	%	compObjName,
		%	compObjName2,
			...
	)

int SimComponent::getComponent ( idx )

Get the component corresponding to the given index.

Parameters

idx	An integer index value corresponding to the desired component.

Returns: The id of the component at the given index as an integer

int SimComponent::getComponent ( idx )

Get the component corresponding to the given index.

Parameters

idx	An integer index value corresponding to the desired component.

Returns: The id of the component at the given index as an integer

int SimComponent::getComponentCount ( )

Get the current component count

Returns: The number of components in the list as an integer

int SimComponent::getComponentCount ( )

Get the current component count

Returns: The number of components in the list as an integer

bool SimComponent::isEnabled ( )

Check whether SimComponent is currently enabled

Returns: true if enabled and false if not

bool SimComponent::isEnabled ( )

Check whether SimComponent is currently enabled

Returns: true if enabled and false if not

bool SimComponent::removeComponents	(	%	compObjName,
		%	compObjName2,
			...
	)

bool SimComponent::removeComponents	(	%	compObjName,
		%	compObjName2,
			...
	)

void SimComponent::setEnabled ( enabled )

Sets or unsets the enabled flag

Parameters

enabled Boolean value

Returns: No return value

void SimComponent::setEnabled ( enabled )

Sets or unsets the enabled flag

Parameters

enabled Boolean value

Returns: No return value

Member Data Documentation

bool SimComponent::canSaveDynamicFields

string SimComponent::class

Script SuperClass of object.

bool SimComponent::Enabled

string SimComponent::internalName

SimObjectPtr SimComponent::parentGroup

Group hierarchy parent of the object.

string SimComponent::superclass

Script Class of object.