Behavior Class Reference
#include <Behavior.h>
Inheritance diagram for Behavior:
# Public Types | |
| typedef const BehaviorSpec | BehaviorROMSpec |
# Public Member Functions | |
| void | constructor (Entity owner, const BehaviorSpec *behaviorSpec) |
| void | enable () |
| Enable the behavior's operations. | |
| void | disable () |
| Disable the behavior's operations. | |
| bool | isEnabled () |
# Protected Attributes | |
| bool | enabled |
| Flag to allow or prohibit the behavior to perform its operations. | |
# Additional Inherited Members | |
 Private Types inherited from Component | |
| enum | ComponentCommands |
| enum | ComponentTypes |
| Private Member Functions inherited from Component | |
| void | constructor (Entity owner, const ComponentSpec *componentSpec) |
| void | destructor () |
| Class' destructor. | |
| ComponentSpec * | getSpec () |
| Entity | getOwner () |
| Retrieve the collider's owner. | |
| uint32 | getType () |
| virtual void | releaseResources () |
| Called to release the component. | |
| virtual void | handleCommand (int32 command, va_list args) |
| virtual RightBox | getRightBox () |
| Private Attributes inherited from Component | |
| Entity | owner |
| Object to which this component attaches to. | |
| const ComponentSpec * | componentSpec |
| Pointer to the spec that defines how to initialize the component. | |
| const Transformation * | transformation |
| bool | deleteMe |
| Flag to mark the component as pending deletion. | |
# Detailed Description
Class Behavior
Inherits from Component
Right now, this is only used by the Vehicle class in the plugins. Eventually, this will serve to avoid the need to inherit from Actor.
Definition at line 49 of file Behavior.h.
# Member Typedef Documentation
# BehaviorROMSpec
| typedef const BehaviorSpec BehaviorROMSpec |
A Behavior spec that is stored in ROM
Definition at line 37 of file Behavior.h.
# Member Function Documentation
# constructor()
| void Behavior::constructor | ( | Entity | owner, |
| const BehaviorSpec * | behaviorSpec ) |
Class' constructor
- Parameters
-
owner Entity to which the behavior attaches to behaviorSpec Specification that determines how to configure the behavior
Definition at line 22 of file Behavior.c.
# disable()
| void Behavior::disable | ( | ) |
Disable the behavior's operations.
Definition at line 47 of file Behavior.c.
# enable()
| void Behavior::enable | ( | ) |
Enable the behavior's operations.
Definition at line 40 of file Behavior.c.
# isEnabled()
| bool Behavior::isEnabled | ( | ) |
Check if the behavior's operations are enabled.
- Returns
- True if the behavior's operations are enabled; false otherwise
Definition at line 54 of file Behavior.c.
# Member Data Documentation
# enabled
|
protected |
Flag to allow or prohibit the behavior to perform its operations.
Definition at line 54 of file Behavior.h.
The documentation for this class was generated from the following files:
- VUEngine-Core/source/Component/Behavior/Behavior.h
- VUEngine-Core/source/Component/Behavior/Behavior.c