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

Behavior element behavior adding navigator support for actors. More...

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

Classes

class  Instance
 Behavior instance. More...
 

Public Member Functions

ECBehaviorInstance createInstance (BehaviorElement element)
 Create Behavior instance. More...
 
ECPInteger getLayer ()
 Navigation space layer to use. More...
 
ECPEnumeration getSpaceType ()
 Navigation space type to use (NavigationSpace.{GRID|MESH|VOLUME}). More...
 
Instance instance (BehaviorElement element)
 Get instance in element from owner element class. More...
 
ECBehaviorNavigator new (BehaviorElementClass eclass)
 Create behavior element class. More...
 
ECBehaviorNavigator new (BehaviorElementClass eclass, String id)
 Create behavior element class. More...
 
ECBehaviorNavigator new (BehaviorElementClass eclass, String id, String prefix)
 
- Public Member Functions inherited from Dragengine.Scenery.DefaultECBehavior
void assignInstanceIndex (int instanceIndex)
 Assign instance index. More...
 
void dispose ()
 Dispose of behavior. 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...
 

Static Public Member Functions

static Array getAllBehaviorsIn (BehaviorElementClass eclass)
 Get list of all behaviors in element. More...
 
static Array getAllInstancesIn (BehaviorElement element)
 Get list of all instances in element. More...
 
static ECBehaviorNavigator getBehaviorIn (BehaviorElementClass eclass)
 Get behavior in element class or null if absent. More...
 
static ECBehaviorNavigator getBehaviorIn (BehaviorElementClass eclass, String id)
 Get behavior with id in element class or null if absent. More...
 
static Instance getInstanceIn (BehaviorElement element)
 Get instance in element or null if absent. More...
 
static Instance getInstanceIn (BehaviorElement element, String id)
 Get instance with id in element or null if absent. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Dragengine.Scenery.DefaultECBehavior
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 navigator support for actors.

Adds Navigator resource to actor. Actors use Navigator to find path around the game world using navigation spaces. Usually actors have one navigator but it is possible to have multiple navigators. Using different navigators path can be found and processed on different navigation space levels.

By defautl the navigator has no cost types assigned. Actors set up the cost type in their actions.

This behavior does not require persistency.

Member Function Documentation

◆ createInstance()

ECBehaviorInstance Dragengine.Scenery.ECBehaviorNavigator.createInstance ( BehaviorElement  element)

Create Behavior instance.

Implements Dragengine.Scenery.ECBehavior.

◆ getAllBehaviorsIn()

static Array Dragengine.Scenery.ECBehaviorNavigator.getAllBehaviorsIn ( BehaviorElementClass  eclass)
static

Get list of all behaviors in element.

Returns list contains ECBehaviorNavigator behaviors in the order they have been created in the element.

◆ getAllInstancesIn()

static Array Dragengine.Scenery.ECBehaviorNavigator.getAllInstancesIn ( BehaviorElement  element)
static

Get list of all instances in element.

Returns list contains ECBehaviorNavigator.Instance instances in the order they have been created in the element.

◆ getBehaviorIn() [1/2]

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

◆ getBehaviorIn() [2/2]

static ECBehaviorNavigator Dragengine.Scenery.ECBehaviorNavigator.getBehaviorIn ( BehaviorElementClass  eclass,
String  id 
)
static

Get behavior with id in element class or null if absent.

Use this method to check if a particular BehaviorElementClass contains a behavior of type ECBehaviorNavigator with specific identifier.

◆ getInstanceIn() [1/2]

static Instance Dragengine.Scenery.ECBehaviorNavigator.getInstanceIn ( BehaviorElement  element)
static

Get instance in element or null if absent.

Use this method to check if a particular BehaviorElement contains a behavior instance of type ECBehaviorNavigator.Instance . If more than one instance is present returns the first instance.

◆ getInstanceIn() [2/2]

static Instance Dragengine.Scenery.ECBehaviorNavigator.getInstanceIn ( BehaviorElement  element,
String  id 
)
static

Get instance with id in element or null if absent.

Use this method to check if a particular BehaviorElement contains a behavior instance of type ECBehaviorNavigator.Instance with specific identifier.

◆ getLayer()

ECPInteger Dragengine.Scenery.ECBehaviorNavigator.getLayer ( )

Navigation space layer to use.

◆ getSpaceType()

ECPEnumeration Dragengine.Scenery.ECBehaviorNavigator.getSpaceType ( )

Navigation space type to use (NavigationSpace.{GRID|MESH|VOLUME}).

◆ instance()

Instance Dragengine.Scenery.ECBehaviorNavigator.instance ( BehaviorElement  element)

Get instance in element from owner element class.

◆ new() [1/3]

ECBehaviorNavigator Dragengine.Scenery.ECBehaviorNavigator.new ( BehaviorElementClass  eclass)

Create behavior element class.

Reimplemented from Dragengine.Scenery.DefaultECBehavior.

◆ new() [2/3]

ECBehaviorNavigator Dragengine.Scenery.ECBehaviorNavigator.new ( BehaviorElementClass  eclass,
String  id 
)

Create behavior element class.

Reimplemented from Dragengine.Scenery.DefaultECBehavior.

◆ new() [3/3]

ECBehaviorNavigator Dragengine.Scenery.ECBehaviorNavigator.new ( BehaviorElementClass  eclass,
String  id,
String  prefix 
)

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