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

Behavior instance. More...

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

Classes

class  ActivateListener
 Trigger listener to enable forceField. More...
 

Public Member Functions

void addListener (Listener listener)
 Add listener. More...
 
void addToGameWorld ()
 Add element to game world. More...
 
void dispose ()
 Dispose of behavior instance. More...
 
ECBehaviorCollider.Instance getCollider ()
 Collider behavior or null if not attached. More...
 
bool getCustomForceFieldHandling ()
 Force field parameters are handled by another behavior. More...
 
ECBehaviorForceField getECBehavior ()
 Behavior. More...
 
bool getEnabled ()
 Force field is enabled. More...
 
ForceField getForceField ()
 Force field. More...
 
ECBehaviorTriggered.Instance getTrigger ()
 Trigger enable or null. More...
 
void init (StubElement stub)
 Initialize element from stub. More...
 
Instance new (ECBehaviorForceField ecbehavior, BehaviorElement element)
 Create element. More...
 
void notifyParametersChanged ()
 Notify listeners force field parameters changed. More...
 
void readFromFile (PersistencyEnvironment env, FileReader reader)
 Read element from file. More...
 
void removeFromGameWorld ()
 Remove element from game world. More...
 
void removeListener (Listener listener)
 Remove listener. More...
 
void setCustomForceFieldHandling (bool customForceFieldHandling)
 Set if force field parameters are handled by another behavior. More...
 
void setEnabled (bool enabled)
 Set if force field is enabled. More...
 
void stateChanged ()
 State changed (visible, touchable). More...
 
void toggle ()
 Toggle force field enabled state. More...
 
void writeToFile (PersistencyEnvironment env, FileWriter writer)
 
- 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 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...
 
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...
 

Protected Member Functions

void attachForceField (StubElement stub, ECBehaviorCollider.Instance collider)
 Attach force field to collider. More...
 
ForceField createForceField (StubElement stub)
 Create forceField. More...
 
ECBehaviorTriggered.Instance getTriggerBehavior ()
 Get enable trigger behavior. 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

◆ addListener()

void Dragengine.Scenery.ECBehaviorForceField.Instance.addListener ( Listener  listener)

Add listener.

◆ addToGameWorld()

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

Add element to game world.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ attachForceField()

void Dragengine.Scenery.ECBehaviorForceField.Instance.attachForceField ( StubElement  stub,
ECBehaviorCollider.Instance  collider 
)
protected

Attach force field to collider.

Default implementation calls ECComposeAttachResource.attach().

◆ createForceField()

ForceField Dragengine.Scenery.ECBehaviorForceField.Instance.createForceField ( StubElement  stub)
protected

Create forceField.

Default implementation calls ECComposeForceField.createForceField().

◆ dispose()

void Dragengine.Scenery.ECBehaviorForceField.Instance.dispose ( )

Dispose of behavior instance.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ getCollider()

ECBehaviorCollider.Instance Dragengine.Scenery.ECBehaviorForceField.Instance.getCollider ( )

Collider behavior or null if not attached.

◆ getCustomForceFieldHandling()

bool Dragengine.Scenery.ECBehaviorForceField.Instance.getCustomForceFieldHandling ( )

Force field parameters are handled by another behavior.

◆ getECBehavior()

ECBehaviorForceField Dragengine.Scenery.ECBehaviorForceField.Instance.getECBehavior ( )

Behavior.

◆ getEnabled()

bool Dragengine.Scenery.ECBehaviorForceField.Instance.getEnabled ( )

Force field is enabled.

◆ getForceField()

ForceField Dragengine.Scenery.ECBehaviorForceField.Instance.getForceField ( )

Force field.

◆ getTrigger()

ECBehaviorTriggered.Instance Dragengine.Scenery.ECBehaviorForceField.Instance.getTrigger ( )

Trigger enable or null.

◆ getTriggerBehavior()

ECBehaviorTriggered.Instance Dragengine.Scenery.ECBehaviorForceField.Instance.getTriggerBehavior ( )
protected

Get enable trigger behavior.

Default implementation uses owner class trigger behavior. If getSyncTrigger() of parent ECBehaviorForceField is not null uses referenced behavior trigger behavior.

◆ init()

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

Initialize element from stub.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ new()

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

Create element.

◆ notifyParametersChanged()

void Dragengine.Scenery.ECBehaviorForceField.Instance.notifyParametersChanged ( )

Notify listeners force field parameters changed.

Call this method after changing force field parameters other than (de)activating forceField.

◆ readFromFile()

void Dragengine.Scenery.ECBehaviorForceField.Instance.readFromFile ( PersistencyEnvironment  env,
FileReader  reader 
)

Read element from file.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ removeFromGameWorld()

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

Remove element from game world.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ removeListener()

void Dragengine.Scenery.ECBehaviorForceField.Instance.removeListener ( Listener  listener)

Remove listener.

◆ setCustomForceFieldHandling()

void Dragengine.Scenery.ECBehaviorForceField.Instance.setCustomForceFieldHandling ( bool  customForceFieldHandling)

Set if force field parameters are handled by another behavior.

◆ setEnabled()

void Dragengine.Scenery.ECBehaviorForceField.Instance.setEnabled ( bool  enabled)

Set if force field is enabled.

◆ stateChanged()

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

State changed (visible, touchable).

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.

◆ toggle()

void Dragengine.Scenery.ECBehaviorForceField.Instance.toggle ( )

Toggle force field enabled state.

◆ writeToFile()

void Dragengine.Scenery.ECBehaviorForceField.Instance.writeToFile ( PersistencyEnvironment  env,
FileWriter  writer 
)

Writes the element to a file.

Reimplemented from Dragengine.Scenery.DefaultECBehaviorInstance.


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