Drag[en]gine Script Module DragonScript  1.21
Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance Class Reference

Behavior instance. More...

Inheritance diagram for Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance:
Dragengine.Scenery.DefaultECBehaviorInstance Dragengine.Scenery.ECBehaviorInstance

Classes

enum  State
 State. More...
 
class  SwitchStateListener
 Trigger listener to switch state. More...
 

Public Member Functions

void activate ()
 If in deactivated state start transition to activated state. More...
 
void activate (float startTime)
 If in deactivated state start transition to activated state. More...
 
void activate (float startTime, bool force)
 If in deactivated state start transition to activated state. More...
 
void addListenerFactory (Block blockFactory)
 Add listener factory using block. More...
 
void addListenerFactory (ListenerFactory factory)
 Add listener factory. More...
 
AnimatorInstance createAnimatorInstance (Element element, StubElement stub)
 Initialize animator instance for element from stub. More...
 
void createListeners (Instance instance)
 Create listeners from factories adding them to behavior instance. More...
 
void deactivate (float startTime, bool force)
 If in activated state start transition to deactivated state. More...
 
void dispose ()
 Dispose of composeable instance. More...
 
void dispose ()
 Dispose of behavior. More...
 
void forEachListenerFactory (Block ablock)
 Visit listener factories with block with argument ListenerFactory. More...
 
ECPAnimation getAnimation ()
 Animation resource. More...
 
ECPAnimator getAnimator ()
 Animator resource. More...
 
AnimatorInstance getAnimatorInstance ()
 Animator instance. More...
 
ECBehaviorComponent.Instance getComponent ()
 Component behavior. More...
 
ECBehaviorComponent getComponent ()
 Component behavior to animate. More...
 
AnimatorController getControllerActivate ()
 Activate animator controller or null. More...
 
AnimatorController getControllerActivated ()
 Activated playback animator controller or null. More...
 
AnimatorController getControllerDeactivate ()
 Deactivate animator controller or null. More...
 
AnimatorController getControllerDeactivated ()
 Deactivated playback animator controller or null. More...
 
String getControllerNameActivated ()
 Name of activated controller. More...
 
String getControllerNameActivating ()
 Name of activate controller. More...
 
String getControllerNameDeactivated ()
 Name of deactivated controller. More...
 
String getControllerNameDeactivating ()
 Name of deactivate controller. More...
 
ECBehaviorTwoStateAnimated getECBehavior ()
 Behavior. More...
 
float getPercentageDoneActivate ()
 Percentage of activating done in the range from 0 to 1. More...
 
float getPercentageDoneDeactivate ()
 Percentage of deactivating done in the range from 0 to 1. More...
 
float getPlaySpeed ()
 Playback speed. More...
 
ECPFloat getPlaySpeed ()
 Play speed. More...
 
State getState ()
 State. More...
 
TSNamedTriggerTarget getTargetActivated ()
 Trigger target to reflect activated state. More...
 
ECPString getTargetActivated ()
 Target activate. More...
 
TSNamedTriggerTarget getTargetActivating ()
 Trigger target to reflect activating state. More...
 
ECPString getTargetActivating ()
 Target activating. More...
 
TSNamedTriggerTarget getTargetDeactivating ()
 Trigger target to reflect deactivating state. More...
 
ECPString getTargetDeactivating ()
 Target deactivating. More...
 
ECBehaviorTriggered.Instance getTrigger ()
 Activate trigger or null if not used. More...
 
ECBehaviorTriggered getTrigger ()
 Trigger activate. More...
 
TSTriggerTable getTriggerTable ()
 Trigger table to link trigger expression to or null if not set. More...
 
TSTriggerTable getTriggerTable ()
 Trigger table or null if not used. More...
 
void init (StubElement stub)
 Initialize element from stub. More...
 
bool isActivated ()
 Is in activated state. More...
 
bool isActivating ()
 Is activating. More...
 
bool isDeactivated ()
 Is in deactivated state. More...
 
bool isDeactivating ()
 Is deactivating. More...
 
Instance new (BehaviorElementClass eclass, ECBehaviorComponent component, Loaders loaders, TSTriggerTable triggerTable, String id)
 Create behavior element class. More...
 
Instance new (BehaviorElementClass eclass, ECBehaviorComponent component, Loaders loaders, TSTriggerTable triggerTable, String id, String subID)
 
Instance new (BehaviorElementClass eclass, ECBehaviorComponent component, Loaders loaders, TSTriggerTable triggerTable, String id, String subID, String prefix)
 
Instance new (ECBehaviorTwoStateAnimated ecbehavior, BehaviorElement element)
 Create element. More...
 
void setControllerNameActivated (String name)
 Set name of activated controller. More...
 
void setControllerNameActivating (String name)
 Set name of activate controller. More...
 
void setControllerNameDeactivated (String name)
 Set name of deactivated controller. More...
 
void setControllerNameDeactivating (String name)
 Set name of deactivate controller. More...
 
void setControllerNames (String deactivated, String activated, String activating, String deactivating)
 Set names of controllers. More...
 
void setPlaySpeed (float playSpeed)
 Set playback speed. More...
 
void think (float elapsed)
 Think about what to do for the next frame update. More...
 
- Public Member Functions inherited from Dragengine.Scenery.DefaultECBehaviorInstance
void addToGameWorld ()
 Add element to game world. More...
 
void attachToParent (Element parent)
 Attach element to object set by the mapper in the IGDE World Editor. More...
 
void enterFrame ()
 Frame update started. More...
 
void geometryChanged ()
 Position or orientation changed. More...
 
BehaviorElement getElement ()
 Behavior element to apply behavior to. More...
 
int getInstanceIndex ()
 Behavior instance index. More...
 
DefaultECBehaviorInstance new (BehaviorElement element)
 Create default composeable instance. More...
 
void postThink (float elapsed)
 Post thinking after physics processing is finished. More...
 
void readFromFile (PersistencyEnvironment env, FileReader reader)
 Read behavior instance from file. More...
 
void removeFromGameWorld ()
 Remove element from game world. More...
 
bool requiresEnterFrame ()
 Behavior instance requires enterFrame() to be called. More...
 
bool requiresThink ()
 Behavior instance requires think() to be called. More...
 
void stateChanged ()
 State changed (visble, touchable). More...
 
void writeToFile (PersistencyEnvironment env, FileWriter writer)
 Write behavior instance to file. More...
 

Static Public Member Functions

static ECBehaviorTwoStateAnimated getBehaviorIn (BehaviorElementClass eclass)
 Get behavior in element class or null if absent. More...
 

Public Attributes

AnimatorInstance pAnimatorInstance
 
ECBehaviorComponent.Instance pComponent
 
AnimatorController pControllerActivate
 
AnimatorController pControllerActivated
 
AnimatorController pControllerDeactivate
 
AnimatorController pControllerDeactivated
 
ECBehaviorTwoStateAnimated pECBehavior
 
Array pListeners
 
float pPlaySpeed
 
State pState
 
TSNamedTriggerTarget pTargetActivated
 
TSNamedTriggerTarget pTargetActivating
 
TSNamedTriggerTarget pTargetDeactivating
 
ECBehaviorTriggered.Instance pTrigger
 
TSTriggerTable pTriggerTable
 

Protected Member Functions

AnimatorInstance createAnimatorInstance (StubElement stub)
 Create animator instance for the element. More...
 
String getAnimatorSource (StubElement stub)
 Source identification for use with exceptions only. More...
 
void setState (State state)
 Set state. More...
 
void setTriggerTable (TSTriggerTable triggerTable)
 Trigger table to link trigger expression to or null if not set. More...
 
void setTriggerTable (TSTriggerTable triggerTable)
 Set trigger table or null if not used. More...
 
void updateAnimator (float elapsed)
 Update animator. More...
 
- Protected Member Functions inherited from Dragengine.Scenery.DefaultECBehaviorInstance
void setRequiresEnterFrame (bool required)
 Set if behavior instance requires enterFrame() to be called. More...
 
void setRequiresThink (bool required)
 Set if behavior instance requires think() to be called. More...
 

Detailed Description

Behavior instance.

Member Function Documentation

◆ activate() [1/3]

void Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.activate ( )

If in deactivated state start transition to activated state.

◆ activate() [2/3]

void Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.activate ( float  startTime)

If in deactivated state start transition to activated state.

Parameters
startTimeSet playback time startTime after controller lower value.

◆ activate() [3/3]

void Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.activate ( float  startTime,
bool  force 
)

If in deactivated state start transition to activated state.

Parameters
startTimeSet playback time startTime after controller lower value.

◆ addListenerFactory() [1/2]

void Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.addListenerFactory ( Block  blockFactory)

Add listener factory using block.

Block receives as parameter Instance and returns Listener.

◆ addListenerFactory() [2/2]

void Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.addListenerFactory ( ListenerFactory  factory)

Add listener factory.

◆ createAnimatorInstance() [1/2]

AnimatorInstance Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.createAnimatorInstance ( Element  element,
StubElement  stub 
)

Initialize animator instance for element from stub.

Assigns the animator and animation to the instance. If at least one controller is present then the first controller is initialized as playback controller. The clamping around and frozen state are set to the looping, respectivily playing parameter The element is responsible to assign a Component to the animator instance.

◆ createAnimatorInstance() [2/2]

AnimatorInstance Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.createAnimatorInstance ( StubElement  stub)
protected

Create animator instance for the element.

Default implementation uses createAnimatorInstance().

◆ createListeners()

void Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.createListeners ( Instance  instance)

Create listeners from factories adding them to behavior instance.

◆ deactivate()

void Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.deactivate ( float  startTime,
bool  force 
)

If in activated state start transition to deactivated state.

Parameters
startTimeSet playback time startTime after controller lower value.

◆ dispose() [1/2]

void Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.dispose ( )

Dispose of composeable instance.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ dispose() [2/2]

void Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.dispose ( )

Dispose of behavior.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ forEachListenerFactory()

void Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.forEachListenerFactory ( Block  ablock)

Visit listener factories with block with argument ListenerFactory.

◆ getAnimation()

ECPAnimation Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.getAnimation ( )

Animation resource.

◆ getAnimator()

ECPAnimator Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.getAnimator ( )

Animator resource.

◆ getAnimatorInstance()

AnimatorInstance Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.getAnimatorInstance ( )

Animator instance.

◆ getAnimatorSource()

String Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.getAnimatorSource ( StubElement  stub)
protected

Source identification for use with exceptions only.

Default implementation returns relevant stub parameter or class property depending on which one is set.

◆ getBehaviorIn()

static ECBehaviorTwoStateAnimated Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.getBehaviorIn ( BehaviorElementClass  eclass)
static

Get behavior in element class or null if absent.

Use this method to check if a particular BehaviorElementClass contains a behavior of type ECBehaviorComponent.

◆ getComponent() [1/2]

ECBehaviorComponent.Instance Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.getComponent ( )

Component behavior.

◆ getComponent() [2/2]

ECBehaviorComponent Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.getComponent ( )

Component behavior to animate.

◆ getControllerActivate()

AnimatorController Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.getControllerActivate ( )

Activate animator controller or null.

◆ getControllerActivated()

AnimatorController Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.getControllerActivated ( )

Activated playback animator controller or null.

◆ getControllerDeactivate()

AnimatorController Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.getControllerDeactivate ( )

Deactivate animator controller or null.

◆ getControllerDeactivated()

AnimatorController Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.getControllerDeactivated ( )

Deactivated playback animator controller or null.

◆ getControllerNameActivated()

String Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.getControllerNameActivated ( )

Name of activated controller.

◆ getControllerNameActivating()

String Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.getControllerNameActivating ( )

Name of activate controller.

◆ getControllerNameDeactivated()

String Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.getControllerNameDeactivated ( )

Name of deactivated controller.

◆ getControllerNameDeactivating()

String Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.getControllerNameDeactivating ( )

Name of deactivate controller.

◆ getECBehavior()

ECBehaviorTwoStateAnimated Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.getECBehavior ( )

Behavior.

◆ getPercentageDoneActivate()

float Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.getPercentageDoneActivate ( )

Percentage of activating done in the range from 0 to 1.

◆ getPercentageDoneDeactivate()

float Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.getPercentageDoneDeactivate ( )

Percentage of deactivating done in the range from 0 to 1.

◆ getPlaySpeed() [1/2]

float Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.getPlaySpeed ( )

Playback speed.

◆ getPlaySpeed() [2/2]

ECPFloat Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.getPlaySpeed ( )

Play speed.

◆ getState()

State Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.getState ( )

◆ getTargetActivated() [1/2]

TSNamedTriggerTarget Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.getTargetActivated ( )

Trigger target to reflect activated state.

◆ getTargetActivated() [2/2]

ECPString Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.getTargetActivated ( )

Target activate.

◆ getTargetActivating() [1/2]

TSNamedTriggerTarget Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.getTargetActivating ( )

Trigger target to reflect activating state.

◆ getTargetActivating() [2/2]

ECPString Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.getTargetActivating ( )

Target activating.

◆ getTargetDeactivating() [1/2]

TSNamedTriggerTarget Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.getTargetDeactivating ( )

Trigger target to reflect deactivating state.

◆ getTargetDeactivating() [2/2]

ECPString Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.getTargetDeactivating ( )

Target deactivating.

◆ getTrigger() [1/2]

ECBehaviorTriggered.Instance Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.getTrigger ( )

Activate trigger or null if not used.

◆ getTrigger() [2/2]

ECBehaviorTriggered Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.getTrigger ( )

Trigger activate.

◆ getTriggerTable() [1/2]

TSTriggerTable Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.getTriggerTable ( )

Trigger table to link trigger expression to or null if not set.

◆ getTriggerTable() [2/2]

TSTriggerTable Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.getTriggerTable ( )

Trigger table or null if not used.

◆ init()

void Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.init ( StubElement  stub)

Initialize element from stub.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ isActivated()

bool Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.isActivated ( )

Is in activated state.

◆ isActivating()

bool Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.isActivating ( )

Is activating.

◆ isDeactivated()

bool Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.isDeactivated ( )

Is in deactivated state.

◆ isDeactivating()

bool Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.isDeactivating ( )

Is deactivating.

◆ new() [1/4]

Instance Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.new ( BehaviorElementClass  eclass,
ECBehaviorComponent  component,
Loaders  loaders,
TSTriggerTable  triggerTable,
String  id 
)

Create behavior element class.

◆ new() [2/4]

Instance Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.new ( BehaviorElementClass  eclass,
ECBehaviorComponent  component,
Loaders  loaders,
TSTriggerTable  triggerTable,
String  id,
String  subID 
)

◆ new() [3/4]

Instance Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.new ( BehaviorElementClass  eclass,
ECBehaviorComponent  component,
Loaders  loaders,
TSTriggerTable  triggerTable,
String  id,
String  subID,
String  prefix 
)

◆ new() [4/4]

Instance Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.new ( ECBehaviorTwoStateAnimated  ecbehavior,
BehaviorElement  element 
)

Create element.

◆ setControllerNameActivated()

void Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.setControllerNameActivated ( String  name)

Set name of activated controller.

◆ setControllerNameActivating()

void Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.setControllerNameActivating ( String  name)

Set name of activate controller.

◆ setControllerNameDeactivated()

void Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.setControllerNameDeactivated ( String  name)

Set name of deactivated controller.

◆ setControllerNameDeactivating()

void Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.setControllerNameDeactivating ( String  name)

Set name of deactivate controller.

◆ setControllerNames()

void Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.setControllerNames ( String  deactivated,
String  activated,
String  activating,
String  deactivating 
)

Set names of controllers.

◆ setPlaySpeed()

void Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.setPlaySpeed ( float  playSpeed)

Set playback speed.

◆ setState()

void Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.setState ( State  state)
protected

Set state.

◆ setTriggerTable() [1/2]

void Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.setTriggerTable ( TSTriggerTable  triggerTable)
protected

Trigger table to link trigger expression to or null if not set.

◆ setTriggerTable() [2/2]

void Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.setTriggerTable ( TSTriggerTable  triggerTable)
protected

Set trigger table or null if not used.

◆ think()

void Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.think ( float  elapsed)

Think about what to do for the next frame update.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ updateAnimator()

void Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.updateAnimator ( float  elapsed)
protected

Update animator.

Member Data Documentation

◆ pAnimatorInstance

AnimatorInstance Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.pAnimatorInstance

◆ pComponent

ECBehaviorComponent.Instance Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.pComponent

◆ pControllerActivate

AnimatorController Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.pControllerActivate

◆ pControllerActivated

AnimatorController Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.pControllerActivated

◆ pControllerDeactivate

AnimatorController Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.pControllerDeactivate

◆ pControllerDeactivated

AnimatorController Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.pControllerDeactivated

◆ pECBehavior

ECBehaviorTwoStateAnimated Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.pECBehavior

◆ pListeners

Array Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.pListeners

◆ pPlaySpeed

float Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.pPlaySpeed

◆ pState

State Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.pState

◆ pTargetActivated

TSNamedTriggerTarget Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.pTargetActivated

◆ pTargetActivating

TSNamedTriggerTarget Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.pTargetActivating

◆ pTargetDeactivating

TSNamedTriggerTarget Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.pTargetDeactivating

◆ pTrigger

ECBehaviorTriggered.Instance Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.pTrigger

◆ pTriggerTable

TSTriggerTable Dragengine.Scenery.ECBehaviorTwoStateAnimated.Instance.pTriggerTable

The documentation for this class was generated from the following file: