Dragengine.Scenery.ECBehaviorAvoidCollision Class Reference

Behavior adding support to actors to avoid collisions with ECBehaviorAvoidedByActor. More...

Inheritance diagram for Dragengine.Scenery.ECBehaviorAvoidCollision:

Classes
class	Factory
	Behavior factory. More...
class	Instance
	Behavior instance. More...

Public Member Functions
void	dispose ()
	Dispose of behavior.
ECBehaviorActorMover	getActorMover ()
	Actor mover behavior.
ECComposeBTSM	getBTSMs ()
	Compose behavior trees and state machines.
ECComposeCollisionFilter	getCollisionFilter ()
	Collision filter.
String	getPrefix ()
	Prefix.
ECPFloat	getRadius ()
	Avoid radius.
ECBehaviorRideOn	getRideOn ()
	RideOn behavior or null.
Instance	instance (BehaviorElement element)
	Get instance in element from owner element class.
ECBehaviorAvoidCollision	new (BehaviorElementClass eclass, ECBehaviorActorMover actorMover, ECBehaviorRideOn rideOn)
	Create behavior element class.
ECBehaviorAvoidCollision	new (BehaviorElementClass eclass, ECBehaviorActorMover actorMover, ECBehaviorRideOn rideOn, String prefix)
void	setBehaviorTree (ECBehaviorBehaviorTree behaviorTree)
Public Member Functions inherited from Dragengine.Scenery.DefaultECBehavior
void	assignInstanceIndex (int instanceIndex)
	Assign instance index.
String	getBehaviorID ()
	Unique identifier of behavior.
String	getID ()
	Identifier.
int	getInstanceIndex ()
	Instance index.
void	loadSupportedData (String identifier, PersistencyEnvironment env, FileReader reader, ECBehaviorInstance instance)
	Load instance data of another behavior.
bool	supportsBehaviorID (String identifier)
	Behavior supports loading instance data of another behavior.
Public Member Functions inherited from Dragengine.Scenery.ECBehavior
ECBehaviorInstance	createInstance (BehaviorElement element)
	Create Behavior instance.

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

Public Attributes
ECBehaviorActorMover	pActorMover
ECComposeBTSM	pBTSMs
ECComposeCollisionFilter	pCollisionFilter
String	pPrefix
ECPFloat	pRadius
ECBehaviorRideOn	pRideOn

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

Detailed Description

Behavior adding support to actors to avoid collisions with ECBehaviorAvoidedByActor.

Behavior attaches to ECBehaviorActorMover to modify walking path while moving.

To use this behavior add it to the element class and make sure to call setShapesSphere() to set up the collision test shapes. The best time to do this is either in BehaviorElement.init() or inside BaseActorAction if you need to change them per action.

Requires these behaviors to be present:

• ECBehaviorColliderAI
• ECBehaviorLocomotion
• ECBehaviorActorMover
• ECBehaviorNavigator

Uses these behaviors if present.

• ECBehaviorRideOn
• ECBehaviorBehaviorTree

The following behavior tree actions are added if an ECBehaviorBehaviorTree is presen:

Action "avoidCollision.set"

Set behavior parameters. Supports these optional action parameters:

• waitBehindObstacles: calls setWaitBehindObstacles(). Value: "true", "false".
• enabled: calls setEnabled(). Value: "true", "false".

This is an example of using this action:

<action name='avoidCollision.set'>
   <parameter name='waitBehindObstacles'>true</parameter>
   <parameter name='enabled'>true</parameter>
</action>

See also

https://developer.dragondreams.ch/wiki/doku.php/dragengine:modules:dragonscript:behavior_avoidcollision

Member Function Documentation

dispose()

void Dragengine.Scenery.ECBehaviorAvoidCollision.dispose

(

)

Dispose of behavior.

Reimplemented from Dragengine.Scenery.DefaultECBehavior.

getActorMover()

ECBehaviorActorMover Dragengine.Scenery.ECBehaviorAvoidCollision.getActorMover

(

)

Actor mover behavior.

getBehaviorIn()

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

getBTSMs()

ECComposeBTSM Dragengine.Scenery.ECBehaviorAvoidCollision.getBTSMs

(

)

Compose behavior trees and state machines.

Version

1.26

getCollisionFilter()

ECComposeCollisionFilter Dragengine.Scenery.ECBehaviorAvoidCollision.getCollisionFilter

(

)

Collision filter.

getPrefix()

String Dragengine.Scenery.ECBehaviorAvoidCollision.getPrefix

(

)

Prefix.

Version

1.26

getRadius()

ECPFloat Dragengine.Scenery.ECBehaviorAvoidCollision.getRadius

(

)

Avoid radius.

getRideOn()

ECBehaviorRideOn Dragengine.Scenery.ECBehaviorAvoidCollision.getRideOn

(

)

RideOn behavior or null.

instance()

Instance Dragengine.Scenery.ECBehaviorAvoidCollision.instance

(

BehaviorElement

element

)

Get instance in element from owner element class.

new() [1/2]

ECBehaviorAvoidCollision Dragengine.Scenery.ECBehaviorAvoidCollision.new	(	BehaviorElementClass	eclass,
		ECBehaviorActorMover	actorMover,
		ECBehaviorRideOn	rideOn
	)

Create behavior element class.

These values are optional and can be null: rideOn.

new() [2/2]

ECBehaviorAvoidCollision Dragengine.Scenery.ECBehaviorAvoidCollision.new	(	BehaviorElementClass	eclass,
		ECBehaviorActorMover	actorMover,
		ECBehaviorRideOn	rideOn,
		String	prefix
	)

setBehaviorTree()

void Dragengine.Scenery.ECBehaviorAvoidCollision.setBehaviorTree

(

ECBehaviorBehaviorTree

behaviorTree

)

Deprecated:

Use getBTSMs() ECComposeBTSM::addBehaviorTree().

Member Data Documentation

pActorMover

ECBehaviorActorMover Dragengine.Scenery.ECBehaviorAvoidCollision.pActorMover

pBTSMs

ECComposeBTSM Dragengine.Scenery.ECBehaviorAvoidCollision.pBTSMs

pCollisionFilter

ECComposeCollisionFilter Dragengine.Scenery.ECBehaviorAvoidCollision.pCollisionFilter

pPrefix

String Dragengine.Scenery.ECBehaviorAvoidCollision.pPrefix

pRadius

ECPFloat Dragengine.Scenery.ECBehaviorAvoidCollision.pRadius

pRideOn

ECBehaviorRideOn Dragengine.Scenery.ECBehaviorAvoidCollision.pRideOn

---

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

• ECBehaviorAvoidCollision.ds