Drag[en]gine Script Module DragonScript  1.23
Dragengine.Scenery.ECBehaviorClearPath.Instance Class Reference

Behavior instance. More...

Inheritance diagram for Dragengine.Scenery.ECBehaviorClearPath.Instance:
Dragengine.Scenery.DefaultECBehaviorInstance Dragengine.Scenery.ECBehaviorInstance

Classes

class  ClearPathElement
 Visitor for make element clear path. More...
 

Public Member Functions

void addIgnoreCollider (Collider collider)
 Add collider to ignore to collider required for collision test. More...
 
void addIgnoreColliderTo (Collider collider)
 Add collider required for collision test as collider to ignore. More...
 
void armTest (Vector direction)
 Arm collision test with direction. More...
 
void clearPath (float elapsed)
 Clear path if required. More...
 
void clearPathBehavior (ECBehaviorStepAside.Instance behavior)
 Clear path behavior element. More...
 
void clearPathBehaviorElement (BehaviorElement element)
 Clear path behavior element. More...
 
void disarmTest ()
 Disarm collision test. More...
 
void dispose ()
 Dispose of behavior instance. More...
 
float getCheckInterval ()
 Check interval in seconds. More...
 
float getCheckTimer ()
 Check timer. More...
 
ElementVisitor getClearPathElement ()
 Clear path element visitor. More...
 
float getClearPathTime ()
 Clear path time in seconds indicating how far ahead the actors clear path. More...
 
ColliderCollisionTest getCollisionTest ()
 Collider collision test. More...
 
ECBehaviorClearPath getECBehavior ()
 Behavior. More...
 
bool getEnabled ()
 Stepping aside is enabled. More...
 
ECBehaviorLocomotion.Instance getLocomotion ()
 Actor mover behavior. More...
 
void init (StubElement stub)
 Initialize from stub. More...
 
bool isTestArmed ()
 Collision test is armed. More...
 
void mutualIgnoreColliders (Collider collider)
 Mutually ignore colliders. More...
 
Instance new (ECBehaviorClearPath ecbehavior, BehaviorElement element)
 Create behavior instance. More...
 
void readFromFile (PersistencyEnvironment env, FileReader reader)
 Read behavior from file. More...
 
void setCheckInterval (float interval)
 Set check interval in seconds. More...
 
void setCheckTimer (float timer)
 Set check timer. More...
 
void setClearPathElement (ElementVisitor visitor)
 Set clear path element visitor. More...
 
void setClearPathTime (float time)
 Set path time in seconds indicating how far ahead the actors clear path. More...
 
void setEnabled (bool enabled)
 Set if stepping aside is enabled. More...
 
void setShapeSphere (float radius, float distanceAboveGround)
 Set sphere collision test collider shape. More...
 
void startTest (float elapsed)
 Start collision test for next interval if applicable. More...
 
void think (float elapsed)
 Think about what to do for the next frame update. More...
 
void update (float elapsed)
 Clear path if enabled and a collision has been found. More...
 
void writeToFile (PersistencyEnvironment env, FileWriter writer)
 Write behavior to file. More...
 
- Public Member Functions inherited from Dragengine.Scenery.DefaultECBehaviorInstance
void addToGameWorld ()
 Add element to game world. More...
 
void attachToParent (Element parent)
 Attach element to object set by the mapper in the IGDE World Editor. More...
 
void enterFrame ()
 Frame update started. More...
 
void geometryChanged ()
 Position or orientation changed. More...
 
BehaviorElement getElement ()
 Behavior element to apply behavior to. More...
 
int getInstanceIndex ()
 Behavior instance index. More...
 
DefaultECBehaviorInstance new (BehaviorElement element)
 Create default composeable instance. More...
 
void postThink (float elapsed)
 Post thinking after physics processing is finished. More...
 
void removeFromGameWorld ()
 Remove element from game world. More...
 
bool requiresEnterFrame ()
 Behavior instance requires enterFrame() to be called. More...
 
bool requiresThink ()
 Behavior instance requires think() to be called. More...
 
void stateChanged ()
 State changed (visble, touchable). More...
 

Public Attributes

float pCheckInterval
 
float pCheckTimer
 
ElementVisitor pClearPathElement
 
float pClearPathTime
 
ColliderCollisionTest pCollisionTest
 
ECBehaviorClearPath pECBehavior
 
bool pEnabled
 
ECBehaviorLocomotion.Instance pLocomotion
 

Protected Member Functions

void clearPath (Element element)
 Clear path using element if deemded necessary. More...
 
- Protected Member Functions inherited from Dragengine.Scenery.DefaultECBehaviorInstance
void setRequiresEnterFrame (bool required)
 Set if behavior instance requires enterFrame() to be called. More...
 
void setRequiresThink (bool required)
 Set if behavior instance requires think() to be called. More...
 

Detailed Description

Behavior instance.

Member Function Documentation

◆ addIgnoreCollider()

void Dragengine.Scenery.ECBehaviorClearPath.Instance.addIgnoreCollider ( Collider  collider)

Add collider to ignore to collider required for collision test.

Version
1.17

◆ addIgnoreColliderTo()

void Dragengine.Scenery.ECBehaviorClearPath.Instance.addIgnoreColliderTo ( Collider  collider)

Add collider required for collision test as collider to ignore.

◆ armTest()

void Dragengine.Scenery.ECBehaviorClearPath.Instance.armTest ( Vector  direction)

Arm collision test with direction.

◆ clearPath() [1/2]

void Dragengine.Scenery.ECBehaviorClearPath.Instance.clearPath ( Element  element)
protected

Clear path using element if deemded necessary.

Does nothing if element is null. Otherwise uses clear path visitor on element to apply element specific clearing of path.

◆ clearPath() [2/2]

void Dragengine.Scenery.ECBehaviorClearPath.Instance.clearPath ( float  elapsed)

Clear path if required.

◆ clearPathBehavior()

void Dragengine.Scenery.ECBehaviorClearPath.Instance.clearPathBehavior ( ECBehaviorStepAside.Instance  behavior)

Clear path behavior element.

Version
1.19

Calls stepAsideBehaviorElement(). Does nothing if collider velocity is too small

◆ clearPathBehaviorElement()

void Dragengine.Scenery.ECBehaviorClearPath.Instance.clearPathBehaviorElement ( BehaviorElement  element)

Clear path behavior element.

Called by ClearPathElement visitor. If element has ECBehaviorStepAsidebehavior calls stepAsideBehaviorElement(). Does nothing if collider velocity is too small

◆ disarmTest()

void Dragengine.Scenery.ECBehaviorClearPath.Instance.disarmTest ( )

Disarm collision test.

◆ dispose()

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

Dispose of behavior instance.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ getCheckInterval()

float Dragengine.Scenery.ECBehaviorClearPath.Instance.getCheckInterval ( )

Check interval in seconds.

◆ getCheckTimer()

float Dragengine.Scenery.ECBehaviorClearPath.Instance.getCheckTimer ( )

Check timer.

◆ getClearPathElement()

ElementVisitor Dragengine.Scenery.ECBehaviorClearPath.Instance.getClearPathElement ( )

Clear path element visitor.

◆ getClearPathTime()

float Dragengine.Scenery.ECBehaviorClearPath.Instance.getClearPathTime ( )

Clear path time in seconds indicating how far ahead the actors clear path.

◆ getCollisionTest()

ColliderCollisionTest Dragengine.Scenery.ECBehaviorClearPath.Instance.getCollisionTest ( )

Collider collision test.

◆ getECBehavior()

ECBehaviorClearPath Dragengine.Scenery.ECBehaviorClearPath.Instance.getECBehavior ( )

Behavior.

◆ getEnabled()

bool Dragengine.Scenery.ECBehaviorClearPath.Instance.getEnabled ( )

Stepping aside is enabled.

◆ getLocomotion()

ECBehaviorLocomotion.Instance Dragengine.Scenery.ECBehaviorClearPath.Instance.getLocomotion ( )

Actor mover behavior.

◆ init()

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

Initialize from stub.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ isTestArmed()

bool Dragengine.Scenery.ECBehaviorClearPath.Instance.isTestArmed ( )

Collision test is armed.

◆ mutualIgnoreColliders()

void Dragengine.Scenery.ECBehaviorClearPath.Instance.mutualIgnoreColliders ( Collider  collider)

Mutually ignore colliders.

Version
1.17

Same as calling addIgnoreCollidersTo() and addIgnoreCollider() for the same collider. Use this call to make sure the given collider is ignored by collider required for collision test and vice versa. The ECBehaviorColliderAI from ECBehaviorLocomotion is automatically made mutually ignore.

◆ new()

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

Create behavior instance.

◆ readFromFile()

void Dragengine.Scenery.ECBehaviorClearPath.Instance.readFromFile ( PersistencyEnvironment  env,
FileReader  reader 
)

Read behavior from file.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ setCheckInterval()

void Dragengine.Scenery.ECBehaviorClearPath.Instance.setCheckInterval ( float  interval)

Set check interval in seconds.

◆ setCheckTimer()

void Dragengine.Scenery.ECBehaviorClearPath.Instance.setCheckTimer ( float  timer)

Set check timer.

◆ setClearPathElement()

void Dragengine.Scenery.ECBehaviorClearPath.Instance.setClearPathElement ( ElementVisitor  visitor)

Set clear path element visitor.

◆ setClearPathTime()

void Dragengine.Scenery.ECBehaviorClearPath.Instance.setClearPathTime ( float  time)

Set path time in seconds indicating how far ahead the actors clear path.

◆ setEnabled()

void Dragengine.Scenery.ECBehaviorClearPath.Instance.setEnabled ( bool  enabled)

Set if stepping aside is enabled.

◆ setShapeSphere()

void Dragengine.Scenery.ECBehaviorClearPath.Instance.setShapeSphere ( float  radius,
float  distanceAboveGround 
)

Set sphere collision test collider shape.

Uses sphere shape located a distance above ground.

◆ startTest()

void Dragengine.Scenery.ECBehaviorClearPath.Instance.startTest ( float  elapsed)

Start collision test for next interval if applicable.

◆ think()

void Dragengine.Scenery.ECBehaviorClearPath.Instance.think ( float  elapsed)

Think about what to do for the next frame update.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ update()

void Dragengine.Scenery.ECBehaviorClearPath.Instance.update ( float  elapsed)

Clear path if enabled and a collision has been found.

Called by think().

◆ writeToFile()

void Dragengine.Scenery.ECBehaviorClearPath.Instance.writeToFile ( PersistencyEnvironment  env,
FileWriter  writer 
)

Write behavior to file.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

Member Data Documentation

◆ pCheckInterval

float Dragengine.Scenery.ECBehaviorClearPath.Instance.pCheckInterval

◆ pCheckTimer

float Dragengine.Scenery.ECBehaviorClearPath.Instance.pCheckTimer

◆ pClearPathElement

ElementVisitor Dragengine.Scenery.ECBehaviorClearPath.Instance.pClearPathElement

◆ pClearPathTime

float Dragengine.Scenery.ECBehaviorClearPath.Instance.pClearPathTime

◆ pCollisionTest

ColliderCollisionTest Dragengine.Scenery.ECBehaviorClearPath.Instance.pCollisionTest

◆ pECBehavior

ECBehaviorClearPath Dragengine.Scenery.ECBehaviorClearPath.Instance.pECBehavior

◆ pEnabled

bool Dragengine.Scenery.ECBehaviorClearPath.Instance.pEnabled

◆ pLocomotion

ECBehaviorLocomotion.Instance Dragengine.Scenery.ECBehaviorClearPath.Instance.pLocomotion

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