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

Behavior element behavior adding sky support. More...

Inheritance diagram for Dragengine.Scenery.ECBehaviorSky:
Dragengine.Scenery.DefaultECBehavior Dragengine.Scenery.ECBehavior Dragengine.Scenery.BehaviorCompatiblePersistency

Classes

class  Instance
 Behavior instance. More...
 

Public Member Functions

ECBehaviorInstance createInstance (BehaviorElement element)
 Create Behavior instance. More...
 
ECPString getControllerPlayback ()
 Name of playback controller or empty string if not used. More...
 
LayerMask getLayerMask ()
 Layer mask. More...
 
ECPInteger getOrder ()
 Order. More...
 
ECPSky getSky ()
 Sky resource. More...
 
Instance instance (BehaviorElement element)
 Get instance in element from owner element class. More...
 
ECBehaviorSky new (BehaviorElementClass eclass)
 Create behavior element class. More...
 
ECBehaviorSky new (BehaviorElementClass eclass, Loaders loaders)
 Create behavior element class. More...
 
ECBehaviorSky new (BehaviorElementClass eclass, Loaders loaders, String prefix)
 Create behavior element class. More...
 
ECBehaviorSky new (BehaviorElementClass eclass, String prefix)
 Create behavior element class. More...
 
void setLayerMask (LayerMask layerMask)
 Set layer mask. More...
 
- Public Member Functions inherited from Dragengine.Scenery.DefaultECBehavior
void assignInstanceIndex (int instanceIndex)
 Assign instance index. More...
 
void dispose ()
 Dispose of behavior. More...
 
String getBehaviorID ()
 Unique identifier of behavior. More...
 
String getID ()
 Identifier. More...
 
int getInstanceIndex ()
 Instance index. More...
 
void loadSupportedData (String identifier, PersistencyEnvironment env, FileReader reader, ECBehaviorInstance instance)
 Load instance data of another behavior. More...
 
bool supportsBehaviorID (String identifier)
 Behavior supports loading instance data of another behavior. More...
 

Static Public Member Functions

static ECBehaviorSky getBehaviorIn (BehaviorElementClass eclass)
 Get behavior in element class or null if absent. More...
 
static Instance getInstanceIn (BehaviorElement element)
 Get instance in element or null if absent. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Dragengine.Scenery.DefaultECBehavior
void setBehaviorID (String identifier)
 Set behavior identifier. More...
 
void useClassNameAsBehaviorID ()
 Set behavior identifier to "<class-name>:<identifier>". More...
 
void useFullyQualifiedClassNameAsBehaviorID ()
 Set behavior identifier to "<fully-qualified-class-name>:<identifier>". More...
 

Detailed Description

Behavior element behavior adding sky support.

Adds a SkyInstance resources to the world with support to mainpulate controllers. If a playback controller is set it is updated with the elapsed time. Other behaviors can update individual named controllers to add special effects.

Multiple skies can be added to a game world by different elements. In this case the graphic module concatenates them as if one single sky is used. This allows to split skies into multiple sky instances to add individual effects easily. To ensure the correct drawing order each sky is required to have a unique order value. Higher order values are rendered ontop of lower order values.

This behavior can be present only once in the behavior element.

Element class properties have the prefix "sky.".

This behavior supports persistable element class (setPersistable).

Member Function Documentation

◆ createInstance()

ECBehaviorInstance Dragengine.Scenery.ECBehaviorSky.createInstance ( BehaviorElement  element)

Create Behavior instance.

Implements Dragengine.Scenery.ECBehavior.

◆ getBehaviorIn()

static ECBehaviorSky Dragengine.Scenery.ECBehaviorSky.getBehaviorIn ( BehaviorElementClass  eclass)
static

Get behavior in element class or null if absent.

Use this method to check if a particular BehaviorElementClass contains a behavior of type ECBehaviorComponent.

◆ getControllerPlayback()

ECPString Dragengine.Scenery.ECBehaviorSky.getControllerPlayback ( )

Name of playback controller or empty string if not used.

◆ getInstanceIn()

static Instance Dragengine.Scenery.ECBehaviorSky.getInstanceIn ( BehaviorElement  element)
static

Get instance in element or null if absent.

Use this method to check if a particular BehaviorElement contains a behavior instance of type ECBehaviorSky.Instance .

◆ getLayerMask()

LayerMask Dragengine.Scenery.ECBehaviorSky.getLayerMask ( )

Layer mask.

◆ getOrder()

ECPInteger Dragengine.Scenery.ECBehaviorSky.getOrder ( )

Order.

◆ getSky()

ECPSky Dragengine.Scenery.ECBehaviorSky.getSky ( )

Sky resource.

◆ instance()

Instance Dragengine.Scenery.ECBehaviorSky.instance ( BehaviorElement  element)

Get instance in element from owner element class.

◆ new() [1/4]

ECBehaviorSky Dragengine.Scenery.ECBehaviorSky.new ( BehaviorElementClass  eclass)

Create behavior element class.

Reimplemented from Dragengine.Scenery.DefaultECBehavior.

◆ new() [2/4]

ECBehaviorSky Dragengine.Scenery.ECBehaviorSky.new ( BehaviorElementClass  eclass,
Loaders  loaders 
)

Create behavior element class.

◆ new() [3/4]

ECBehaviorSky Dragengine.Scenery.ECBehaviorSky.new ( BehaviorElementClass  eclass,
Loaders  loaders,
String  prefix 
)

Create behavior element class.

◆ new() [4/4]

ECBehaviorSky Dragengine.Scenery.ECBehaviorSky.new ( BehaviorElementClass  eclass,
String  prefix 
)

Create behavior element class.

Reimplemented from Dragengine.Scenery.DefaultECBehavior.

◆ setLayerMask()

void Dragengine.Scenery.ECBehaviorSky.setLayerMask ( LayerMask  layerMask)

Set layer mask.


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