Behavior instance. More...

Inheritance diagram for Dragengine.Scenery.ECBehaviorHearSounds.Instance:

Public Member Functions
void	addListener (Listener listener)
	Add listener.

void	addListenerFactory (Block blockFactory)
	Add listener factory using block.

void	addListenerFactory (ListenerFactory factory)
	Add listener factory.

void	addToGameWorld ()
	Add element to game world.

void	createListeners (Instance instance)
	Create listeners from factories adding them to behavior instance.

void	dispose ()
	Dispose of behavior instance.

void	dispose ()
	Dispose of behavior.

void	forEachListenerFactory (Block ablock)
	Visit listener factories with block with argument ListenerFactory.

ECComposeAttachResource	getAttach ()
	Attach resource.

float	getAudibleDistance ()
	Audible distance in meters.

ECPFloat	getAudibleDistance ()
	Audible distance.

Element	getAudibleElementAt (int index)
	Audible element at index.

int	getAudibleElementCount ()
	Number of audible elements.

float	getAudibleElementVolume (Element element)
	Get volume of element.

ECComposeBTSM	getBTSMs ()
	Compose behavior trees and state machines.

ECBehaviorCollider.Instance	getCollider ()
	Collider behavior or null if not attached.

ECBehaviorCollider	getCollider ()
	Collider behavior or null to not attach.

ECBehaviorHearSounds	getECBehavior ()
	Behavior.

LayerMask	getLayerMask ()
	Layer mask.

bool	getListening ()
	Behavior element is listening.

BehaviorElement	getPlayerAudible ()
	Check if player is audible.

String	getPrefix ()
	Prefix.

SoundLevelMeter	getSoundLevelMeter ()
	Sound level meter.

float	getVolumeThreshold ()
	Volume threshold required for elements to be considered audible.

ECPFloat	getVolumeThreshold ()
	Volume threshold required for elements to be considered audible.

void	init (StubElement stub)
	Initialize element from stub.

bool	isElementAudible (Element element)
	Element is audible.

Instance	new (BehaviorElementClass eclass, ECBehaviorCollider collider, String prefix)

Instance	new (ECBehaviorHearSounds ecbehavior, BehaviorElement element)
	Create element.

void	removeFromGameWorld ()
	Remove element from game world.

void	removeListener (Listener listener)
	Remove listener.

void	setLayerMask (LayerMask layerMask)
	Set layer mask.

void	setListening (bool listening)
	Set if behavior element is listening.

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.

void	enterFrame ()
	Frame update started.

void	geometryChanged ()
	Position or orientation changed.

BehaviorElement	getElement ()
	Behavior element to apply behavior to.

int	getInstanceIndex ()
	Behavior instance index.

DefaultECBehaviorInstance	new (BehaviorElement element)
	Create default composeable instance.

void	postThink (float elapsed)
	Post thinking after physics processing is finished.

void	readFromFile (PersistencyEnvironment env, FileReader reader)
	Read behavior instance from file.

bool	requiresEnterFrame ()
	Behavior instance requires enterFrame() to be called.

bool	requiresThink ()
	Behavior instance requires think() to be called.

void	stateChanged ()
	State changed (visble, touchable).

void	think (float elapsed)
	Think about what to do for the next frame update.

void	writeToFile (PersistencyEnvironment env, FileWriter writer)
	Write behavior instance to file.

Public Member Functions inherited from Dragengine.Scenery.SoundLevelMeterListener
void	speakerAudible (SoundLevelMeterSpeaker speaker)
	Speaker become audible.

void	speakerInaudible (Speaker speaker)
	Speaker became inaudible.

Static Public Member Functions
static ECBehaviorHearSounds	getBehaviorIn (BehaviorElementClass eclass)
	Get behavior in element class or null if absent.

Public Attributes
float	pAudibleDistance

Array	pAudibleElements

ECComposeBTSM.Instance	pBTSMs

ECBehaviorCollider.Instance	pCollider

ECBehaviorHearSounds	pECBehavior

Array	pListeners

SoundLevelMeter	pSoundLevelMeter

Array	pTrackedElements

float	pVolumeThreshold

Public Attributes inherited from Dragengine.Scenery.DefaultECBehaviorInstance
BehaviorElement	pElement

int	pInstanceIndex

bool	pRequiresEnterFrame

bool	pRequiresThink

Protected Member Functions
void	addAudibleElement (Element element)

void	addAudibleElement (Speaker speaker, Element element)
	Add audible element.

void	attachSoundLevelMeter (StubElement stub, ECBehaviorCollider.Instance collider)
	Attach sound level meter to collider.

SoundLevelMeter	createSoundLevelMeter (StubElement stub)
	Create sound level meter.

void	removeAudibleElement (Element element)
	Remove audible element.

void	setAudibleDistance (float range)
	Set audible range in meters.

void	setVolumeThreshold (float volume)
	Set volume threshold required for elements to be considered audible.

Protected Member Functions inherited from Dragengine.Scenery.DefaultECBehaviorInstance
void	setRequiresEnterFrame (bool required)
	Set if behavior instance requires enterFrame() to be called.

void	setRequiresThink (bool required)
	Set if behavior instance requires think() to be called.

Detailed Description

Behavior instance.

Member Function Documentation

◆ addAudibleElement() [1/2]

void Dragengine.Scenery.ECBehaviorHearSounds.Instance.addAudibleElement ( Element element )

protected

Deprecated:: Use addAudibleElement(Speaker,Element).

◆ addAudibleElement() [2/2]

void Dragengine.Scenery.ECBehaviorHearSounds.Instance.addAudibleElement	(	Speaker	speaker,
		Element	element
	)

protected

Add audible element.

Version: 1.19

◆ addListener()

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

Add listener.

◆ addListenerFactory() [1/2]

void Dragengine.Scenery.ECBehaviorHearSounds.Instance.addListenerFactory ( Block blockFactory )

Add listener factory using block.

Block receives as parameter Instance and returns Listener.

◆ addListenerFactory() [2/2]

void Dragengine.Scenery.ECBehaviorHearSounds.Instance.addListenerFactory ( ListenerFactory factory )

Add listener factory.

◆ addToGameWorld()

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

Add element to game world.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ attachSoundLevelMeter()

void Dragengine.Scenery.ECBehaviorHearSounds.Instance.attachSoundLevelMeter	(	StubElement	stub,
		ECBehaviorCollider.Instance	collider
	)

protected

Attach sound level meter to collider.

Default implementation calls ECComposeAttachResource.attach().

◆ createListeners()

void Dragengine.Scenery.ECBehaviorHearSounds.Instance.createListeners ( Instance instance )

Create listeners from factories adding them to behavior instance.

◆ createSoundLevelMeter()

SoundLevelMeter Dragengine.Scenery.ECBehaviorHearSounds.Instance.createSoundLevelMeter ( StubElement stub )

protected

Create sound level meter.

◆ dispose() [1/2]

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

Dispose of behavior instance.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ dispose() [2/2]

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

Dispose of behavior.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ forEachListenerFactory()

void Dragengine.Scenery.ECBehaviorHearSounds.Instance.forEachListenerFactory ( Block ablock )

Visit listener factories with block with argument ListenerFactory.

◆ getAttach()

ECComposeAttachResource Dragengine.Scenery.ECBehaviorHearSounds.Instance.getAttach ( )

Attach resource.

◆ getAudibleDistance() [1/2]

float Dragengine.Scenery.ECBehaviorHearSounds.Instance.getAudibleDistance ( )

Audible distance in meters.

◆ getAudibleDistance() [2/2]

ECPFloat Dragengine.Scenery.ECBehaviorHearSounds.Instance.getAudibleDistance ( )

Audible distance.

◆ getAudibleElementAt()

Element Dragengine.Scenery.ECBehaviorHearSounds.Instance.getAudibleElementAt ( int index )

Audible element at index.

◆ getAudibleElementCount()

int Dragengine.Scenery.ECBehaviorHearSounds.Instance.getAudibleElementCount ( )

Number of audible elements.

◆ getAudibleElementVolume()

float Dragengine.Scenery.ECBehaviorHearSounds.Instance.getAudibleElementVolume ( Element element )

Get volume of element.

◆ getBehaviorIn()

static ECBehaviorHearSounds Dragengine.Scenery.ECBehaviorHearSounds.Instance.getBehaviorIn ( BehaviorElementClass eclass )

static

Get behavior in element class or null if absent.

Use this method to check if a particular BehaviorElementClass contains a behavior of type ECBehaviorHearSounds.

◆ getBTSMs()

ECComposeBTSM Dragengine.Scenery.ECBehaviorHearSounds.Instance.getBTSMs ( )

Compose behavior trees and state machines.

Version: 1.26

◆ getCollider() [1/2]

ECBehaviorCollider.Instance Dragengine.Scenery.ECBehaviorHearSounds.Instance.getCollider ( )

Collider behavior or null if not attached.

◆ getCollider() [2/2]

ECBehaviorCollider Dragengine.Scenery.ECBehaviorHearSounds.Instance.getCollider ( )

Collider behavior or null to not attach.

◆ getECBehavior()

ECBehaviorHearSounds Dragengine.Scenery.ECBehaviorHearSounds.Instance.getECBehavior ( )

Behavior.

◆ getLayerMask()

LayerMask Dragengine.Scenery.ECBehaviorHearSounds.Instance.getLayerMask ( )

Layer mask.

◆ getListening()

bool Dragengine.Scenery.ECBehaviorHearSounds.Instance.getListening ( )

Behavior element is listening.

◆ getPlayerAudible()

BehaviorElement Dragengine.Scenery.ECBehaviorHearSounds.Instance.getPlayerAudible ( )

Check if player is audible.

Version: 1.26

Checks each element in the list of audible elements if it has ECBehaviorPlayerControllable and it is the active player actor. If found returns the player actor. If not found null is returned.

◆ getPrefix()

String Dragengine.Scenery.ECBehaviorHearSounds.Instance.getPrefix ( )

Prefix.

Version: 1.26

◆ getSoundLevelMeter()

SoundLevelMeter Dragengine.Scenery.ECBehaviorHearSounds.Instance.getSoundLevelMeter ( )

Sound level meter.

◆ getVolumeThreshold() [1/2]

float Dragengine.Scenery.ECBehaviorHearSounds.Instance.getVolumeThreshold ( )

Volume threshold required for elements to be considered audible.

◆ getVolumeThreshold() [2/2]

ECPFloat Dragengine.Scenery.ECBehaviorHearSounds.Instance.getVolumeThreshold ( )

Volume threshold required for elements to be considered audible.

◆ init()

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

Initialize element from stub.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ isElementAudible()

bool Dragengine.Scenery.ECBehaviorHearSounds.Instance.isElementAudible ( Element element )

Element is audible.

◆ new() [1/2]

Instance Dragengine.Scenery.ECBehaviorHearSounds.Instance.new	(	BehaviorElementClass	eclass,
		ECBehaviorCollider	collider,
		String	prefix
	)

◆ new() [2/2]

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

Create element.

◆ removeAudibleElement()

void Dragengine.Scenery.ECBehaviorHearSounds.Instance.removeAudibleElement ( Element element )

protected

Remove audible element.

◆ removeFromGameWorld()

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

Remove element from game world.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ removeListener()

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

Remove listener.

◆ setAudibleDistance()

void Dragengine.Scenery.ECBehaviorHearSounds.Instance.setAudibleDistance ( float range )

protected

Set audible range in meters.

◆ setLayerMask()

void Dragengine.Scenery.ECBehaviorHearSounds.Instance.setLayerMask ( LayerMask layerMask )

Set layer mask.

◆ setListening()

void Dragengine.Scenery.ECBehaviorHearSounds.Instance.setListening ( bool listening )

Set if behavior element is listening.

◆ setVolumeThreshold()

void Dragengine.Scenery.ECBehaviorHearSounds.Instance.setVolumeThreshold ( float volume )

protected

Set volume threshold required for elements to be considered audible.

Member Data Documentation

◆ pAudibleDistance

float Dragengine.Scenery.ECBehaviorHearSounds.Instance.pAudibleDistance

◆ pAudibleElements

Array Dragengine.Scenery.ECBehaviorHearSounds.Instance.pAudibleElements

◆ pBTSMs

ECComposeBTSM.Instance Dragengine.Scenery.ECBehaviorHearSounds.Instance.pBTSMs

◆ pCollider

ECBehaviorCollider.Instance Dragengine.Scenery.ECBehaviorHearSounds.Instance.pCollider

◆ pECBehavior

ECBehaviorHearSounds Dragengine.Scenery.ECBehaviorHearSounds.Instance.pECBehavior

◆ pListeners

Array Dragengine.Scenery.ECBehaviorHearSounds.Instance.pListeners

◆ pSoundLevelMeter

SoundLevelMeter Dragengine.Scenery.ECBehaviorHearSounds.Instance.pSoundLevelMeter

◆ pTrackedElements

Array Dragengine.Scenery.ECBehaviorHearSounds.Instance.pTrackedElements

◆ pVolumeThreshold

float Dragengine.Scenery.ECBehaviorHearSounds.Instance.pVolumeThreshold

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

ECBehaviorHearSounds.ds

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Member Function Documentation

◆ addAudibleElement() [1/2]

◆ addAudibleElement() [2/2]

◆ addListener()

◆ addListenerFactory() [1/2]

◆ addListenerFactory() [2/2]

◆ addToGameWorld()

◆ attachSoundLevelMeter()

◆ createListeners()

◆ createSoundLevelMeter()

◆ dispose() [1/2]

◆ dispose() [2/2]

◆ forEachListenerFactory()

◆ getAttach()

◆ getAudibleDistance() [1/2]

◆ getAudibleDistance() [2/2]

◆ getAudibleElementAt()

◆ getAudibleElementCount()

◆ getAudibleElementVolume()

◆ getBehaviorIn()

◆ getBTSMs()

◆ getCollider() [1/2]

◆ getCollider() [2/2]

◆ getECBehavior()

◆ getLayerMask()

◆ getListening()

◆ getPlayerAudible()

◆ getPrefix()

◆ getSoundLevelMeter()

◆ getVolumeThreshold() [1/2]

◆ getVolumeThreshold() [2/2]

◆ init()

◆ isElementAudible()

◆ new() [1/2]

◆ new() [2/2]

◆ removeAudibleElement()

◆ removeFromGameWorld()

◆ removeListener()

◆ setAudibleDistance()

◆ setLayerMask()

◆ setListening()

◆ setVolumeThreshold()

Member Data Documentation

◆ pAudibleDistance

◆ pAudibleElements

◆ pBTSMs

◆ pCollider

◆ pECBehavior

◆ pListeners

◆ pSoundLevelMeter

◆ pTrackedElements

◆ pVolumeThreshold