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

Sky instance. More...

Inheritance diagram for Dragengine.Scenery.SkyInstance:

Public Member Functions

Constructors
SkyInstance new ()
 Create sky instance. More...
 
Management
Sky getSky ()
 Sky or null if not set. More...
 
void setSky (Sky sky)
 Set sky or null if not set. More...
 
int getOrder ()
 Render order with higher order covering lower order. More...
 
void setOrder (int order)
 Set render order with higher order covering lower order. More...
 
LayerMask getLayerMask ()
 Layer mask. More...
 
void setLayerMask (LayerMask layerMask)
 Set layer mask. More...
 
Controllers
int getControllerCount ()
 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...
 

Detailed Description

Sky instance.

This is a native class.

Member Function Documentation

◆ getControllerAt()

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

Get wrapper for controller.

Warning
The wrapper is only valid as long as the sky is not changed and the controller structure in the 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.SkyInstance.getControllerCount ( )

Number of controllers.

◆ getControllerNamed()

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

Get wrapper for controller if present.

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

◆ getLayerMask()

LayerMask Dragengine.Scenery.SkyInstance.getLayerMask ( )

Layer mask.

◆ getOrder()

int Dragengine.Scenery.SkyInstance.getOrder ( )

Render order with higher order covering lower order.

◆ getSky()

Sky Dragengine.Scenery.SkyInstance.getSky ( )

Sky or null if not set.

◆ indexOfControllerNamed()

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

Index of named controller or -1 if not found.

◆ new()

SkyInstance Dragengine.Scenery.SkyInstance.new ( )

Create sky instance.

◆ setLayerMask()

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

Set layer mask.

◆ setOrder()

void Dragengine.Scenery.SkyInstance.setOrder ( int  order)

Set render order with higher order covering lower order.

◆ setSky()

void Dragengine.Scenery.SkyInstance.setSky ( Sky  sky)

Set sky or null if not set.


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