Drag[en]gine Script Module DragonScript  1.21
Dragengine.Scenery.ECBehaviorProjectToGround Class Reference

Behavior element behavior adding project to ground support for actor AI. More...

Inheritance diagram for Dragengine.Scenery.ECBehaviorProjectToGround:
Dragengine.Scenery.DefaultECBehavior Dragengine.Scenery.ECBehavior Dragengine.Scenery.BehaviorCompatiblePersistency

Classes

class  BlockListenerFactory
 Factory creating listeners using block. More...
 
class  DefaultListener
 Default implementation of behavior instance listener. More...
 
class  Instance
 Behavior instance. More...
 
interface  Listener
 Listener for behavior instance events. More...
 
interface  ListenerFactory
 Factory creating listeners. More...
 

Public Member Functions

void addListenerFactory (Block blockFactory)
 Add listener factory using block. More...
 
void addListenerFactory (ListenerFactory factory)
 Add listener factory. More...
 
void createListeners (Instance instance)
 Create listeners from factories adding them to behavior instance. More...
 
void dispose ()
 Dispose of behavior. More...
 
void forEachListenerFactory (Block ablock)
 Visit listener factories with block with argument ListenerFactory. More...
 
ECPBoolean getApplyToActor ()
 Apply projected position automatically to actor. More...
 
ECBehaviorCollider getCollider ()
 Collider behavior or null. More...
 
ECBehaviorColliderAI getColliderAI ()
 ColliderAI behavior or null. More...
 
ECBehaviorProjectToGround new (BehaviorElementClass eclass, ECBehaviorCollider collider)
 
ECBehaviorProjectToGround new (BehaviorElementClass eclass, ECBehaviorCollider collider, String prefix)
 
ECBehaviorProjectToGround new (BehaviorElementClass eclass, ECBehaviorColliderAI colliderAI)
 Create behavior element class. More...
 
ECBehaviorProjectToGround new (BehaviorElementClass eclass, ECBehaviorColliderAI colliderAI, String prefix)
 
- Public Member Functions inherited from Dragengine.Scenery.DefaultECBehavior
void assignInstanceIndex (int instanceIndex)
 Assign instance index. More...
 
String getBehaviorID ()
 Unique identifier of behavior. More...
 
String getID ()
 Identifier. More...
 
int getInstanceIndex ()
 Instance index. More...
 
void loadSupportedData (String identifier, PersistencyEnvironment env, FileReader reader, ECBehaviorInstance instance)
 Load instance data of another behavior. More...
 
bool supportsBehaviorID (String identifier)
 Behavior supports loading instance data of another behavior. More...
 
- Public Member Functions inherited from Dragengine.Scenery.ECBehavior
ECBehaviorInstance createInstance (BehaviorElement element)
 Create Behavior instance. More...
 

Static Public Member Functions

static ECBehaviorProjectToGround getBehaviorIn (BehaviorElementClass eclass)
 Get behavior in element class or null if absent. More...
 

Public Attributes

ECPBoolean pApplyToActor
 
ECBehaviorCollider pCollider
 
ECBehaviorColliderAI pColliderAI
 
Array pListenerFactories
 

Additional Inherited Members

- Protected Member Functions inherited from Dragengine.Scenery.DefaultECBehavior
DefaultECBehavior new (BehaviorElementClass eclass)
 Create default composeable behavior with empty identifier. More...
 
DefaultECBehavior new (BehaviorElementClass eclass, String id)
 Create default composeable behavior. More...
 
void setBehaviorID (String identifier)
 Set behavior identifier. More...
 
void useClassNameAsBehaviorID ()
 Set behavior identifier to "<class-name>:<identifier>". More...
 
void useFullyQualifiedClassNameAsBehaviorID ()
 Set behavior identifier to "<fully-qualified-class-name>:<identifier>". More...
 

Detailed Description

Behavior element behavior adding project to ground support for actor AI.

Adds TouchSensor. The touch sensor is used to improve performance and requires a shape large enough to enclose the ECBehaviorColliderAI or ECBehaviorCollider (whichever is present) along all the up and down projection range. The touch sensor is attached to collider. The touch sensor uses the collision filter from collider.

To use this behavior add it to an actor. The behavior will run during postThink() and projects the actor position down to the ground if enabled. The grounded position is stored and can then be retrieved to work with. By default the behavior is set to automatically apply the grounded position to the actor. This behavior can be desibled for custome project to ground handling.

This behavior does require the element class to be persistable (setPersistable).

Member Function Documentation

◆ addListenerFactory() [1/2]

void Dragengine.Scenery.ECBehaviorProjectToGround.addListenerFactory ( Block  blockFactory)

Add listener factory using block.

Block receives as parameter Instance and returns Listener.

◆ addListenerFactory() [2/2]

void Dragengine.Scenery.ECBehaviorProjectToGround.addListenerFactory ( ListenerFactory  factory)

Add listener factory.

◆ createListeners()

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

Create listeners from factories adding them to behavior instance.

◆ dispose()

void Dragengine.Scenery.ECBehaviorProjectToGround.dispose ( )

Dispose of behavior.

Reimplemented from Dragengine.Scenery.DefaultECBehavior.

◆ forEachListenerFactory()

void Dragengine.Scenery.ECBehaviorProjectToGround.forEachListenerFactory ( Block  ablock)

Visit listener factories with block with argument ListenerFactory.

◆ getApplyToActor()

ECPBoolean Dragengine.Scenery.ECBehaviorProjectToGround.getApplyToActor ( )

Apply projected position automatically to actor.

◆ getBehaviorIn()

static ECBehaviorProjectToGround Dragengine.Scenery.ECBehaviorProjectToGround.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 ECBehaviorProjectToGround.

◆ getCollider()

ECBehaviorCollider Dragengine.Scenery.ECBehaviorProjectToGround.getCollider ( )

Collider behavior or null.

◆ getColliderAI()

ECBehaviorColliderAI Dragengine.Scenery.ECBehaviorProjectToGround.getColliderAI ( )

ColliderAI behavior or null.

◆ new() [1/4]

ECBehaviorProjectToGround Dragengine.Scenery.ECBehaviorProjectToGround.new ( BehaviorElementClass  eclass,
ECBehaviorCollider  collider 
)

◆ new() [2/4]

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

◆ new() [3/4]

ECBehaviorProjectToGround Dragengine.Scenery.ECBehaviorProjectToGround.new ( BehaviorElementClass  eclass,
ECBehaviorColliderAI  colliderAI 
)

Create behavior element class.

◆ new() [4/4]

ECBehaviorProjectToGround Dragengine.Scenery.ECBehaviorProjectToGround.new ( BehaviorElementClass  eclass,
ECBehaviorColliderAI  colliderAI,
String  prefix 
)

Member Data Documentation

◆ pApplyToActor

ECPBoolean Dragengine.Scenery.ECBehaviorProjectToGround.pApplyToActor

◆ pCollider

ECBehaviorCollider Dragengine.Scenery.ECBehaviorProjectToGround.pCollider

◆ pColliderAI

ECBehaviorColliderAI Dragengine.Scenery.ECBehaviorProjectToGround.pColliderAI

◆ pListenerFactories

Array Dragengine.Scenery.ECBehaviorProjectToGround.pListenerFactories

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