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

Behavior element behavior adding day time sky support. More...

Inheritance diagram for Dragengine.Scenery.ECBehaviorDayTimeSky:
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 getController ()
 Name of day time controller. More...
 
ECPFloat getDayTime ()
 Day time as hour of day in the range from 0 to 24. More...
 
ECBehaviorSky getSky ()
 Sky behavior. More...
 
Instance instance (BehaviorElement element)
 Get instance in element from owner element class. More...
 
ECBehaviorDayTimeSky new (BehaviorElementClass eclass, ECBehaviorSky sky)
 Create behavior element class. More...
 
ECBehaviorDayTimeSky new (BehaviorElementClass eclass, ECBehaviorSky sky, String prefix)
 Create behavior element class. 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 ECBehaviorDayTimeSky 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
DefaultECBehavior new (BehaviorElementClass eclass)
 Create default composeable behavior with empty identifier. More...
 
DefaultECBehavior new (BehaviorElementClass eclass, String id)
 Create default composeable behavior. More...
 
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 day time sky support.

Updates day time controller of a day time supporting sky assigned to ECBehaviorSky. To use add ECBehaviorSky and ECBehaviorDayTimeSky to behavior element then call setDayTime() to adjust the day time to show.

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

Element class properties have the prefix "dayTimeSky.".

This behavior supports persistable element class (setPersistable).

Member Function Documentation

◆ createInstance()

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

Create Behavior instance.

Implements Dragengine.Scenery.ECBehavior.

◆ getBehaviorIn()

static ECBehaviorDayTimeSky Dragengine.Scenery.ECBehaviorDayTimeSky.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.

◆ getController()

ECPString Dragengine.Scenery.ECBehaviorDayTimeSky.getController ( )

Name of day time controller.

◆ getDayTime()

ECPFloat Dragengine.Scenery.ECBehaviorDayTimeSky.getDayTime ( )

Day time as hour of day in the range from 0 to 24.

◆ getInstanceIn()

static Instance Dragengine.Scenery.ECBehaviorDayTimeSky.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 ECBehaviorDayTimeSky.Instance .

◆ getSky()

ECBehaviorSky Dragengine.Scenery.ECBehaviorDayTimeSky.getSky ( )

Sky behavior.

◆ instance()

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

Get instance in element from owner element class.

◆ new() [1/2]

ECBehaviorDayTimeSky Dragengine.Scenery.ECBehaviorDayTimeSky.new ( BehaviorElementClass  eclass,
ECBehaviorSky  sky 
)

Create behavior element class.

◆ new() [2/2]

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

Create behavior element class.


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