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

Sky. More...

Inheritance diagram for Dragengine.Scenery.Sky:

Public Member Functions

Constructors
Sky new ()
 Create sky. More...
 
Management
Color getBgColor ()
 Background color. More...
 
void setBgColor (Color color)
 Set background color. More...
 
int getControllerCount ()
 Number of controllers. More...
 
void setControllerCount (int count)
 Set number of controllers. More...
 
SkyController getControllerAt (int index)
 Get wrapper for controller. More...
 
SkyController getControllerNamed (String name)
 Get wrapper for controller if present. More...
 
int indexOfControllerNamed (String name)
 Index of named controller or -1 if not found. More...
 
int getLinkCount ()
 Number of links. More...
 
void setLinkCount (int count)
 Set number of links. More...
 
SkyLink getLinkAt (int index)
 Get wrapper for link. More...
 
int getLayerCount ()
 Number of layers. More...
 
void setLayerCount (int count)
 Set number of layers. More...
 
SkyLayer getLayerAt (int index)
 Get wrapper for layer. More...
 
void contentChanged ()
 Notify peer parameters changed. More...
 

Detailed Description

Sky.

This is a native class.

Member Function Documentation

◆ contentChanged()

void Dragengine.Scenery.Sky.contentChanged ( )

Notify peer parameters changed.

Use after changing one or more parameters. If possible avoid changing parameters while sky instances use this sky.

◆ getBgColor()

Color Dragengine.Scenery.Sky.getBgColor ( )

Background color.

◆ getControllerAt()

SkyController Dragengine.Scenery.Sky.getControllerAt ( int  index)

Get wrapper for controller.

Warning
The wrapper is only valid as long as the controller structure in the parent sky is not changed.
Parameters
indexIndex of controller. If index is negative controller count is added to it. This allows to get controllers starting from the last controller.
Exceptions
EOutOfBoundarycontroller is less than -getControllerCount() or larger than or equal to getControllerCount().

◆ getControllerCount()

int Dragengine.Scenery.Sky.getControllerCount ( )

Number of controllers.

◆ getControllerNamed()

SkyController Dragengine.Scenery.Sky.getControllerNamed ( String  name)

Get wrapper for controller if present.

Warning
The wrapper is only valid as long as the controller structure in the animator is not changed.
Parameters
nameName of controller. If no controller with this name is present null is returned.

◆ getLayerAt()

SkyLayer Dragengine.Scenery.Sky.getLayerAt ( int  index)

Get wrapper for layer.

Warning
The wrapper is only valid as long as the layer structure in the parent sky is not changed.
Exceptions
EOutOfBoundarylayer is less than 0 or larger than or equal to getLayerCount().

◆ getLayerCount()

int Dragengine.Scenery.Sky.getLayerCount ( )

Number of layers.

◆ getLinkAt()

SkyLink Dragengine.Scenery.Sky.getLinkAt ( int  index)

Get wrapper for link.

Warning
The wrapper is only valid as long as the link structure in the parent sky is not changed.
Exceptions
EOutOfBoundarylink is less than 0 or larger than or equal to getLinkCount().

◆ getLinkCount()

int Dragengine.Scenery.Sky.getLinkCount ( )

Number of links.

◆ indexOfControllerNamed()

int Dragengine.Scenery.Sky.indexOfControllerNamed ( String  name)

Index of named controller or -1 if not found.

◆ new()

Sky Dragengine.Scenery.Sky.new ( )

Create sky.

◆ setBgColor()

void Dragengine.Scenery.Sky.setBgColor ( Color  color)

Set background color.

◆ setControllerCount()

void Dragengine.Scenery.Sky.setControllerCount ( int  count)

Set number of controllers.

Sets all controllers to default vaules.

◆ setLayerCount()

void Dragengine.Scenery.Sky.setLayerCount ( int  count)

Set number of layers.

Sets all layers to default vaules.

◆ setLinkCount()

void Dragengine.Scenery.Sky.setLinkCount ( int  count)

Set number of links.

Sets all links to default vaules.


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