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

Sky or sky instance controller. More...

Inheritance diagram for Dragengine.Scenery.SkyController:

Public Member Functions

Management
Sky getSky ()
 Owner sky or null if not owned by sky. More...
 
SkyInstance getSkyInstance ()
 Onwer sky instance or null if not owned by sky instance. More...
 
int getControllerIndex ()
 Controller index. More...
 
Controllers
String getName ()
 Name. More...
 
void setName (String name)
 Set name. More...
 
float getLower ()
 Lower limit. More...
 
float getUpper ()
 Upper limit. More...
 
void setRange (float lower, float upper)
 Set value range. More...
 
float getValue ()
 Value. More...
 
void setValue (float value)
 Set value. More...
 
bool getFrozen ()
 Controller is frozen. More...
 
void setFrozen (bool frozen)
 Set if controller is frozen. More...
 
bool getClamp ()
 Controller value is clamped instead of wrapped around if outside range. More...
 
void setClamp (bool clamp)
 Set if controller value is clamped instead of wrapped around if outside range. More...
 
void increment (float amount)
 Increment controller value. More...
 
void setToLower ()
 Set controller value to lower value. More...
 
void setToUpper ()
 Set controller value to upper value. More...
 
bool isAtLower ()
 Controller value is at lower value. More...
 
bool isAtUpper ()
 Controller value is at upper value. More...
 

Detailed Description

Sky or sky instance controller.

Wraps a sky or sky instance controller by controller index. Valid only as long as the wrapped sky or sky instance does not change controller layout.

If wrapping a sky instance controller any changes to a controller triggers an update in the game engine.

If wrapping a sky controller the user is responsible to call Sky.contentChanged() after changing one or more controllers. Sky controllers should not be changed if possible after being used in sky instances.

This is a native class.

Member Function Documentation

◆ getClamp()

bool Dragengine.Scenery.SkyController.getClamp ( )

Controller value is clamped instead of wrapped around if outside range.

◆ getControllerIndex()

int Dragengine.Scenery.SkyController.getControllerIndex ( )

Controller index.

◆ getFrozen()

bool Dragengine.Scenery.SkyController.getFrozen ( )

Controller is frozen.

◆ getLower()

float Dragengine.Scenery.SkyController.getLower ( )

Lower limit.

◆ getName()

String Dragengine.Scenery.SkyController.getName ( )

Name.

◆ getSky()

Sky Dragengine.Scenery.SkyController.getSky ( )

Owner sky or null if not owned by sky.

◆ getSkyInstance()

SkyInstance Dragengine.Scenery.SkyController.getSkyInstance ( )

Onwer sky instance or null if not owned by sky instance.

◆ getUpper()

float Dragengine.Scenery.SkyController.getUpper ( )

Upper limit.

◆ getValue()

float Dragengine.Scenery.SkyController.getValue ( )

Value.

◆ increment()

void Dragengine.Scenery.SkyController.increment ( float  amount)

Increment controller value.

◆ isAtLower()

bool Dragengine.Scenery.SkyController.isAtLower ( )

Controller value is at lower value.

◆ isAtUpper()

bool Dragengine.Scenery.SkyController.isAtUpper ( )

Controller value is at upper value.

◆ setClamp()

void Dragengine.Scenery.SkyController.setClamp ( bool  clamp)

Set if controller value is clamped instead of wrapped around if outside range.

◆ setFrozen()

void Dragengine.Scenery.SkyController.setFrozen ( bool  frozen)

Set if controller is frozen.

◆ setName()

void Dragengine.Scenery.SkyController.setName ( String  name)

Set name.

◆ setRange()

void Dragengine.Scenery.SkyController.setRange ( float  lower,
float  upper 
)

Set value range.

◆ setToLower()

void Dragengine.Scenery.SkyController.setToLower ( )

Set controller value to lower value.

◆ setToUpper()

void Dragengine.Scenery.SkyController.setToUpper ( )

Set controller value to upper value.

◆ setValue()

void Dragengine.Scenery.SkyController.setValue ( float  value)

Set value.


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