Drag[en]gine Script Module DragonScript  1.23
Public Member Functions | Public Attributes | List of all members
Dragengine.Scenery.ECBehaviorFootSteps.Event Class Reference

Foot step event. More...

Inheritance diagram for Dragengine.Scenery.ECBehaviorFootSteps.Event:

Public Member Functions

DVector getOffset ()
 Offset relative to actor coordinate system to play foot step at. More...
 
float getRange ()
 Range to use for created speakers. More...
 
float getRollOff ()
 Roll-off to use for created speakers. More...
 
WeightedRandomList getSounds ()
 List of sounds to pick one from to play this event. More...
 
float getTime ()
 Activation time. More...
 
String getType ()
 Optional type string (by default null). More...
 
float getVolume ()
 Volume to use for created speakers. More...
 
Event new (float time)
 Create foot step event. More...
 
Event new (float time, String type)
 
Event new (float time, WeightedRandomList sounds)
 
Event new (float time, WeightedRandomList sounds, float volume, float range)
 
Event new (float time, WeightedRandomList sounds, float volume, float range, DVector offset)
 
Event new (float time, WeightedRandomList sounds, float volume, float range, DVector offset, float rollOff)
 
Event new (float time, WeightedRandomList sounds, float volume, float range, DVector offset, float rollOff, String type)
 
Event new (float time, WeightedRandomList sounds, float volume, float range, DVector offset, String type)
 
Event new (float time, WeightedRandomList sounds, float volume, float range, float rollOff)
 
Event new (float time, WeightedRandomList sounds, float volume, float range, String type)
 
Event new (float time, WeightedRandomList sounds, String type)
 
Sound randomSound ()
 Random sound from the list of sounds to play or null if list is empty. More...
 
void setOffset (DVector offset)
 Set offset relative to actor coordinate system to play foot step at. More...
 
void setRange (float range)
 Set range to use for created speakers. More...
 
void setRollOff (float rollOff)
 Set roll-off to use for created speakers. More...
 
void setSounds (WeightedRandomList sounds)
 Set list of sounds to pick one from to play this event. More...
 
void setType (String type)
 Set optional type string or null if not needed. More...
 
void setVolume (float volume)
 Set volume to use for created speakers. More...
 

Public Attributes

Sound pLastRandomSound
 
DVector pOffset
 
float pRange
 
float pRollOff
 
WeightedRandomList pSounds
 
float pTime
 
String pType
 
float pVolume
 

Detailed Description

Foot step event.

Event time is immutable but all other parameters can be changed if required. Optionally a type can be assigned to identify the event type for use by other behaviors to know what sound or effects to produce.

Member Function Documentation

◆ getOffset()

DVector Dragengine.Scenery.ECBehaviorFootSteps.Event.getOffset ( )

Offset relative to actor coordinate system to play foot step at.

◆ getRange()

float Dragengine.Scenery.ECBehaviorFootSteps.Event.getRange ( )

Range to use for created speakers.

◆ getRollOff()

float Dragengine.Scenery.ECBehaviorFootSteps.Event.getRollOff ( )

Roll-off to use for created speakers.

◆ getSounds()

WeightedRandomList Dragengine.Scenery.ECBehaviorFootSteps.Event.getSounds ( )

List of sounds to pick one from to play this event.

◆ getTime()

float Dragengine.Scenery.ECBehaviorFootSteps.Event.getTime ( )

Activation time.

◆ getType()

String Dragengine.Scenery.ECBehaviorFootSteps.Event.getType ( )

Optional type string (by default null).

◆ getVolume()

float Dragengine.Scenery.ECBehaviorFootSteps.Event.getVolume ( )

Volume to use for created speakers.

◆ new() [1/11]

Event Dragengine.Scenery.ECBehaviorFootSteps.Event.new ( float  time)

Create foot step event.

◆ new() [2/11]

Event Dragengine.Scenery.ECBehaviorFootSteps.Event.new ( float  time,
String  type 
)

◆ new() [3/11]

Event Dragengine.Scenery.ECBehaviorFootSteps.Event.new ( float  time,
WeightedRandomList  sounds 
)

◆ new() [4/11]

Event Dragengine.Scenery.ECBehaviorFootSteps.Event.new ( float  time,
WeightedRandomList  sounds,
float  volume,
float  range 
)

◆ new() [5/11]

Event Dragengine.Scenery.ECBehaviorFootSteps.Event.new ( float  time,
WeightedRandomList  sounds,
float  volume,
float  range,
DVector  offset 
)

◆ new() [6/11]

Event Dragengine.Scenery.ECBehaviorFootSteps.Event.new ( float  time,
WeightedRandomList  sounds,
float  volume,
float  range,
DVector  offset,
float  rollOff 
)

◆ new() [7/11]

Event Dragengine.Scenery.ECBehaviorFootSteps.Event.new ( float  time,
WeightedRandomList  sounds,
float  volume,
float  range,
DVector  offset,
float  rollOff,
String  type 
)

◆ new() [8/11]

Event Dragengine.Scenery.ECBehaviorFootSteps.Event.new ( float  time,
WeightedRandomList  sounds,
float  volume,
float  range,
DVector  offset,
String  type 
)

◆ new() [9/11]

Event Dragengine.Scenery.ECBehaviorFootSteps.Event.new ( float  time,
WeightedRandomList  sounds,
float  volume,
float  range,
float  rollOff 
)

◆ new() [10/11]

Event Dragengine.Scenery.ECBehaviorFootSteps.Event.new ( float  time,
WeightedRandomList  sounds,
float  volume,
float  range,
String  type 
)

◆ new() [11/11]

Event Dragengine.Scenery.ECBehaviorFootSteps.Event.new ( float  time,
WeightedRandomList  sounds,
String  type 
)

◆ randomSound()

Sound Dragengine.Scenery.ECBehaviorFootSteps.Event.randomSound ( )

Random sound from the list of sounds to play or null if list is empty.

◆ setOffset()

void Dragengine.Scenery.ECBehaviorFootSteps.Event.setOffset ( DVector  offset)

Set offset relative to actor coordinate system to play foot step at.

Default is 5cm above acter center on ground.

◆ setRange()

void Dragengine.Scenery.ECBehaviorFootSteps.Event.setRange ( float  range)

Set range to use for created speakers.

Range will be clamped to 0 if negative. Default is 10.

◆ setRollOff()

void Dragengine.Scenery.ECBehaviorFootSteps.Event.setRollOff ( float  rollOff)

Set roll-off to use for created speakers.

Roll-off will be clamped to 0 if negative. Default is 1.

◆ setSounds()

void Dragengine.Scenery.ECBehaviorFootSteps.Event.setSounds ( WeightedRandomList  sounds)

Set list of sounds to pick one from to play this event.

◆ setType()

void Dragengine.Scenery.ECBehaviorFootSteps.Event.setType ( String  type)

Set optional type string or null if not needed.

◆ setVolume()

void Dragengine.Scenery.ECBehaviorFootSteps.Event.setVolume ( float  volume)

Set volume to use for created speakers.

Volume will be clamped to 0 if negative. Default is 1.

Member Data Documentation

◆ pLastRandomSound

Sound Dragengine.Scenery.ECBehaviorFootSteps.Event.pLastRandomSound

◆ pOffset

DVector Dragengine.Scenery.ECBehaviorFootSteps.Event.pOffset

◆ pRange

float Dragengine.Scenery.ECBehaviorFootSteps.Event.pRange

◆ pRollOff

float Dragengine.Scenery.ECBehaviorFootSteps.Event.pRollOff

◆ pSounds

WeightedRandomList Dragengine.Scenery.ECBehaviorFootSteps.Event.pSounds

◆ pTime

float Dragengine.Scenery.ECBehaviorFootSteps.Event.pTime

◆ pType

String Dragengine.Scenery.ECBehaviorFootSteps.Event.pType

◆ pVolume

float Dragengine.Scenery.ECBehaviorFootSteps.Event.pVolume
The documentation for this class was generated from the following file: