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

Behavior instance. More...

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

Classes

class  MuteListener
 Trigger listener to change muted state of speaker. More...
 
class  PlayingListener
 Trigger listener to change playing state of speaker. More...
 

Public Member Functions

void addListener (Listener listener)
 Add listener. More...
 
void addToGameWorld ()
 Add element to game world. More...
 
void dispose ()
 Dispose of behavior instance. More...
 
ECBehaviorSpeaker getECBehavior ()
 Create speaker layer mask. More...
 
bool getMuted ()
 Speaker is muted. More...
 
bool getPlaying ()
 Speaker is playing. More...
 
Speaker getSpeaker ()
 Speaker. More...
 
SynthesizerController getSynthesizerControllerAt (int index)
 Snthesizer controller or null if not used. More...
 
SynthesizerController getSynthesizerControllerNamed (String name)
 Named snthesizer controller or null if not used. More...
 
SynthesizerInstance getSynthesizerInstance ()
 Synthesizer instance or null if not used. More...
 
ECBehaviorTriggered.Instance getTriggerMuted ()
 Muted speaker trigger expression or null if not used. More...
 
void init (StubElement stub)
 Initialize element from stub. More...
 
Instance new (ECBehaviorSpeaker ecbehavior, BehaviorElement element)
 Create element. More...
 
void readFromFile (PersistencyEnvironment env, FileReader reader)
 Read element from file. More...
 
void removeFromGameWorld ()
 Remove element from game world. More...
 
void removeListener (Listener listener)
 Remove listener. More...
 
void setMuted (bool muted)
 Set if speaker is muted. More...
 
void setPlaying (bool playing)
 Set if speaker is playing. More...
 
void stateChanged ()
 State changed (visble, touchable). More...
 
void toggle ()
 Toggle speaker playing state. More...
 
void writeToFile (PersistencyEnvironment env, FileWriter writer)
 
- Public Member Functions inherited from Dragengine.Scenery.DefaultECBehaviorInstance
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...
 
bool requiresEnterFrame ()
 Behavior instance requires enterFrame() to be called. More...
 
bool requiresThink ()
 Behavior instance requires think() to be called. More...
 
void think (float elapsed)
 Think about what to do for the next frame update. More...
 

Protected Member Functions

void attachSpeaker (StubElement stub, ECBehaviorCollider.Instance collider)
 Attach speaker to collider. More...
 
Speaker createSpeaker (StubElement stub)
 Create speaker. More...
 
ECBehaviorTriggered.Instance getTriggerBehavior ()
 Get playing trigger behavior. More...
 
ECBehaviorTriggered.Instance getTriggerMutedBehavior ()
 Get muted trigger behavior. 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

◆ addListener()

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

Add listener.

◆ addToGameWorld()

void Dragengine.Scenery.ECBehaviorSpeaker.Instance.addToGameWorld ( )

Add element to game world.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ attachSpeaker()

void Dragengine.Scenery.ECBehaviorSpeaker.Instance.attachSpeaker ( StubElement  stub,
ECBehaviorCollider.Instance  collider 
)
protected

Attach speaker to collider.

Default implementation calls ECComposeAttachResource.attach().

◆ createSpeaker()

Speaker Dragengine.Scenery.ECBehaviorSpeaker.Instance.createSpeaker ( StubElement  stub)
protected

Create speaker.

Default implementation calls ECComposeSpeaker.createSpeaker().

◆ dispose()

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

Dispose of behavior instance.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ getECBehavior()

ECBehaviorSpeaker Dragengine.Scenery.ECBehaviorSpeaker.Instance.getECBehavior ( )

Create speaker layer mask.

Default implementation calls ECComposeSpeaker.createLayerMask.

Behavior.

◆ getMuted()

bool Dragengine.Scenery.ECBehaviorSpeaker.Instance.getMuted ( )

Speaker is muted.

◆ getPlaying()

bool Dragengine.Scenery.ECBehaviorSpeaker.Instance.getPlaying ( )

Speaker is playing.

◆ getSpeaker()

Speaker Dragengine.Scenery.ECBehaviorSpeaker.Instance.getSpeaker ( )

◆ getSynthesizerControllerAt()

SynthesizerController Dragengine.Scenery.ECBehaviorSpeaker.Instance.getSynthesizerControllerAt ( int  index)

Snthesizer controller or null if not used.

◆ getSynthesizerControllerNamed()

SynthesizerController Dragengine.Scenery.ECBehaviorSpeaker.Instance.getSynthesizerControllerNamed ( String  name)

Named snthesizer controller or null if not used.

◆ getSynthesizerInstance()

SynthesizerInstance Dragengine.Scenery.ECBehaviorSpeaker.Instance.getSynthesizerInstance ( )

Synthesizer instance or null if not used.

◆ getTriggerBehavior()

ECBehaviorTriggered.Instance Dragengine.Scenery.ECBehaviorSpeaker.Instance.getTriggerBehavior ( )
protected

Get playing trigger behavior.

Default implementation uses owner class trigger behavior. If getSyncTrigger() of parent ECBehaviorSpeaker is not null uses referenced behavior trigger behavior.

◆ getTriggerMuted()

ECBehaviorTriggered.Instance Dragengine.Scenery.ECBehaviorSpeaker.Instance.getTriggerMuted ( )

Muted speaker trigger expression or null if not used.

◆ getTriggerMutedBehavior()

ECBehaviorTriggered.Instance Dragengine.Scenery.ECBehaviorSpeaker.Instance.getTriggerMutedBehavior ( )
protected

Get muted trigger behavior.

Default implementation uses owner class trigger behavior. If getSyncTrigger() of parent ECBehaviorSpeaker is not null uses referenced behavior trigger behavior.

◆ init()

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

Initialize element from stub.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ new()

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

Create element.

◆ readFromFile()

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

Read element from file.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ removeFromGameWorld()

void Dragengine.Scenery.ECBehaviorSpeaker.Instance.removeFromGameWorld ( )

Remove element from game world.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ removeListener()

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

Remove listener.

◆ setMuted()

void Dragengine.Scenery.ECBehaviorSpeaker.Instance.setMuted ( bool  muted)

Set if speaker is muted.

◆ setPlaying()

void Dragengine.Scenery.ECBehaviorSpeaker.Instance.setPlaying ( bool  playing)

Set if speaker is playing.

◆ stateChanged()

void Dragengine.Scenery.ECBehaviorSpeaker.Instance.stateChanged ( )

State changed (visble, touchable).

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ toggle()

void Dragengine.Scenery.ECBehaviorSpeaker.Instance.toggle ( )

Toggle speaker playing state.

◆ writeToFile()

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

Writes the element to a file.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.


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