Main   GitHub

Methods | Fields | List of all members
DynamicConsoleMethodComponent Class Reference

Inherits SimComponent, and SimComponent.

Inherited by BehaviorComponent, and BehaviorComponent.

Methods

string callOnBehaviors (methodName, argi)
 
string callOnBehaviors (methodName, argi)
 
- Methods inherited from SimComponent
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 SimComponent
bool Enabled
 
bool canSaveDynamicFields
 
string internalName
 
SimObjectPtr parentGroup
 
string superclass
 
string class
 
- Fields inherited from SimObject
bool canSaveDynamicFields
 
string internalName
 
SimObjectPtr parentGroup
 
string superclass
 
string class
 

Methods

string DynamicConsoleMethodComponent::callOnBehaviors ( methodName  ,
argi   
)

Calls script defined method on first behavior that defines it. Example: obj.callOnBehaviors( methodName, arg1, arg2, ... );

Parameters
methodNameThe method's name as a string
argiAny 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.
string DynamicConsoleMethodComponent::callOnBehaviors ( methodName  ,
argi   
)

Calls script defined method on first behavior that defines it. Example: obj.callOnBehaviors( methodName, arg1, arg2, ... );

Parameters
methodNameThe method's name as a string
argiAny 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.

Member Data Documentation

bool DynamicConsoleMethodComponent::canSaveDynamicFields
string DynamicConsoleMethodComponent::class

Script SuperClass of object.

bool DynamicConsoleMethodComponent::Enabled
string DynamicConsoleMethodComponent::internalName
SimObjectPtr DynamicConsoleMethodComponent::parentGroup

Group hierarchy parent of the object.

string DynamicConsoleMethodComponent::superclass

Script Class of object.



Copyright © 2013 GarageGames, LLC. All Rights Reserved.