Dragengine.Scenery.ECBehaviorSky Class Reference

Behavior element behavior adding sky support. More...

Inheritance diagram for Dragengine.Scenery.ECBehaviorSky:

Classes
class	Factory
	Behavior factory. More...
class	Instance
	Behavior instance. More...

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

Static Public Member Functions
static ECBehaviorSky	getBehaviorIn (BehaviorElementClass eclass)
	Get behavior in element class or null if absent.

Public Attributes
ECPString	pControllerPlayback
LayerMask	pLayerMask
ECPInteger	pOrder
ECPFloat	pPassthroughTransparency
ECPSky	pSky

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

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).

See also

https://developer.dragondreams.ch/wiki/doku.php/dragengine:modules:dragonscript:behavior_sky

Member Function Documentation

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.

getLayerMask()

LayerMask Dragengine.Scenery.ECBehaviorSky.getLayerMask

(

)

Layer mask.

getOrder()

ECPInteger Dragengine.Scenery.ECBehaviorSky.getOrder

(

)

Order.

getPassthroughTransparency()

ECPFloat Dragengine.Scenery.ECBehaviorSky.getPassthroughTransparency

(

)

Passthrough transparency factor.

Version

1.29

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.

Member Data Documentation

pControllerPlayback

ECPString Dragengine.Scenery.ECBehaviorSky.pControllerPlayback

pLayerMask

LayerMask Dragengine.Scenery.ECBehaviorSky.pLayerMask

pOrder

ECPInteger Dragengine.Scenery.ECBehaviorSky.pOrder

pPassthroughTransparency

ECPFloat Dragengine.Scenery.ECBehaviorSky.pPassthroughTransparency

pSky

ECPSky Dragengine.Scenery.ECBehaviorSky.pSky

---

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

• ECBehaviorSky.ds