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

Behavior element element class. More...

Inheritance diagram for Dragengine.Scenery.BehaviorElementClass:
Dragengine.Scenery.ElementClass Dragengine.ResourceListener Dragengine.Gui.MainMenus.Interactive.IMMEnvironmentMapClass Dragengine.Gui.MainMenus.Interactive.IMMLightClass Dragengine.Gui.MainMenus.Interactive.IMMParticleEmitterClass Dragengine.Gui.MainMenus.Interactive.IMMPropClass Dragengine.Gui.MainMenus.Interactive.IMMSpeakerClass Dragengine.Scenery.AttachSlotClass Dragengine.Scenery.AttachableBaseBillboardClass Dragengine.Scenery.AttachableBaseForceFieldClass Dragengine.Scenery.AttachableBaseLightClass Dragengine.Scenery.AttachableBaseParticleEmitterClass Dragengine.Scenery.AttachableBaseSpeakerClass Dragengine.Scenery.BaseActorClass Dragengine.Scenery.BaseBillboardClass Dragengine.Scenery.BaseForceFieldClass Dragengine.Scenery.BaseLightClass Dragengine.Scenery.BaseParticleEmitterClass Dragengine.Scenery.BaseSkyClass Dragengine.Scenery.BaseSpeakerClass Dragengine.Scenery.EnvironmentMapClass Dragengine.Scenery.GhostElementClass Dragengine.Scenery.InfoConvoCoordSystemClass Dragengine.Scenery.PhysicsElementClass Dragengine.Scenery.SimpleElementClass Dragengine.Scenery.TriggerConversationClass Dragengine.Scenery.TriggerEvaluateClass Dragengine.Scenery.TriggerShoutClass Dragengine.Scenery.TriggerTimerClass Dragengine.Scenery.TriggerToggleClass Dragengine.Scenery.TriggerTouchClass Dragengine.TestSystem.TestCaseECBehavior.TestBehaviorElementClass Dragengine.TestSystem.TestCaseECBehaviorPersistency.TestBehaviorElementClass

Public Member Functions

void addBehavior (ECBehavior behavior)
 Add behavior. More...
 
void addPrepareStubBehavior (BehaviorPrepareStub behavior)
 Add behavior to be notified before initialization is done. More...
 
Array collectBehaviors (Block ablock)
 Collect behaviors with block into Array. More...
 
void createAndAddElement (StubElement stub, GameWorld gameWorld)
 Create element from given stub and add it to game world. More...
 
void dispose ()
 Dispose of element class. More...
 
ECBehavior findBehavior (Block ablock)
 Find behavior with block. More...
 
void forEachBehavior (Block ablock)
 Visit behaviors with block. More...
 
void forEachBehaviorDirect (Block ablock)
 Visit behaviors with block. More...
 
void forEachPrepareStubBehavior (Block ablock)
 Visit prepare stub behaviors with block. version 1.23. More...
 
void forEachPreventCreationBehavior (Block ablock)
 Visit prevent creation behaviors with block. version 1.23. More...
 
ECBehavior getBehaviorAt (int index)
 Behavior at index. More...
 
BehaviorElementClass new ()
 Create element class using loaders from BaseGameApp. More...
 
BehaviorElementClass new (Loaders loaders)
 Create element class. More...
 
BehaviorElementClass new (String className)
 Create element class using loaders from BaseGameApp. More...
 
BehaviorElementClass new (String className, Loaders loaders)
 Create element class. More...
 
void prepareStubs (StubElement stub, GameWorld gameWorld, bool loading)
 Call prepareStub on all prepare stub behaviors. More...
 
bool preventCreation (StubElement stub, GameWorld gameWorld)
 Call prepareStub on all prepare stub behaviors. More...
 
- Public Member Functions inherited from Dragengine.Scenery.ElementClass
void addProperty (ElementClassProperty property)
 Add property. More...
 
void copyPropertyValues (ElementClass eclass)
 Copy values of properties from another class to properties of this class. More...
 
Element createElement (StubElement stub)
 Create element instance from stub. More...
 
ElementClass duplicateNamed (String classname)
 Create duplicate of class with new name. More...
 
bool equals (Object obj)
 Element class is equal to another object. More...
 
void failedLoading (String path, ResourceLoaderType resourceType)
 Resource failed loading. More...
 
void finishedLoading (String path, ResourceLoaderType resourceType, Object resource)
 Resource finished loading successfully. More...
 
void forEachProperty (Block ablock)
 Visit properties with block with parameter ElementClass. More...
 
String getBasePath ()
 Base path for relative loading of resource properties. More...
 
CodecPropertyString getCodecPropertyString ()
 Property codec helper. More...
 
bool getIsXmlElementClass ()
 Element class is an XML element class. More...
 
bool getPersistable ()
 Element class is persistable to file writers. More...
 
int getPropertyCount ()
 Number of properties. More...
 
ElementClassProperty getPropertyNamed (String name)
 Named property or null if absent. More...
 
Array getPropertyNames ()
 List of property names as array of strings. More...
 
TSTriggerExpressionParser getTriggerExpressionParser ()
 Trigger expression parser. More...
 
int hashCode ()
 Hash code. More...
 
bool hasPropertyNamed (String name)
 Named property is present. More...
 
Object injectProperty (Object injectValue, Block ablock)
 Process value visiting properties. More...
 
void loadAndAddElement (PersistencyEnvironment env, StubElement stub, FileReader reader, GameWorld gameWorld)
 Load element from file reader and add it to game world. More...
 
Element loadElement (PersistencyEnvironment env, StubElement stub, FileReader reader)
 Load element from file reader. More...
 
void removeAllProperties ()
 Remove all properties. More...
 
void removeProperty (ElementClassProperty property)
 Remove property. More...
 
void setBasePath (String path)
 Set base path for relative loading of resource properties. More...
 
void setIsXmlElementClass (bool isXmlElementClass)
 Set if element class is an XML element class. More...
 
void setPersistable (bool persistable)
 Set element class is persistable to file writers. More...
 
void setPropertyValue (String name, Object value)
 Set value of named property. More...
 
Notification

Public Attributes

Array pBehaviors
 
Array pPrepareStubBehaviors
 
Array pPreventCreationBehaviors
 

Additional Inherited Members

- Static Public Member Functions inherited from Dragengine.Scenery.ElementClass
static CodecPropertyString getSharedCodecPropertyString ()
 Shared property codec helper. More...
 
static TSTriggerExpressionParser getSharedTriggerExpressionParser ()
 Shared trigger expression parser. More...
 
static void setSharedCodecPropertyString (CodecPropertyString codec)
 Set shared property codec helper. More...
 
static void setSharedTriggerExpressionParser (TSTriggerExpressionParser parser)
 Set shared trigger expression parser. More...
 
- Protected Member Functions inherited from Dragengine.Scenery.ElementClass
Element createElement ()
 Create element instance. More...
 

Detailed Description

Behavior element element class.

Behavior elements are jack of all trade elements. They allow building complex element behaviors by using behavior building blocks. These behavior building blocks are provided by ECBehavior classes attached to the element class.

Behavior elements are suited for prototyping and rapid development since they require little written code. For highly optimized elements building them using the conventional way might be a better option. For all other uses behavior elements are fast and reusable.

To create an element based on BehaviorElement create a new subclass of BehaviorElementClass and add all the desired ECBehavior instance. There is no need to subclas BehaviorElement. When creating a new instance the BehaviorElement is filled with ECBehavior created ECBehaviorInstance instances. These provide the actual behavior to the element.

Member Function Documentation

◆ addBehavior()

void Dragengine.Scenery.BehaviorElementClass.addBehavior ( ECBehavior  behavior)

Add behavior.

This is called by constructors of class implementing ECBehavior. Usually you do not have to call this manually.

◆ addPrepareStubBehavior()

void Dragengine.Scenery.BehaviorElementClass.addPrepareStubBehavior ( BehaviorPrepareStub  behavior)

Add behavior to be notified before initialization is done.

Version
1.17

Preinitializing allows behaviors to modify StubElement before Element.init() is called. This can be used to alter the behavior initialization procss my modifying the stub properties or textures.

Usually preinitializing is done for elements to be added to a game world. It is thus possible to use game world stub properties to alter the initialization. This can be used to adjust the behavior depending on what game world they are created for. It is also possible preinitialization is done without the element to be added to a specific game world. In this case gameWorld is null. Behaviors added for preinitializing have to be able to handle gameWorld being null.

◆ collectBehaviors()

Array Dragengine.Scenery.BehaviorElementClass.collectBehaviors ( Block  ablock)

Collect behaviors with block into Array.

Version
1.5

Block is required to have one parameter ECBehavior or subclass thereof and returning true if the right behavior is found otherwise false. Block is called only for behaviors castable to block parameter type.

◆ createAndAddElement()

void Dragengine.Scenery.BehaviorElementClass.createAndAddElement ( StubElement  stub,
GameWorld  gameWorld 
)

Create element from given stub and add it to game world.

Calls BehaviorPrepareStub.prepareStub(StubElement,GameWorld,bool) on behaviors supporting stub preparation. Then calls BehaviorPreventCreation.preventCreation(StubElement,GameWorld) to check if creating and adding the element has to be cancelled. Then calls createElement(StubElement) to obtain new element instance. If returned element is null no further processing is done. Otherwise element is added to gameWorld.

Reimplemented from Dragengine.Scenery.ElementClass.

◆ dispose()

void Dragengine.Scenery.BehaviorElementClass.dispose ( )

◆ findBehavior()

ECBehavior Dragengine.Scenery.BehaviorElementClass.findBehavior ( Block  ablock)

Find behavior with block.

Block is required to have one parameter ECBehavior or subclass thereof and returning true if the right behavior is found otherwise false. Block is called only for behaviors castable to block parameter type.

◆ forEachBehavior()

void Dragengine.Scenery.BehaviorElementClass.forEachBehavior ( Block  ablock)

Visit behaviors with block.

Block is required to have one parameter of type ECBehavior or subclass thereof. Block is called only for behaviors castable to block parameter type.

◆ forEachBehaviorDirect()

void Dragengine.Scenery.BehaviorElementClass.forEachBehaviorDirect ( Block  ablock)

Visit behaviors with block.

Block is required to have one parameter of type ECBehavior. For use by BehaviorElement.

◆ forEachPrepareStubBehavior()

void Dragengine.Scenery.BehaviorElementClass.forEachPrepareStubBehavior ( Block  ablock)

Visit prepare stub behaviors with block. version 1.23.

Block is required to have one parameter of type ECBehavior or subclass thereof. Block is called only for behaviors castable to block parameter type.

◆ forEachPreventCreationBehavior()

void Dragengine.Scenery.BehaviorElementClass.forEachPreventCreationBehavior ( Block  ablock)

Visit prevent creation behaviors with block. version 1.23.

Block is required to have one parameter of type ECBehavior or subclass thereof. Block is called only for behaviors castable to block parameter type.

◆ getBehaviorAt()

ECBehavior Dragengine.Scenery.BehaviorElementClass.getBehaviorAt ( int  index)

Behavior at index.

◆ new() [1/4]

◆ new() [2/4]

BehaviorElementClass Dragengine.Scenery.BehaviorElementClass.new ( Loaders  loaders)

◆ new() [3/4]

◆ new() [4/4]

BehaviorElementClass Dragengine.Scenery.BehaviorElementClass.new ( String  className,
Loaders  loaders 
)

◆ prepareStubs()

void Dragengine.Scenery.BehaviorElementClass.prepareStubs ( StubElement  stub,
GameWorld  gameWorld,
bool  loading 
)

Call prepareStub on all prepare stub behaviors.

Version
1.23

For use by subclasses overwriting createAndAddElement(StubElement,GameWorld) or loadAndAddElement(PersistencyEnvironment,StubElement,FileReader,GameWorld) without super calling.

See also
BehaviorPrepareStub::prepareStub(StubElement,GameWorld,bool)

◆ preventCreation()

bool Dragengine.Scenery.BehaviorElementClass.preventCreation ( StubElement  stub,
GameWorld  gameWorld 
)

Call prepareStub on all prepare stub behaviors.

Version
1.23

For use by subclasses overwriting createAndAddElement(StubElement,GameWorld) without super calling.

See also
BehaviorPreventCreation::preventCreation(StubElement,GameWorld)

Member Data Documentation

◆ pBehaviors

Array Dragengine.Scenery.BehaviorElementClass.pBehaviors

◆ pPrepareStubBehaviors

Array Dragengine.Scenery.BehaviorElementClass.pPrepareStubBehaviors

◆ pPreventCreationBehaviors

Array Dragengine.Scenery.BehaviorElementClass.pPreventCreationBehaviors

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