Inherits DynamicConsoleMethodComponent, and DynamicConsoleMethodComponent.
Inherited by Scene, Scene, SceneObject, and SceneObject.
Methods | |
| bool | addBehavior (BehaviorInstance bi) |
| bool | addBehavior (BehaviorInstance bi) |
| void | clearBehaviors () |
| void | clearBehaviors () |
| bool | connect (outputBehavior, inputBehavior, outputName, inputName) |
| bool | connect (outputBehavior, inputBehavior, outputName, inputName) |
| bool | disconnect (outputBehavior, inputBehavior, outputName, inputName) |
| bool | disconnect (outputBehavior, inputBehavior, outputName, inputName) |
| int | getBehavior (string BehaviorTemplateName) |
| int | getBehavior (string BehaviorTemplateName) |
| int | getBehaviorByIndex (int index) |
| int | getBehaviorByIndex (int index) |
| string | getBehaviorConnection (outputBehavior, outputName, connectionIndex) |
| string | getBehaviorConnection (outputBehavior, outputName, connectionIndex) |
| int | getBehaviorConnectionCount (outputBehavior, outputName) |
| int | getBehaviorConnectionCount (outputBehavior, outputName) |
| int | getBehaviorCount () |
| int | getBehaviorCount () |
| bool | raise (outputBehavior, outputName,[deltaTime]) |
| bool | raise (outputBehavior, outputName,[deltaTime]) |
| bool | removeBehavior (BehaviorInstance bi,[bool deleteBehavior=true]) |
| bool | removeBehavior (BehaviorInstance bi,[bool deleteBehavior=true]) |
| bool | reOrder (BehaviorInstance inst,[int desiredIndex=0]) |
| bool | reOrder (BehaviorInstance inst,[int desiredIndex=0]) |
 Methods inherited from DynamicConsoleMethodComponent | |
| 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 DynamicConsoleMethodComponent | |
| bool | Enabled |
| bool | canSaveDynamicFields |
| string | internalName |
| SimObjectPtr | parentGroup |
| 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
| bool BehaviorComponent::addBehavior | ( | BehaviorInstance | bi | ) |
- Add a behavior to the object
- Parameters
-
bi The behavior instance to add
- Returns
- (bool success) Whether or not the behavior was successfully added
| bool BehaviorComponent::addBehavior | ( | BehaviorInstance | bi | ) |
- Add a behavior to the object
- Parameters
-
bi The behavior instance to add
- Returns
- (bool success) Whether or not the behavior was successfully added
| void BehaviorComponent::clearBehaviors | ( | ) |
- Clear all behavior instances
- Returns
- No return value
| void BehaviorComponent::clearBehaviors | ( | ) |
- Clear all behavior instances
- Returns
- No return value
| bool BehaviorComponent::connect | ( | outputBehavior | , |
| inputBehavior | , | ||
| outputName | , | ||
| inputName | |||
| ) |
- Connects a behavior output to a behavior input.
- Parameters
-
outputBehavior The behavior that owns the output. inputBehavior The behavior that owns the input. outputName The output name owned by the output behavior. inputName The input name owned by the input behavior.
- Returns
- (bool success) Whether the connection was successful or not.
| bool BehaviorComponent::connect | ( | outputBehavior | , |
| inputBehavior | , | ||
| outputName | , | ||
| inputName | |||
| ) |
- Connects a behavior output to a behavior input.
- Parameters
-
outputBehavior The behavior that owns the output. inputBehavior The behavior that owns the input. outputName The output name owned by the output behavior. inputName The input name owned by the input behavior.
- Returns
- (bool success) Whether the connection was successful or not.
| bool BehaviorComponent::disconnect | ( | outputBehavior | , |
| inputBehavior | , | ||
| outputName | , | ||
| inputName | |||
| ) |
- Connects a behavior output to a behavior input.
- Parameters
-
outputBehavior The behavior that owns the output. inputBehavior The behavior that owns the input. outputName The output name owned by the output behavior. inputName The input name owned by the input behavior.
- Returns
- (bool success) Whether the disconnection was successful or not.
| bool BehaviorComponent::disconnect | ( | outputBehavior | , |
| inputBehavior | , | ||
| outputName | , | ||
| inputName | |||
| ) |
- Connects a behavior output to a behavior input.
- Parameters
-
outputBehavior The behavior that owns the output. inputBehavior The behavior that owns the input. outputName The output name owned by the output behavior. inputName The input name owned by the input behavior.
- Returns
- (bool success) Whether the disconnection was successful or not.
| int BehaviorComponent::getBehavior | ( | string | BehaviorTemplateName | ) |
- gets a behavior
- Parameters
-
BehaviorTemplateName The name of the template of the behavior instance you want
- Returns
- (BehaviorInstance bi) The behavior instance you requested
| int BehaviorComponent::getBehavior | ( | string | BehaviorTemplateName | ) |
- gets a behavior
- Parameters
-
BehaviorTemplateName The name of the template of the behavior instance you want
- Returns
- (BehaviorInstance bi) The behavior instance you requested
| int BehaviorComponent::getBehaviorByIndex | ( | int | index | ) |
- Gets a particular behavior
- Parameters
-
index The index of the behavior to get
- Returns
- (BehaviorInstance bi) The behavior instance you requested
| int BehaviorComponent::getBehaviorByIndex | ( | int | index | ) |
- Gets a particular behavior
- Parameters
-
index The index of the behavior to get
- Returns
- (BehaviorInstance bi) The behavior instance you requested
| string BehaviorComponent::getBehaviorConnection | ( | outputBehavior | , |
| outputName | , | ||
| connectionIndex | |||
| ) |
- Gets a comma-delimited list of connections on the behavior output on the specified behavior.
- Parameters
-
outputBehavior The behavior that owns the output. outputName The output name owned by the output behavior. connectionIndex The connection index.
- Returns
- Returns a comma-delimited list of connections on the behavior output on the specified behavior of the format <OutputBehavior>,<InputBehavior>,<OutputName>,<InputName>.
| string BehaviorComponent::getBehaviorConnection | ( | outputBehavior | , |
| outputName | , | ||
| connectionIndex | |||
| ) |
- Gets a comma-delimited list of connections on the behavior output on the specified behavior.
- Parameters
-
outputBehavior The behavior that owns the output. outputName The output name owned by the output behavior. connectionIndex The connection index.
- Returns
- Returns a comma-delimited list of connections on the behavior output on the specified behavior of the format <OutputBehavior>,<InputBehavior>,<OutputName>,<InputName>.
| int BehaviorComponent::getBehaviorConnectionCount | ( | outputBehavior | , |
| outputName | |||
| ) |
- Gets the number of connections on the behavior output on the specified behavior.
- Parameters
-
outputBehavior The behavior that owns the output. outputName The output name owned by the output behavior.
- Returns
- The number of connections on the behavior output on the specified behavior.
| int BehaviorComponent::getBehaviorConnectionCount | ( | outputBehavior | , |
| outputName | |||
| ) |
- Gets the number of connections on the behavior output on the specified behavior.
- Parameters
-
outputBehavior The behavior that owns the output. outputName The output name owned by the output behavior.
- Returns
- The number of connections on the behavior output on the specified behavior.
| int BehaviorComponent::getBehaviorCount | ( | ) |
- Get the count of behaviors on an object
- Returns
- (int count) The number of behaviors on an object
| int BehaviorComponent::getBehaviorCount | ( | ) |
- Get the count of behaviors on an object
- Returns
- (int count) The number of behaviors on an object
| bool BehaviorComponent::raise | ( | outputBehavior | , |
| outputName | |||
| ) |
- Raise a signal on the behavior output on the specified behavior.
- Parameters
-
outputBehavior The behavior that owns the output. outputName The output name owned by the output behavior. [deltaTime] Optional time-delta (ms) when the raise should occur.
- Returns
- (bool success) Whether the signal raise was successful or not.
| bool BehaviorComponent::raise | ( | outputBehavior | , |
| outputName | |||
| ) |
- Raise a signal on the behavior output on the specified behavior.
- Parameters
-
outputBehavior The behavior that owns the output. outputName The output name owned by the output behavior. [deltaTime] Optional time-delta (ms) when the raise should occur.
- Returns
- (bool success) Whether the signal raise was successful or not.
| bool BehaviorComponent::removeBehavior | ( | BehaviorInstance | bi | ) |
- Parameters
-
bi The behavior instance to remove deleteBehavior Whether or not to delete the behavior
- Returns
- (bool success) Whether the behavior was successfully removed
| bool BehaviorComponent::removeBehavior | ( | BehaviorInstance | bi | ) |
- Parameters
-
bi The behavior instance to remove deleteBehavior Whether or not to delete the behavior
- Returns
- (bool success) Whether the behavior was successfully removed
| bool BehaviorComponent::reOrder | ( | BehaviorInstance | inst | ) |
- Parameters
-
inst The behavior instance you want to reorder desiredIndex The index you want the behavior instance to be reordered to
- Returns
- (bool success) Whether or not the behavior instance was successfully reordered
| bool BehaviorComponent::reOrder | ( | BehaviorInstance | inst | ) |
- Parameters
-
inst The behavior instance you want to reorder desiredIndex The index you want the behavior instance to be reordered to
- Returns
- (bool success) Whether or not the behavior instance was successfully reordered
Member Data Documentation
| bool BehaviorComponent::canSaveDynamicFields |
| string BehaviorComponent::class |
Script SuperClass of object.
| bool BehaviorComponent::Enabled |
| string BehaviorComponent::internalName |
| SimObjectPtr BehaviorComponent::parentGroup |
Group hierarchy parent of the object.
| string BehaviorComponent::superclass |
Script Class of object.