Actor element class. More...

Inheritance diagram for Dragengine.Scenery.BaseActorClass:

Public Member Functions
void	addBehaviorFactories ()
	Add behavior factories supported by this element class.

ElementClass	duplicateNamed (String classname)
	Create copy of element class.

ECBehaviorActorAnimated	getActorAnimated ()
	Actor animated behavior.

ECBehaviorActorMover	getActorMover ()
	Actor mover behavior.

ECBehaviorActorAIAction	getAIAction ()
	AI-Action behavior.

ECBehaviorAlignActor	getAlignActor ()
	Align actor behavior.

ECBehaviorAvoidCollision	getAvoidCollision ()
	Avoid collision behavior.

ECBehaviorAvoidedByActor	getAvoidedByActor ()
	Avoided by actor behavior.

ECBehaviorBehaviorTree	getBehaviorTree ()
	Behavior tree.

ECBehaviorCollider	getCollider ()
	Collider behavior.

ECBehaviorColliderAI	getColliderAI ()
	Collider AI behavior.

ECBehaviorComponent	getComponent ()
	Component behavior.

ECBehaviorConversationActor	getConversationActor ()
	Conversation actor behavior.

ECBCTRRBindings	getCTRRBindings ()
	Binding tag resolver for conversation actor behavior.

CollisionFilter	getDynamicCollisionFilter ()
	Dynamic collider collision filter for (not AI collider).

ECBehaviorFootSteps	getFootSteps ()
	Foot steps behavior.

ECBehaviorInteractionElement	getInteractionElement ()
	Interact element.

CollisionFilter	getKinematicCollisionFilter ()
	Kinematic collider collision filter for (not AI collider).

ECBehaviorLocomotion	getLocomotion ()
	Locomotion behavior.

ECBehaviorNavigator	getNavigator ()
	Navigator behavior.

ECBehaviorParameterTable	getParameterTable ()
	Parameter table behavior.

ECBehaviorPlayerControllable	getPlayerControllable ()
	Player controllable behavior.

ECBehaviorPlayerInputCrouch	getPlayerInputCrouch ()
	Player input crouching behavior.

ECBehaviorPlayerInputLook	getPlayerInputLook ()
	Player input looking around behavior.

ECBehaviorPlayerInputMove	getPlayerInputMove ()
	Player input moving behavior.

ECBehaviorPlayerInputTurn	getPlayerInputTurn ()
	Player input turning behavior.

ECBehaviorProjectToGround	getProjectToGround ()
	Project to ground behavior.

ECBehaviorRideOn	getRideOn ()
	Ride on behavior.

ECBehaviorStateMachine	getStateMachine ()
	State machine.

BaseActorClass	new ()
	Create element class using loaders from BaseGameApp.

BaseActorClass	new (Loaders loaders, ECBehaviorPlayerControllable.Tracker tracker)
	Create element class.

BaseActorClass	new (String className)
	Create element class using loaders from BaseGameApp.

BaseActorClass	new (String className, Loaders loaders, ECBehaviorPlayerControllable.Tracker tracker)
	Create element class.

Public Member Functions inherited from Dragengine.Scenery.BehaviorElementClass
void	addAttachableBehaviorFactories ()
	Add attachable behavior factories supported by this element class.

void	addAttachableBehaviorFactories (AttachableBehaviorFactoryList factories)
	Add attachable behavior factories replacing duplicates if present.

void	addAttachableBehaviorFactory (AttachableBehaviorFactory factory)
	Add attachable behavior factory replacing duplicate if present.

void	addBehavior (ECBehavior behavior)
	Add behavior.

void	addBehaviorFactories (BehaviorFactoryList factories)
	Add behavior factories replacing duplicates if present.

void	addDefaultAttachableBehaviorFactories ()
	Add all attachable behavior factories present in the DragonScript module.

void	addDefaultBehaviorFactories ()
	Add all behavior factories present in the DragonScript module.

void	addXmlBehaviorInfo (BehaviorFactory factory, String id, Dictionary parameters)
	Add XML behavior information required for XML-XML subclassing.

Array	collectBehaviors (Block ablock)
	Collect behaviors with block into Array.

void	createAndAddElement (StubElement stub, GameWorld gameWorld)
	Create element from given stub and add it to game world.

void	dispose ()
	Dispose of element class.

ECBehavior	findBehavior (Block ablock)
	Find behavior with block.

void	forEachAttachableBehaviorFactory (Block ablock)
	Visit attachable behavior factories.

void	forEachBehavior (Block ablock)
	Visit behaviors with block.

void	forEachBehaviorDirect (Block ablock)
	Visit behaviors with block.

void	forEachBehaviorFactory (Block ablock)
	Visit behavior factories.

void	forEachPrepareStubBehavior (Block ablock)
	Visit prepare stub behaviors with block. version 1.23.

void	forEachPreventCreationBehavior (Block ablock)
	Visit prevent creation behaviors with block. version 1.23.

void	forEachXmlBehaviorInfo (Block ablock)
	Visit XML behavior info with block with argument XmlBehaviorInfo.

AttachableBehaviorFactory	getAttachableBehaviorFactoryWithId (String id)
	Attachable behavior factory with identifier or null if absent.

ECBehavior	getBehaviorAt (int index)
	Behavior at index.

BehaviorFactory	getBehaviorFactoryWithId (String id)
	Behavior factory with identifier or null if absent.

ECBehavior	getBehaviorWithId (String id)
	Behavior with matching BehaviorCompatiblePersistency::getBehaviorID() or null.

BehaviorElementClass	new (Loaders loaders)
	Create element class.

BehaviorElementClass	new (String className, Loaders loaders)
	Create element class.

void	prepareStubs (StubElement stub, GameWorld gameWorld, bool loading)
	Call prepareStub on all prepare stub behaviors.

bool	preventCreation (StubElement stub, GameWorld gameWorld)
	Call prepareStub on all prepare stub behaviors.

void	removeAllAttachableBehaviorFactories ()
	Remove all attachable behavior factories.

void	removeAllBehaviorFactories ()
	Remove all behavior factories.

Public Member Functions inherited from Dragengine.Scenery.ElementClass
void	addProperty (ElementClassProperty property)
	Add property.

void	copyPropertyValues (ElementClass eclass)
	Copy values of properties from another class to properties of this class.

Element	createElement (StubElement stub)
	Create element instance from stub.

bool	equals (Object obj)
	Element class is equal to another object.

void	failedLoading (String path, ResourceLoaderType resourceType)
	Resource failed loading.

void	finishedLoading (String path, ResourceLoaderType resourceType, Object resource)
	Resource finished loading successfully.

void	forEachProperty (Block ablock)
	Visit properties with block with parameter ElementClass.

String	getBasePath ()
	Base path for relative loading of resource properties.

CodecPropertyString	getCodecPropertyString ()
	Property codec helper.

bool	getIsXmlElementClass ()
	Element class is an XML element class.

bool	getPersistable ()
	Element class is persistable to file writers.

int	getPropertyCount ()
	Number of properties.

ElementClassProperty	getPropertyNamed (String name)
	Named property or null if absent.

Array	getPropertyNames ()
	List of property names as array of strings.

TSTriggerExpressionParser	getTriggerExpressionParser ()
	Trigger expression parser.

int	hashCode ()
	Hash code.

bool	hasPropertyNamed (String name)
	Named property is present.

Object	injectProperty (Object injectValue, Block ablock)
	Process value visiting properties.

void	loadAndAddElement (PersistencyEnvironment env, StubElement stub, FileReader reader, GameWorld gameWorld)
	Load element from file reader and add it to game world.

Element	loadElement (PersistencyEnvironment env, StubElement stub, FileReader reader)
	Load element from file reader.

void	removeAllProperties ()
	Remove all properties.

void	removeProperty (ElementClassProperty property)
	Remove property.

void	setBasePath (String path)
	Set base path for relative loading of resource properties.

void	setIsXmlElementClass (bool isXmlElementClass)
	Set if element class is an XML element class.

void	setPersistable (bool persistable)
	Set element class is persistable to file writers.

void	setPropertyValue (String name, Object value)
	Set value of named property.

Notification

Public Attributes
ECBehaviorActorAnimated	pActorAnimated

ECBehaviorActorMover	pActorMover

ECBehaviorActorAIAction	pAIAction

ECBehaviorAlignActor	pAlignActor

ECBehaviorAvoidCollision	pAvoidCollision

ECBehaviorAvoidedByActor	pAvoidedByActor

ECBehaviorBehaviorTree	pBehaviorTree

ECBehaviorCollider	pCollider

ECBehaviorColliderAI	pColliderAI

ECBehaviorComponent	pComponent

ECBehaviorConversationActor	pConversationActor

ECBCTRRBindings	pCTRRBindings

ECBehaviorFootSteps	pFootSteps

ECBehaviorInteractionElement	pInteractionElement

ECBehaviorLocomotion	pLocomotion

ECBehaviorNavigator	pNavigator

ECBehaviorParameterTable	pParameterTable

ECBehaviorPlayerControllable	pPlayerControllable

ECBehaviorPlayerInputCrouch	pPlayerInputCrouch

ECBehaviorPlayerInputLook	pPlayerInputLook

ECBehaviorPlayerInputMove	pPlayerInputMove

ECBehaviorPlayerInputTurn	pPlayerInputTurn

ECBehaviorProjectToGround	pProjectToGround

ECBehaviorRideOn	pRideOn

ECBehaviorStateMachine	pStateMachine

Public Attributes inherited from Dragengine.Scenery.BehaviorElementClass
Dictionary	pBehaviorFactories

Dictionary	pBehaviorIdMap

Array	pBehaviors

Array	pXmlBehaviorsInfo

Protected Member Functions
Element	createElement ()
	Create element instance.

Additional Inherited Members
Static Public Member Functions inherited from Dragengine.Scenery.ElementClass
static CodecPropertyString	getSharedCodecPropertyString ()
	Shared property codec helper.

static TSTriggerExpressionParser	getSharedTriggerExpressionParser ()
	Shared trigger expression parser.

static void	setSharedCodecPropertyString (CodecPropertyString codec)
	Set shared property codec helper.

static void	setSharedTriggerExpressionParser (TSTriggerExpressionParser parser)
	Set shared trigger expression parser.

Static Public Attributes inherited from Dragengine.Scenery.BehaviorElementClass
static BehaviorFactoryHelper	sharedFactoryHelper = BehaviorFactoryHelper.new()

Detailed Description

Actor element class.

Behavior XML Element Class.

This class can be recreated using GenericBehaviorElementClass and this *.deeclass file:

<?xml version='1.0' encoding='UTF-8'?>
<elementClass name='MyClass' class='GenericBehaviorElement'>
  <behavior type='ECBehaviorBehaviorTree'/>
  <behavior type='ECBehaviorStateMachine'>
    <string name='.path'>/shareddata/stateMachines/actorAction/firstPerson.desm</string>
  </behavior>
  <behavior type='ECBehaviorInteractionElement'/>
  <behavior type='ECBehaviorComponent'>
    <!-- actors are best not affecting sound nor showing up in env maps since they
         are dynamic. still doing so is usually expensive for modules to perform -->
    <boolean name='.renderEnvMap'>false</boolean>
    <boolean name='.affectsAudio'>false</boolean>
    <string name='.hintMovement'>dynamic</string>
  </behavior>
  <behavior type='ECBehaviorCollider'/>
  <behavior type='ECBehaviorColliderAI'/>
  <behavior type='ECBehaviorParameterTable'/>
  <behavior type='ECBehaviorProjectToGround'/>
  <behavior type='ECBehaviorLocomotion'/>
  <behavior type='ECBehaviorActorAnimated'/>
  <behavior type='ECBehaviorConversationActor'/>
  <behavior type='ECBCTRRBindings'/>
  <behavior type='ECBehaviorNavigator'/>
  <behavior type='ECBehaviorFootSteps'/>
  <behavior type='ECBehaviorRideOn'/>
  <behavior type='ECBehaviorActorMover'/>
  <behavior type='ECBehaviorAlignActor'/>
  <behavior type='ECBehaviorAvoidedByActor'/>
  <behavior type='ECBehaviorAvoidCollision'/>
  <behavior type='ECBehaviorPlayerInputLook'/>
  <behavior type='ECBehaviorPlayerInputTurn'/>
  <behavior type='ECBehaviorPlayerInputCrouch'/>
  <behavior type='ECBehaviorPlayerInputMove'/>
  <behavior type='ECBehaviorPlayerControllable'/>
  <behavior type='ECBehaviorActorAIAction'>
    <string name='.action'>BAAStateMachine</string>
  </behavior>
</elementClass>

It is though usually easier to use the class directly and extend it:

<?xml version='1.0' encoding='UTF-8'?>
<elementClass name='MyClass' class='Actor'>
</elementClass>

Member Function Documentation

◆ addBehaviorFactories()

void Dragengine.Scenery.BaseActorClass.addBehaviorFactories ( )

Add behavior factories supported by this element class.

Default implementation calls #addDefaultBehaviorFactories().

◆ createElement()

Element Dragengine.Scenery.BaseActorClass.createElement ( )

protected

Create element instance.

Reimplemented from Dragengine.Scenery.BehaviorElementClass.

Reimplemented in Dragengine.Scenery.BaseVRActorClass.

◆ duplicateNamed()

ElementClass Dragengine.Scenery.BaseActorClass.duplicateNamed ( String classname )

Create copy of element class.

Reimplemented from Dragengine.Scenery.ElementClass.

◆ getActorAnimated()

ECBehaviorActorAnimated Dragengine.Scenery.BaseActorClass.getActorAnimated ( )

Actor animated behavior.

◆ getActorMover()

ECBehaviorActorMover Dragengine.Scenery.BaseActorClass.getActorMover ( )

Actor mover behavior.

◆ getAIAction()

ECBehaviorActorAIAction Dragengine.Scenery.BaseActorClass.getAIAction ( )

AI-Action behavior.

◆ getAlignActor()

ECBehaviorAlignActor Dragengine.Scenery.BaseActorClass.getAlignActor ( )

Align actor behavior.

◆ getAvoidCollision()

ECBehaviorAvoidCollision Dragengine.Scenery.BaseActorClass.getAvoidCollision ( )

Avoid collision behavior.

◆ getAvoidedByActor()

ECBehaviorAvoidedByActor Dragengine.Scenery.BaseActorClass.getAvoidedByActor ( )

Avoided by actor behavior.

◆ getBehaviorTree()

ECBehaviorBehaviorTree Dragengine.Scenery.BaseActorClass.getBehaviorTree ( )

Behavior tree.

Version: 1.26

◆ getCollider()

ECBehaviorCollider Dragengine.Scenery.BaseActorClass.getCollider ( )

Collider behavior.

◆ getColliderAI()

ECBehaviorColliderAI Dragengine.Scenery.BaseActorClass.getColliderAI ( )

Collider AI behavior.

◆ getComponent()

ECBehaviorComponent Dragengine.Scenery.BaseActorClass.getComponent ( )

Component behavior.

◆ getConversationActor()

ECBehaviorConversationActor Dragengine.Scenery.BaseActorClass.getConversationActor ( )

Conversation actor behavior.

◆ getCTRRBindings()

ECBCTRRBindings Dragengine.Scenery.BaseActorClass.getCTRRBindings ( )

Binding tag resolver for conversation actor behavior.

◆ getDynamicCollisionFilter()

CollisionFilter Dragengine.Scenery.BaseActorClass.getDynamicCollisionFilter ( )

Dynamic collider collision filter for (not AI collider).

Version: 1.31

Collision category:

BaseGameApp.CollisionFilterBit::actor

Collision filter:

BaseGameApp.CollisionFilterBit::actor
BaseGameApp.CollisionFilterBit::geometry
BaseGameApp.CollisionFilterBit::dynamic
BaseGameApp.CollisionFilterBit::particle

◆ getFootSteps()

ECBehaviorFootSteps Dragengine.Scenery.BaseActorClass.getFootSteps ( )

Foot steps behavior.

◆ getInteractionElement()

ECBehaviorInteractionElement Dragengine.Scenery.BaseActorClass.getInteractionElement ( )

Interact element.

Version: 1.26

◆ getKinematicCollisionFilter()

CollisionFilter Dragengine.Scenery.BaseActorClass.getKinematicCollisionFilter ( )

Kinematic collider collision filter for (not AI collider).

Version: 1.31

Collision category:

BaseGameApp.CollisionFilterBit::actor

Collision filter:

BaseGameApp.CollisionFilterBit::geometry
BaseGameApp.CollisionFilterBit::dynamic
BaseGameApp.CollisionFilterBit::particle

◆ getLocomotion()

ECBehaviorLocomotion Dragengine.Scenery.BaseActorClass.getLocomotion ( )

Locomotion behavior.

◆ getNavigator()

ECBehaviorNavigator Dragengine.Scenery.BaseActorClass.getNavigator ( )

Navigator behavior.

◆ getParameterTable()

ECBehaviorParameterTable Dragengine.Scenery.BaseActorClass.getParameterTable ( )

Parameter table behavior.

◆ getPlayerControllable()

ECBehaviorPlayerControllable Dragengine.Scenery.BaseActorClass.getPlayerControllable ( )

Player controllable behavior.

◆ getPlayerInputCrouch()

ECBehaviorPlayerInputCrouch Dragengine.Scenery.BaseActorClass.getPlayerInputCrouch ( )

Player input crouching behavior.

◆ getPlayerInputLook()

ECBehaviorPlayerInputLook Dragengine.Scenery.BaseActorClass.getPlayerInputLook ( )

Player input looking around behavior.

◆ getPlayerInputMove()

ECBehaviorPlayerInputMove Dragengine.Scenery.BaseActorClass.getPlayerInputMove ( )

Player input moving behavior.

◆ getPlayerInputTurn()

ECBehaviorPlayerInputTurn Dragengine.Scenery.BaseActorClass.getPlayerInputTurn ( )

Player input turning behavior.

◆ getProjectToGround()

ECBehaviorProjectToGround Dragengine.Scenery.BaseActorClass.getProjectToGround ( )

Project to ground behavior.

◆ getRideOn()

ECBehaviorRideOn Dragengine.Scenery.BaseActorClass.getRideOn ( )

Ride on behavior.

◆ getStateMachine()

ECBehaviorStateMachine Dragengine.Scenery.BaseActorClass.getStateMachine ( )

State machine.

Version: 1.26

◆ new() [1/4]

BaseActorClass Dragengine.Scenery.BaseActorClass.new ( )

Create element class using loaders from BaseGameApp.

Reimplemented from Dragengine.Scenery.BehaviorElementClass.

Reimplemented in Dragengine.Scenery.BaseVRActorClass.

◆ new() [2/4]

BaseActorClass Dragengine.Scenery.BaseActorClass.new	(	Loaders	loaders,
		ECBehaviorPlayerControllable.Tracker	tracker
	)

Create element class.

Reimplemented in Dragengine.Scenery.BaseVRActorClass.

◆ new() [3/4]

BaseActorClass Dragengine.Scenery.BaseActorClass.new ( String className )

Create element class using loaders from BaseGameApp.

Reimplemented from Dragengine.Scenery.BehaviorElementClass.

Reimplemented in Dragengine.Scenery.BaseVRActorClass.

◆ new() [4/4]

BaseActorClass Dragengine.Scenery.BaseActorClass.new	(	String	className,
		Loaders	loaders,
		ECBehaviorPlayerControllable.Tracker	tracker
	)

Create element class.

Reimplemented in Dragengine.Scenery.BaseVRActorClass.

Member Data Documentation

◆ pActorAnimated

ECBehaviorActorAnimated Dragengine.Scenery.BaseActorClass.pActorAnimated

◆ pActorMover

ECBehaviorActorMover Dragengine.Scenery.BaseActorClass.pActorMover

◆ pAIAction

ECBehaviorActorAIAction Dragengine.Scenery.BaseActorClass.pAIAction

◆ pAlignActor

ECBehaviorAlignActor Dragengine.Scenery.BaseActorClass.pAlignActor

◆ pAvoidCollision

ECBehaviorAvoidCollision Dragengine.Scenery.BaseActorClass.pAvoidCollision

◆ pAvoidedByActor

ECBehaviorAvoidedByActor Dragengine.Scenery.BaseActorClass.pAvoidedByActor

◆ pBehaviorTree

ECBehaviorBehaviorTree Dragengine.Scenery.BaseActorClass.pBehaviorTree

◆ pCollider

ECBehaviorCollider Dragengine.Scenery.BaseActorClass.pCollider

◆ pColliderAI

ECBehaviorColliderAI Dragengine.Scenery.BaseActorClass.pColliderAI

◆ pComponent

ECBehaviorComponent Dragengine.Scenery.BaseActorClass.pComponent

◆ pConversationActor

ECBehaviorConversationActor Dragengine.Scenery.BaseActorClass.pConversationActor

◆ pCTRRBindings

ECBCTRRBindings Dragengine.Scenery.BaseActorClass.pCTRRBindings

◆ pFootSteps

ECBehaviorFootSteps Dragengine.Scenery.BaseActorClass.pFootSteps

◆ pInteractionElement

ECBehaviorInteractionElement Dragengine.Scenery.BaseActorClass.pInteractionElement

◆ pLocomotion

ECBehaviorLocomotion Dragengine.Scenery.BaseActorClass.pLocomotion

◆ pNavigator

ECBehaviorNavigator Dragengine.Scenery.BaseActorClass.pNavigator

◆ pParameterTable

ECBehaviorParameterTable Dragengine.Scenery.BaseActorClass.pParameterTable

◆ pPlayerControllable

ECBehaviorPlayerControllable Dragengine.Scenery.BaseActorClass.pPlayerControllable

◆ pPlayerInputCrouch

ECBehaviorPlayerInputCrouch Dragengine.Scenery.BaseActorClass.pPlayerInputCrouch

◆ pPlayerInputLook

ECBehaviorPlayerInputLook Dragengine.Scenery.BaseActorClass.pPlayerInputLook

◆ pPlayerInputMove

ECBehaviorPlayerInputMove Dragengine.Scenery.BaseActorClass.pPlayerInputMove

◆ pPlayerInputTurn

ECBehaviorPlayerInputTurn Dragengine.Scenery.BaseActorClass.pPlayerInputTurn

◆ pProjectToGround

ECBehaviorProjectToGround Dragengine.Scenery.BaseActorClass.pProjectToGround

◆ pRideOn

ECBehaviorRideOn Dragengine.Scenery.BaseActorClass.pRideOn

◆ pStateMachine

ECBehaviorStateMachine Dragengine.Scenery.BaseActorClass.pStateMachine

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

BaseActorClass.ds

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addBehaviorFactories()

◆ createElement()

◆ duplicateNamed()

◆ getActorAnimated()

◆ getActorMover()

◆ getAIAction()

◆ getAlignActor()

◆ getAvoidCollision()

◆ getAvoidedByActor()

◆ getBehaviorTree()

◆ getCollider()

◆ getColliderAI()

◆ getComponent()

◆ getConversationActor()

◆ getCTRRBindings()

◆ getDynamicCollisionFilter()

◆ getFootSteps()

◆ getInteractionElement()

◆ getKinematicCollisionFilter()

◆ getLocomotion()

◆ getNavigator()

◆ getParameterTable()

◆ getPlayerControllable()

◆ getPlayerInputCrouch()

◆ getPlayerInputLook()

◆ getPlayerInputMove()

◆ getPlayerInputTurn()

◆ getProjectToGround()

◆ getRideOn()

◆ getStateMachine()

◆ new() [1/4]

◆ new() [2/4]

◆ new() [3/4]

◆ new() [4/4]

Member Data Documentation

◆ pActorAnimated

◆ pActorMover

◆ pAIAction

◆ pAlignActor

◆ pAvoidCollision

◆ pAvoidedByActor

◆ pBehaviorTree

◆ pCollider

◆ pColliderAI

◆ pComponent

◆ pConversationActor

◆ pCTRRBindings

◆ pFootSteps

◆ pInteractionElement

◆ pLocomotion

◆ pNavigator

◆ pParameterTable

◆ pPlayerControllable

◆ pPlayerInputCrouch

◆ pPlayerInputLook

◆ pPlayerInputMove

◆ pPlayerInputTurn

◆ pProjectToGround

◆ pRideOn

◆ pStateMachine