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

Behavior instance. More...

Inheritance diagram for Dragengine.Scenery.ECBehaviorComponent.Instance:
Dragengine.Scenery.DefaultECBehaviorInstance Dragengine.Scenery.ECBehaviorInstance

Public Member Functions

void addToGameWorld ()
 Add element to game world. More...
 
Component getComponent ()
 Component. More...
 
ECBehaviorComponent getECBehavior ()
 Behavior. More...
 
TextureReplacementList getTextureReplacements ()
 Texture replacements. More...
 
Skin getUsedSkin (String texture)
 Skin in use for texture. More...
 
Skin getUsedSkin (String texture, ObjectReference textureNumber)
 Skin in use for texture. More...
 
void init (StubElement stub)
 Initialize element from stub. More...
 
Instance new (ECBehaviorComponent ecbehavior, BehaviorElement element)
 Create element. More...
 
void removeFromGameWorld ()
 Remove element from game world. More...
 
void stateChanged ()
 State changed (visble, touchable). More...
 
- Public Member Functions inherited from Dragengine.Scenery.DefaultECBehaviorInstance
void attachToParent (Element parent)
 Attach element to object set by the mapper in the IGDE World Editor. More...
 
void dispose ()
 Dispose of behavior instance. More...
 
void enterFrame ()
 Frame update started. More...
 
void geometryChanged ()
 Position or orientation changed. More...
 
BehaviorElement getElement ()
 Behavior element to apply behavior to. More...
 
int getInstanceIndex ()
 Behavior instance index. More...
 
DefaultECBehaviorInstance new (BehaviorElement element)
 Create default composeable instance. More...
 
void postThink (float elapsed)
 Post thinking after physics processing is finished. More...
 
void readFromFile (PersistencyEnvironment env, FileReader reader)
 Read behavior instance from file. More...
 
bool requiresEnterFrame ()
 Behavior instance requires enterFrame() to be called. More...
 
bool requiresThink ()
 Behavior instance requires think() to be called. More...
 
void think (float elapsed)
 Think about what to do for the next frame update. More...
 
void writeToFile (PersistencyEnvironment env, FileWriter writer)
 Write behavior instance to file. More...
 

Protected Member Functions

void attachComponent (StubElement stub, ECBehaviorCollider.Instance collider)
 Attach component to collider. More...
 
Component createComponent (StubElement stub)
 Create component for the element. More...
 
LayerMask createLayerMask (StubElement stub)
 Create component layer mask. More...
 
void replaceComponentTextures (Component component, StubElement stub)
 Replace textures using element class and a stub. More...
 
- Protected Member Functions inherited from Dragengine.Scenery.DefaultECBehaviorInstance
void setRequiresEnterFrame (bool required)
 Set if behavior instance requires enterFrame() to be called. More...
 
void setRequiresThink (bool required)
 Set if behavior instance requires think() to be called. More...
 

Detailed Description

Behavior instance.

Member Function Documentation

◆ addToGameWorld()

void Dragengine.Scenery.ECBehaviorComponent.Instance.addToGameWorld ( )

Add element to game world.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ attachComponent()

void Dragengine.Scenery.ECBehaviorComponent.Instance.attachComponent ( StubElement  stub,
ECBehaviorCollider.Instance  collider 
)
protected

Attach component to collider.

Called if ECBehaviorCollider is present in the behavior element. The default implementation attaches the component statically to the collider. For this to work the component has to be in the right position relative to the collider.

◆ createComponent()

Component Dragengine.Scenery.ECBehaviorComponent.Instance.createComponent ( StubElement  stub)
protected

Create component for the element.

The default implementation creates a component using the component parameters stored in the element class. If not all required resources can be found an exception is thrown. Overwrite to modify component creation process using parameters stored in the sub if required.

◆ createLayerMask()

LayerMask Dragengine.Scenery.ECBehaviorComponent.Instance.createLayerMask ( StubElement  stub)
protected

Create component layer mask.

Default implementation calls ECComposeComponent.createLayerMask.

◆ getComponent()

Component Dragengine.Scenery.ECBehaviorComponent.Instance.getComponent ( )

◆ getECBehavior()

ECBehaviorComponent Dragengine.Scenery.ECBehaviorComponent.Instance.getECBehavior ( )

Behavior.

◆ getTextureReplacements()

TextureReplacementList Dragengine.Scenery.ECBehaviorComponent.Instance.getTextureReplacements ( )

Texture replacements.

◆ getUsedSkin() [1/2]

Skin Dragengine.Scenery.ECBehaviorComponent.Instance.getUsedSkin ( String  texture)

Skin in use for texture.

If component texture is set and skîn is assigned returns component texture skin. Otherwise returns component skin.

◆ getUsedSkin() [2/2]

Skin Dragengine.Scenery.ECBehaviorComponent.Instance.getUsedSkin ( String  texture,
ObjectReference  textureNumber 
)

Skin in use for texture.

If component texture is set and skîn is assigned returns component texture skin. Otherwise returns component skin.

◆ init()

void Dragengine.Scenery.ECBehaviorComponent.Instance.init ( StubElement  stub)

Initialize element from stub.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ new()

Instance Dragengine.Scenery.ECBehaviorComponent.Instance.new ( ECBehaviorComponent  ecbehavior,
BehaviorElement  element 
)

Create element.

◆ removeFromGameWorld()

void Dragengine.Scenery.ECBehaviorComponent.Instance.removeFromGameWorld ( )

Remove element from game world.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ replaceComponentTextures()

void Dragengine.Scenery.ECBehaviorComponent.Instance.replaceComponentTextures ( Component  component,
StubElement  stub 
)
protected

Replace textures using element class and a stub.

◆ stateChanged()

void Dragengine.Scenery.ECBehaviorComponent.Instance.stateChanged ( )

State changed (visble, touchable).

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.


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