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

Behavior adding support to elements to be ridden by actors. More...

Inheritance diagram for Dragengine.Scenery.ECBehaviorRidable:
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...
 
void dispose ()
 Dispose of behavior. More...
 
ECBehaviorCollider getCollider ()
 Collider behavior. More...
 
Instance instance (BehaviorElement element)
 Get instance in element from owner element class. More...
 
ECBehaviorRidable new (BehaviorElementClass eclass, ECBehaviorCollider collider)
 Create behavior. More...
 
- 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...
 

Static Public Member Functions

static ECBehaviorRidable getBehaviorIn (BehaviorElementClass eclass)
 Get behavior in element class or null if absent. More...
 
static Instance getInstanceIn (BehaviorElement element)
 Get instance in element or null if absent. More...
 

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 adding support to elements to be ridden by actors.

Actors will attach using relative mode if ECBehaviorProjectToGround hits this element.

Default property prefix is "ridable."

Member Function Documentation

◆ createInstance()

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

Create Behavior instance.

Implements Dragengine.Scenery.ECBehavior.

◆ dispose()

void Dragengine.Scenery.ECBehaviorRidable.dispose ( )

Dispose of behavior.

Reimplemented from Dragengine.Scenery.DefaultECBehavior.

◆ getBehaviorIn()

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

◆ getCollider()

ECBehaviorCollider Dragengine.Scenery.ECBehaviorRidable.getCollider ( )

Collider behavior.

◆ getInstanceIn()

static Instance Dragengine.Scenery.ECBehaviorRidable.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 ECBehaviorRidable.Instance . If more than one instance is present returns the first instance.

◆ instance()

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

Get instance in element from owner element class.

◆ new()

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

Create behavior.


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