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

Composable speaker for element class. More...

Inheritance diagram for Dragengine.Scenery.ECComposeSpeaker:

Public Member Functions

Speaker createSpeaker ()
 Create speaker. More...
 
Speaker createSpeaker (Element element, StubElement stub)
 Initialize speaker for element from stub. More...
 
TSTriggerExpression createTriggerMuted (Element element, StubElement stub)
 Create muted speaker trigger expression from stub or null if not used. More...
 
TSTriggerExpression createTriggerMuted (Element element, StubElement stub, String defaultValue)
 Create muted speaker trigger expression from stub or null if not used. More...
 
TSTriggerExpression createTriggerPlaying (Element element, StubElement stub)
 Create playing speaker trigger expression from stub or null if not used. More...
 
TSTriggerExpression createTriggerPlaying (Element element, StubElement stub, String defaultValue)
 Create playing speaker trigger expression from stub or null if not used. More...
 
ECPFloat getDistanceOffset ()
 Distance offset. More...
 
LayerMask getLayerMask ()
 Layer mask. More...
 
ECPBoolean getLooping ()
 Speaker is looping. More...
 
ECPBoolean getMuted ()
 Speaker is muted. More...
 
ECPBoolean getPlaying ()
 Speaker is playing. More...
 
ECPFloat getPlaySpeed ()
 Play speed. More...
 
String getPrefix ()
 Property prefix. More...
 
ECPFloat getRange ()
 Speaker range. More...
 
ECPFloat getRollOff ()
 Roll off. More...
 
ECPShapeList getShape ()
 Speaker shape. More...
 
ECPSound getSound ()
 Speaker sound. More...
 
ECPEnumeration getSpeakerType ()
 Speaker type. More...
 
ECPSynthesizer getSynthesizer ()
 Speaker synthesizer. More...
 
ECPFloat getVolume ()
 Speaker volume. More...
 
ECComposeSpeaker new (ElementClass ownerClass, Loaders loaders)
 Create composable element class. More...
 
ECComposeSpeaker new (ElementClass ownerClass, Loaders loaders, String prefix)
 Create composable element class. More...
 
void setLayerMask (LayerMask layerMask)
 Set layer mask. More...
 

Detailed Description

Composable speaker for element class.

Provides speaker support to element class without subclassing from a specific class.

Member Function Documentation

◆ createSpeaker() [1/2]

Speaker Dragengine.Scenery.ECComposeSpeaker.createSpeaker ( )

Create speaker.

◆ createSpeaker() [2/2]

Speaker Dragengine.Scenery.ECComposeSpeaker.createSpeaker ( Element  element,
StubElement  stub 
)

Initialize speaker for element from stub.

◆ createTriggerMuted() [1/2]

TSTriggerExpression Dragengine.Scenery.ECComposeSpeaker.createTriggerMuted ( Element  element,
StubElement  stub 
)

Create muted speaker trigger expression from stub or null if not used.

◆ createTriggerMuted() [2/2]

TSTriggerExpression Dragengine.Scenery.ECComposeSpeaker.createTriggerMuted ( Element  element,
StubElement  stub,
String  defaultValue 
)

Create muted speaker trigger expression from stub or null if not used.

◆ createTriggerPlaying() [1/2]

TSTriggerExpression Dragengine.Scenery.ECComposeSpeaker.createTriggerPlaying ( Element  element,
StubElement  stub 
)

Create playing speaker trigger expression from stub or null if not used.

◆ createTriggerPlaying() [2/2]

TSTriggerExpression Dragengine.Scenery.ECComposeSpeaker.createTriggerPlaying ( Element  element,
StubElement  stub,
String  defaultValue 
)

Create playing speaker trigger expression from stub or null if not used.

◆ getDistanceOffset()

ECPFloat Dragengine.Scenery.ECComposeSpeaker.getDistanceOffset ( )

Distance offset.

◆ getLayerMask()

LayerMask Dragengine.Scenery.ECComposeSpeaker.getLayerMask ( )

Layer mask.

◆ getLooping()

ECPBoolean Dragengine.Scenery.ECComposeSpeaker.getLooping ( )

Speaker is looping.

◆ getMuted()

ECPBoolean Dragengine.Scenery.ECComposeSpeaker.getMuted ( )

Speaker is muted.

◆ getPlaying()

ECPBoolean Dragengine.Scenery.ECComposeSpeaker.getPlaying ( )

Speaker is playing.

◆ getPlaySpeed()

ECPFloat Dragengine.Scenery.ECComposeSpeaker.getPlaySpeed ( )

Play speed.

◆ getPrefix()

String Dragengine.Scenery.ECComposeSpeaker.getPrefix ( )

Property prefix.

◆ getRange()

ECPFloat Dragengine.Scenery.ECComposeSpeaker.getRange ( )

Speaker range.

◆ getRollOff()

ECPFloat Dragengine.Scenery.ECComposeSpeaker.getRollOff ( )

Roll off.

◆ getShape()

ECPShapeList Dragengine.Scenery.ECComposeSpeaker.getShape ( )

Speaker shape.

◆ getSound()

ECPSound Dragengine.Scenery.ECComposeSpeaker.getSound ( )

Speaker sound.

◆ getSpeakerType()

ECPEnumeration Dragengine.Scenery.ECComposeSpeaker.getSpeakerType ( )

Speaker type.

◆ getSynthesizer()

ECPSynthesizer Dragengine.Scenery.ECComposeSpeaker.getSynthesizer ( )

Speaker synthesizer.

◆ getVolume()

ECPFloat Dragengine.Scenery.ECComposeSpeaker.getVolume ( )

Speaker volume.

◆ new() [1/2]

ECComposeSpeaker Dragengine.Scenery.ECComposeSpeaker.new ( ElementClass  ownerClass,
Loaders  loaders 
)

Create composable element class.

Adds all properties to ownerClass. If you do not want a property to be configurable using XML subclassing use ownerClass.removeProperty() to remove them.

◆ new() [2/2]

ECComposeSpeaker Dragengine.Scenery.ECComposeSpeaker.new ( ElementClass  ownerClass,
Loaders  loaders,
String  prefix 
)

Create composable element class.

Adds all properties to ownerClass. If you do not want a property to be configurable using XML subclassing use ownerClass.removeProperty() to remove them.

◆ setLayerMask()

void Dragengine.Scenery.ECComposeSpeaker.setLayerMask ( LayerMask  layerMask)

Set layer mask.


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