| Behavior | Index |
Overview
These are the base properties for a Behavior object. Additional properties may be associated with specific primitives.
Defined values that may be used as parameters can be found in the aGarciaDefs.tea file in the aSystem subfolder of the brainstem directory tree.
Property Inheritance
Behavior inherits Object properties.
| Properties |
| completion-callback completion-status execute-callback expected-status primitive-name unique-id |
completion-callback (acpCallback*) A pointer to an acpCallback object whose call method will be executed when a behavior completes execution. This property may only be used in compiled programs. It is not used in XML scripts since there is no notion of object pointers in an XML script file. |
completion-status (int) The status of a behavior when it completes execution. READ-ONLY. |
execute-callback (acpCallback*) A pointer to an acpCallback object whose call method will be executed when a behavior begins execution. This property may only be used in compiled programs. It is not used in XML scripts since there is no notion of object pointers in an XML script file. |
expected-status (int) A status value that indicates succesful completion when a behavior terminates. Multiple expected status values may be supplied for a behavior. If no expected status values are supplied then the default expected status is the defined value aGARCIA_ERRFLAG_NORMAL . When a behavior terminates with an unexpected status value, all behaviors in the queue will be flushed. When executing an XML script, an unexpected status value will terminate the script. |
primitive-name (string) The type of primitive used to create the behavior. |
unique-id (int) A unique numeric ID for a behavior. While the Garcia API is running, it automatically gives each behavior a new sequential ID. |