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

Simple element class. More...

Inheritance diagram for Dragengine.Scenery.SimpleElementClass:
Dragengine.Scenery.BehaviorElementClass Dragengine.Scenery.ElementClass Dragengine.ResourceListener Dragengine.Scenery.AnimatedElementClass Dragengine.Scenery.HiddenElementClass Dragengine.Scenery.SimpleElementOnRailClass Dragengine.Scenery.TwoStateAnimatedElementClass

Public Member Functions

ElementClass duplicateNamed (String classname)
 Create copy of element class. More...
 
ECBehaviorAttachToParent getAttachToParent ()
 Attach to parent behavior. More...
 
ECBehaviorCollider getCollider ()
 Collider behavior. More...
 
ECBehaviorComponent getComponent ()
 Component behavior. More...
 
ECBehaviorNavigationSpace getNavigationSpace ()
 Navigation space behavior. More...
 
SimpleElementClass new ()
 Create element class using loaders from BaseGameApp. More...
 
SimpleElementClass new (Loaders loaders)
 Create element class. More...
 
SimpleElementClass new (String className)
 Create element class using loaders from BaseGameApp. More...
 
SimpleElementClass new (String className, Loaders loaders)
 Create element class. More...
 
- Public Member Functions inherited from Dragengine.Scenery.BehaviorElementClass
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...
 
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...
 
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

Protected Member Functions

Element createElement ()
 Create element instance. More...
 

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...
 
- Public Attributes inherited from Dragengine.Scenery.BehaviorElementClass
Array pBehaviors
 
Array pPrepareStubBehaviors
 
Array pPreventCreationBehaviors
 

Detailed Description

Simple element class.

Simple behavior element composing of these behaviors:

This class is a quick way to add basic elements to a game world. You can create new element classes by subclassing and adding additional behaviors. It is usually though better to create a new BehaviorElementClass subclass instead adding the desired behaviors. This also allows to use subclassed behaviors for specific needs.

Member Function Documentation

◆ createElement()

Element Dragengine.Scenery.SimpleElementClass.createElement ( )
protected

Create element instance.

If this element class does not support creating elements, for example because the result is not an element, null has to be returned. The default implementation returns null. Subclasses not intending to create elements or requiring special creation handling should subclass createAndAddElement() and loadAndAddElement() bypassing this method.

Reimplemented from Dragengine.Scenery.ElementClass.

Reimplemented in Dragengine.Scenery.TwoStateAnimatedElementClass, Dragengine.Scenery.SimpleElementOnRailClass, Dragengine.Scenery.HiddenElementClass, and Dragengine.Scenery.AnimatedElementClass.

◆ duplicateNamed()

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

◆ getAttachToParent()

ECBehaviorAttachToParent Dragengine.Scenery.SimpleElementClass.getAttachToParent ( )

Attach to parent behavior.

◆ getCollider()

ECBehaviorCollider Dragengine.Scenery.SimpleElementClass.getCollider ( )

Collider behavior.

◆ getComponent()

ECBehaviorComponent Dragengine.Scenery.SimpleElementClass.getComponent ( )

Component behavior.

◆ getNavigationSpace()

ECBehaviorNavigationSpace Dragengine.Scenery.SimpleElementClass.getNavigationSpace ( )

Navigation space behavior.

◆ new() [1/4]

◆ new() [2/4]

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

Create element class.

Reimplemented from Dragengine.Scenery.BehaviorElementClass.

◆ new() [3/4]

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

◆ new() [4/4]

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

Create element class.

Reimplemented from Dragengine.Scenery.BehaviorElementClass.


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