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

Composable light for element class. More...

Inheritance diagram for Dragengine.Scenery.ECComposeLight:

Public Member Functions

Light createLight (Element element, StubElement stub)
 Initialize light for element from stub. More...
 
TSTriggerExpression createTriggerActivate (Element element, StubElement stub)
 Create activate light trigger expression from stub or null if not used. More...
 
TSTriggerExpression createTriggerActivate (Element element, StubElement stub, String defaultValue)
 Create activate light trigger expression from stub or null if not used. More...
 
ECPBoolean getActivated ()
 Initial light activated state. More...
 
ECPFloat getAmbientRatio ()
 Ambient ratio. More...
 
ECPBoolean getCastShadows ()
 Light is casting shadows. More...
 
ECPColor getColor ()
 Light color. More...
 
ECPFloat getHalfIntensityDistance ()
 Half intensity distance. More...
 
ECPEnumeration getHintMovement ()
 Hint movement. More...
 
ECPEnumeration getHintParameter ()
 Hint parameter. More...
 
ECPInteger getHintShadowImportance ()
 Hint shadow importance. More...
 
ECPFloat getIntensity ()
 Light intensity. More...
 
LayerMask getLayerMask ()
 Layer mask affecting lighting. More...
 
LayerMask getLayerMaskShadow ()
 Layer mask affecting shadow casting. More...
 
ECPSkin getLightSkin ()
 Light skin. More...
 
String getPrefix ()
 Property prefix. More...
 
ECPFloat getRange ()
 Light range. More...
 
ECPShapeList getShape ()
 Light shape. More...
 
ECPFloat getSpotAngle ()
 Outer spot Angle. More...
 
ECPFloat getSpotExponent ()
 Spot exponent. More...
 
ECPFloat getSpotRatio ()
 Spot ratio as height divided by width. More...
 
ECPFloat getSpotSmoothness ()
 Spot smoothness. More...
 
ECPEnumeration getType ()
 Light type. More...
 
ECComposeLight new (ElementClass ownerClass)
 Create composable element class. More...
 
ECComposeLight new (ElementClass ownerClass, String prefix)
 Create composable element class. More...
 
void setLayerMask (LayerMask layerMask)
 Set layer mask affecting lighting. More...
 
void setLayerMaskShadow (LayerMask layerMask)
 Set layer mask affecting shadow casting. More...
 

Detailed Description

Composable light for element class.

Provides light support to element class without subclassing from a specific class.

Member Function Documentation

◆ createLight()

Light Dragengine.Scenery.ECComposeLight.createLight ( Element  element,
StubElement  stub 
)

Initialize light for element from stub.

◆ createTriggerActivate() [1/2]

TSTriggerExpression Dragengine.Scenery.ECComposeLight.createTriggerActivate ( Element  element,
StubElement  stub 
)

Create activate light trigger expression from stub or null if not used.

◆ createTriggerActivate() [2/2]

TSTriggerExpression Dragengine.Scenery.ECComposeLight.createTriggerActivate ( Element  element,
StubElement  stub,
String  defaultValue 
)

Create activate light trigger expression from stub or null if not used.

◆ getActivated()

ECPBoolean Dragengine.Scenery.ECComposeLight.getActivated ( )

Initial light activated state.

◆ getAmbientRatio()

ECPFloat Dragengine.Scenery.ECComposeLight.getAmbientRatio ( )

Ambient ratio.

◆ getCastShadows()

ECPBoolean Dragengine.Scenery.ECComposeLight.getCastShadows ( )

Light is casting shadows.

◆ getColor()

ECPColor Dragengine.Scenery.ECComposeLight.getColor ( )

Light color.

◆ getHalfIntensityDistance()

ECPFloat Dragengine.Scenery.ECComposeLight.getHalfIntensityDistance ( )

Half intensity distance.

◆ getHintMovement()

ECPEnumeration Dragengine.Scenery.ECComposeLight.getHintMovement ( )

Hint movement.

◆ getHintParameter()

ECPEnumeration Dragengine.Scenery.ECComposeLight.getHintParameter ( )

Hint parameter.

◆ getHintShadowImportance()

ECPInteger Dragengine.Scenery.ECComposeLight.getHintShadowImportance ( )

Hint shadow importance.

◆ getIntensity()

ECPFloat Dragengine.Scenery.ECComposeLight.getIntensity ( )

Light intensity.

◆ getLayerMask()

LayerMask Dragengine.Scenery.ECComposeLight.getLayerMask ( )

Layer mask affecting lighting.

◆ getLayerMaskShadow()

LayerMask Dragengine.Scenery.ECComposeLight.getLayerMaskShadow ( )

Layer mask affecting shadow casting.

◆ getLightSkin()

ECPSkin Dragengine.Scenery.ECComposeLight.getLightSkin ( )

Light skin.

◆ getPrefix()

String Dragengine.Scenery.ECComposeLight.getPrefix ( )

Property prefix.

◆ getRange()

ECPFloat Dragengine.Scenery.ECComposeLight.getRange ( )

Light range.

◆ getShape()

ECPShapeList Dragengine.Scenery.ECComposeLight.getShape ( )

Light shape.

◆ getSpotAngle()

ECPFloat Dragengine.Scenery.ECComposeLight.getSpotAngle ( )

Outer spot Angle.

◆ getSpotExponent()

ECPFloat Dragengine.Scenery.ECComposeLight.getSpotExponent ( )

Spot exponent.

◆ getSpotRatio()

ECPFloat Dragengine.Scenery.ECComposeLight.getSpotRatio ( )

Spot ratio as height divided by width.

◆ getSpotSmoothness()

ECPFloat Dragengine.Scenery.ECComposeLight.getSpotSmoothness ( )

Spot smoothness.

◆ getType()

ECPEnumeration Dragengine.Scenery.ECComposeLight.getType ( )

Light type.

◆ new() [1/2]

ECComposeLight Dragengine.Scenery.ECComposeLight.new ( ElementClass  ownerClass)

Create composable element class.

Adds all properties to ownerClass. If you do not want a property to be configurable using XML subclassing use ownerClass.removeProperty() to remove them.

◆ new() [2/2]

ECComposeLight Dragengine.Scenery.ECComposeLight.new ( ElementClass  ownerClass,
String  prefix 
)

Create composable element class.

Adds all properties to ownerClass. If you do not want a property to be configurable using XML subclassing use ownerClass.removeProperty() to remove them.

◆ setLayerMask()

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

Set layer mask affecting lighting.

◆ setLayerMaskShadow()

void Dragengine.Scenery.ECComposeLight.setLayerMaskShadow ( LayerMask  layerMask)

Set layer mask affecting shadow casting.


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