Drag[en]gine Script Module DragonScript  1.23
Dragengine.Scenery.ECBehaviorFootSteps.Instance Class Reference

Behavior instance. More...

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

Public Member Functions

void addConfiguration (Configuration configuration)
 Add configuration. More...
 
void addListener (Listener listener)
 Add listener. More...
 
void dispose ()
 Dispose of composeable instance. More...
 
Configuration findConfiguration (Block ablock)
 Find configuration with block receiving argument Configuration returning true if found. More...
 
void forEachConfiguration (Block ablock)
 Visit configurations with block receiving argument Configuration. More...
 
bool getAutoUpdate ()
 Call update() automatically on postThink(). More...
 
Configuration getConfigurationAt (String id)
 Configuration with ID or null if not found. More...
 
int getConfigurationCount ()
 Number of configurations. More...
 
ECBehaviorFootSteps getECBehavior ()
 Behavior. More...
 
float getElapsed ()
 Elapsed time since start of interval. More...
 
LayerMask getLayerMask ()
 Layer mask to use for created speakers. More...
 
int getNextEvent ()
 Index of next foot step event. More...
 
void init (StubElement stub)
 Initialize element from stub. More...
 
Instance new (ECBehaviorFootSteps ecbehavior, BehaviorElement element)
 Create element. More...
 
void postThink (float elapsed)
 Post thinking after physics processing is finished. More...
 
void readFromFile (PersistencyEnvironment env, FileReader reader)
 Read behavior from file. More...
 
void removeAllConfigurations ()
 Remove all configurations. More...
 
void removeConfiguration (Configuration configuration)
 Remove configuration. More...
 
void removeListener (Listener listener)
 Remove listener. More...
 
void reset ()
 Reset to start of interval. More...
 
bool setActiveConfiguration (Configuration configuration, bool resetIfChanged)
 Set active configuration or null if none is active. More...
 
bool setActiveConfigurationWithID (String id, bool resetIfChanged)
 Set active configuration by ID or null if not found. More...
 
void setAutoUpdate (bool autoUpdate)
 Set if update() is automatically called on postThink(). More...
 
void setElapsed (float elapsed)
 Set elapsed time since start of interval. More...
 
void setLayerMask (LayerMask layerMask)
 Set layer mask to use for created speakers. More...
 
void update (float elapsed)
 Update foot steps. More...
 
void update (float elapsed, bool relative)
 Update foot steps. More...
 
void writeToFile (PersistencyEnvironment env, FileWriter writer)
 Write behavior to file. 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 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 think (float elapsed)
 Think about what to do for the next frame update. More...
 

Public Attributes

Configuration pActiveConfiguration
 
bool pAutoUpdate
 
Dictionary pConfigurations
 
ECBehaviorFootSteps pECBehavior
 
float pElapsed
 
LayerMask pLayerMask
 
Array pListeners
 
int pNextEvent
 

Protected Member Functions

void setNextEvent (int index)
 Set index of next foot step event. 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

◆ addConfiguration()

void Dragengine.Scenery.ECBehaviorFootSteps.Instance.addConfiguration ( Configuration  configuration)

Add configuration.

◆ addListener()

void Dragengine.Scenery.ECBehaviorFootSteps.Instance.addListener ( Listener  listener)

Add listener.

◆ dispose()

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

Dispose of composeable instance.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ findConfiguration()

Configuration Dragengine.Scenery.ECBehaviorFootSteps.Instance.findConfiguration ( Block  ablock)

Find configuration with block receiving argument Configuration returning true if found.

◆ forEachConfiguration()

void Dragengine.Scenery.ECBehaviorFootSteps.Instance.forEachConfiguration ( Block  ablock)

Visit configurations with block receiving argument Configuration.

◆ getAutoUpdate()

bool Dragengine.Scenery.ECBehaviorFootSteps.Instance.getAutoUpdate ( )

Call update() automatically on postThink().

◆ getConfigurationAt()

Configuration Dragengine.Scenery.ECBehaviorFootSteps.Instance.getConfigurationAt ( String  id)

Configuration with ID or null if not found.

◆ getConfigurationCount()

int Dragengine.Scenery.ECBehaviorFootSteps.Instance.getConfigurationCount ( )

Number of configurations.

◆ getECBehavior()

ECBehaviorFootSteps Dragengine.Scenery.ECBehaviorFootSteps.Instance.getECBehavior ( )

Behavior.

◆ getElapsed()

float Dragengine.Scenery.ECBehaviorFootSteps.Instance.getElapsed ( )

Elapsed time since start of interval.

◆ getLayerMask()

LayerMask Dragengine.Scenery.ECBehaviorFootSteps.Instance.getLayerMask ( )

Layer mask to use for created speakers.

◆ getNextEvent()

int Dragengine.Scenery.ECBehaviorFootSteps.Instance.getNextEvent ( )

Index of next foot step event.

◆ init()

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

Initialize element from stub.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ new()

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

Create element.

◆ postThink()

void Dragengine.Scenery.ECBehaviorFootSteps.Instance.postThink ( float  elapsed)

Post thinking after physics processing is finished.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ readFromFile()

void Dragengine.Scenery.ECBehaviorFootSteps.Instance.readFromFile ( PersistencyEnvironment  env,
FileReader  reader 
)

Read behavior from file.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ removeAllConfigurations()

void Dragengine.Scenery.ECBehaviorFootSteps.Instance.removeAllConfigurations ( )

Remove all configurations.

◆ removeConfiguration()

void Dragengine.Scenery.ECBehaviorFootSteps.Instance.removeConfiguration ( Configuration  configuration)

Remove configuration.

◆ removeListener()

void Dragengine.Scenery.ECBehaviorFootSteps.Instance.removeListener ( Listener  listener)

Remove listener.

◆ reset()

void Dragengine.Scenery.ECBehaviorFootSteps.Instance.reset ( )

Reset to start of interval.

◆ setActiveConfiguration()

bool Dragengine.Scenery.ECBehaviorFootSteps.Instance.setActiveConfiguration ( Configuration  configuration,
bool  resetIfChanged 
)

Set active configuration or null if none is active.

Returns
true if configuration changed or false if it is the same.

◆ setActiveConfigurationWithID()

bool Dragengine.Scenery.ECBehaviorFootSteps.Instance.setActiveConfigurationWithID ( String  id,
bool  resetIfChanged 
)

Set active configuration by ID or null if not found.

If ID is not null calls setActiveConfiguration(). If ID is null calls clearActiveConfiguration().

Returns
true if configuration changed or false if it is the same.

◆ setAutoUpdate()

void Dragengine.Scenery.ECBehaviorFootSteps.Instance.setAutoUpdate ( bool  autoUpdate)

Set if update() is automatically called on postThink().

◆ setElapsed()

void Dragengine.Scenery.ECBehaviorFootSteps.Instance.setElapsed ( float  elapsed)

Set elapsed time since start of interval.

◆ setLayerMask()

void Dragengine.Scenery.ECBehaviorFootSteps.Instance.setLayerMask ( LayerMask  layerMask)

Set layer mask to use for created speakers.

◆ setNextEvent()

void Dragengine.Scenery.ECBehaviorFootSteps.Instance.setNextEvent ( int  index)
protected

Set index of next foot step event.

Index will be clamped to range from 0 to getEventCount().

◆ update() [1/2]

void Dragengine.Scenery.ECBehaviorFootSteps.Instance.update ( float  elapsed)

Update foot steps.

Advances elapsed playing foot steps if events are trigered. Same as update(float,bool) called with true as parameter for relative.

◆ update() [2/2]

void Dragengine.Scenery.ECBehaviorFootSteps.Instance.update ( float  elapsed,
bool  relative 
)

Update foot steps.

Advances elapsed playing foot steps if events are trigered.

Parameters
relativeIf true increments elapsed time otherwise sets elapsed time. If false and elapsed time is smaller than current elapsed time the time is considered to have elapsed past the interval and wrapped around.

◆ writeToFile()

void Dragengine.Scenery.ECBehaviorFootSteps.Instance.writeToFile ( PersistencyEnvironment  env,
FileWriter  writer 
)

Write behavior to file.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

Member Data Documentation

◆ pActiveConfiguration

Configuration Dragengine.Scenery.ECBehaviorFootSteps.Instance.pActiveConfiguration

◆ pAutoUpdate

bool Dragengine.Scenery.ECBehaviorFootSteps.Instance.pAutoUpdate

◆ pConfigurations

Dictionary Dragengine.Scenery.ECBehaviorFootSteps.Instance.pConfigurations

◆ pECBehavior

ECBehaviorFootSteps Dragengine.Scenery.ECBehaviorFootSteps.Instance.pECBehavior

◆ pElapsed

float Dragengine.Scenery.ECBehaviorFootSteps.Instance.pElapsed

◆ pLayerMask

LayerMask Dragengine.Scenery.ECBehaviorFootSteps.Instance.pLayerMask

◆ pListeners

Array Dragengine.Scenery.ECBehaviorFootSteps.Instance.pListeners

◆ pNextEvent

int Dragengine.Scenery.ECBehaviorFootSteps.Instance.pNextEvent

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