Foot step configuration. More...

Inheritance diagram for Dragengine.Scenery.ECBehaviorFootSteps.Configuration:

Public Member Functions
void	addEvent (Event event)
	Add event.

Event	findEvent (Block ablock)
	Find event with block receiving argument Event returning true if found.

void	forEachEvent (Block ablock)
	Visit events with block receiving argument Event.

String	getControllerName ()
	Name of activate animated controller to use as elapsed time or null.

Event	getEventAt (int index)
	Event at index.

int	getEventCount ()
	Number of events.

float	getInterval ()
	Interval in seconds before foot steps repeat.

Configuration	new (Configuration config)
	Create copy of foot steps configuration.

Configuration	new (String id)
	Create foot steps configuration.

void	removeAllEvents ()
	Remove all events.

void	removeEvent (Event event)
	Remove event.

void	setControllerName (String name)
	Set name of activate animated controller to use as elapsed time or null.

void	setInterval (float interval)
	Set interval in seconds before foot steps repeat.

Public Attributes
String	pControllerName

Array	pEvents

String	pID

float	pInterval

Detailed Description

Foot step configuration.

Stores interval and events for a type of foot steps.

Member Function Documentation

◆ addEvent()

void Dragengine.Scenery.ECBehaviorFootSteps.Configuration.addEvent ( Event event )

Add event.

◆ findEvent()

Event Dragengine.Scenery.ECBehaviorFootSteps.Configuration.findEvent ( Block ablock )

Find event with block receiving argument Event returning true if found.

◆ forEachEvent()

void Dragengine.Scenery.ECBehaviorFootSteps.Configuration.forEachEvent ( Block ablock )

Visit events with block receiving argument Event.

◆ getControllerName()

String Dragengine.Scenery.ECBehaviorFootSteps.Configuration.getControllerName ( )

Name of activate animated controller to use as elapsed time or null.

Version: 1.26

If name is not null the relative value of the matching named controller from ECBehaviorActorAnimated is used as elapsed time. Since relative controller value is used time related values in the configuration and events must be in the range from 0 to 1. This allows to easily synchronize foot steps to actor animations no matter the playtime of each individual animation.

If the name is null or named controller is absent from ECBehaviorActorAnimated the elapsed game time is used instead. In this case time related values in the configuration and events are in seconds.

◆ getEventAt()

Event Dragengine.Scenery.ECBehaviorFootSteps.Configuration.getEventAt ( int index )

Event at index.

◆ getEventCount()

int Dragengine.Scenery.ECBehaviorFootSteps.Configuration.getEventCount ( )

Number of events.

◆ getInterval()

float Dragengine.Scenery.ECBehaviorFootSteps.Configuration.getInterval ( )

Interval in seconds before foot steps repeat.

◆ new() [1/2]

Configuration Dragengine.Scenery.ECBehaviorFootSteps.Configuration.new ( Configuration config )

Create copy of foot steps configuration.

Version: 1.26

◆ new() [2/2]

Configuration Dragengine.Scenery.ECBehaviorFootSteps.Configuration.new ( String id )

Create foot steps configuration.

◆ removeAllEvents()

void Dragengine.Scenery.ECBehaviorFootSteps.Configuration.removeAllEvents ( )

Remove all events.

◆ removeEvent()

void Dragengine.Scenery.ECBehaviorFootSteps.Configuration.removeEvent ( Event event )

Remove event.

◆ setControllerName()

void Dragengine.Scenery.ECBehaviorFootSteps.Configuration.setControllerName ( String name )

Set name of activate animated controller to use as elapsed time or null.

Version: 1.26

See also: #getControllerName()

◆ setInterval()

void Dragengine.Scenery.ECBehaviorFootSteps.Configuration.setInterval ( float interval )

Set interval in seconds before foot steps repeat.

Clamped to 0.1 if smaller.

Member Data Documentation

◆ pControllerName

String Dragengine.Scenery.ECBehaviorFootSteps.Configuration.pControllerName

◆ pEvents

Array Dragengine.Scenery.ECBehaviorFootSteps.Configuration.pEvents

◆ pID

String Dragengine.Scenery.ECBehaviorFootSteps.Configuration.pID

◆ pInterval

float Dragengine.Scenery.ECBehaviorFootSteps.Configuration.pInterval

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

ECBehaviorFootSteps.ds

Public Member Functions

Public Attributes