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.
float	getRange ()
	Range to use for created speakers.
float	getRollOff ()
	Roll-off to use for created speakers.
WeightedRandomList	getSounds ()
	List of sounds to pick one from to play this event.
float	getTime ()
	Activation time.
String	getType ()
	Optional type string (by default null).
float	getVolume ()
	Volume to use for created speakers.
Event	new (Event event)
	Create copy of foot step event.
Event	new (float time)
	Create foot step event.
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.
void	setOffset (DVector offset)
	Set offset relative to actor coordinate system to play foot step at.
void	setRange (float range)
	Set range to use for created speakers.
void	setRollOff (float rollOff)
	Set roll-off to use for created speakers.
void	setSounds (WeightedRandomList sounds)
	Set list of sounds to pick one from to play this event.
void	setType (String type)
	Set optional type string or null if not needed.
void	setVolume (float volume)
	Set volume to use for created speakers.

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/12]

Event Dragengine.Scenery.ECBehaviorFootSteps.Event.new

(

Event

event

)

Create copy of foot step event.

Version

1.26

new() [2/12]

Event Dragengine.Scenery.ECBehaviorFootSteps.Event.new

(

float

time

)

Create foot step event.

new() [3/12]

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

new() [4/12]

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

new() [5/12]

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

new() [6/12]

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

new() [7/12]

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

new() [8/12]

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

new() [9/12]

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

new() [10/12]

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

new() [11/12]

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

new() [12/12]

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:

• ECBehaviorFootSteps.ds