De/Activate the behavior
true to enable the behavior, false to disable it
Return true if the behavior is activated
This method is called each tick after events are done.
This method is called each tick before events are done.
Return the Z position of the object center, relative to the scene origin.
Get the object size on the Z axis (called "depth").
Get the name of the behavior.
The behavior's name.
Get the name identifier of the behavior.
The behavior's name identifier.
Get the object rotation on the X axis in degree.
This is an Euler angle. Objects use the ZYX order.
Get the object rotation on the Y axis in degree.
This is an Euler angle. Objects use the ZYX order.
Get the scale of the object on Z axis.
the scale of the object on Z axis
Return the top Z of the object. Rotations around X and Y are not taken into account.
Return the bottom Z of the object. Rotations around X and Y are not taken into account.
Get the object position on the Z axis.
Reimplement this method to do extra work when the behavior is activated (after
it has been deactivated, see onDeActivate).
Reimplement this to do extra work when the behavior is created (i.e: an
object using it was created), after the object is fully initialized (so
you can use this.owner without risk).
Reimplement this method to do extra work when the behavior is deactivated.
This method is called when the owner of the behavior
is being removed from the scene and is about to be destroyed/reused later
or when the behavior is removed from an object (can happen in case of
hot-reloading only. Otherwise, behaviors are just de-activated,
not removed. See onDeActivate).
This method is called when the owner of the behavior was hot reloaded, so its position, angle, size can have been changed outside of events.
Change the object center Z position in the scene.
Set the object size on the Z axis (called "depth").
Set the object rotation on the X axis.
This is an Euler angle. Objects use the ZYX order.
Set the object rotation on the Y axis.
This is an Euler angle. Objects use the ZYX order.
Change the scale on Z axis of the object (changing its depth).
Set the object position on the Z axis.
Called at each frame after events. Call doStepPostEvents.
Behaviors writers: Please do not redefine this method. Redefine doStepPreEvents instead.
The instanceContainer owning the object
Called at each frame before events. Call doStepPreEvents.
Behaviors writers: Please do not redefine this method. Redefine doStepPreEvents instead.
The instanceContainer owning the object
Turn the object around the scene X axis at its center.
Turn the object around the scene Y axis at its center.
Turn the object around the scene Z axis at its center.
Called when the behavior must be updated using the specified behaviorData. This is the case during hot-reload, and is only called if the behavior was modified.
true if the behavior was updated, false if it could not (i.e: hot-reload is not supported).
Should return false if the behavior does not need any lifecycle function to
be called.
Default, hidden, "capability" behaviors set it to false.
This avoids useless calls to empty lifecycle functions, which would waste CPU
time (and have a sizeable impact for example when lots of static instances
are living in the scene).
Generated using TypeDoc
A behavior that forwards the Base3D interface to its object.