Properties

$lightAmbientColor

$lightAmbientColor : string

Type

string — Light ambient color

$cloudsMinimumColor

$cloudsMinimumColor : string

Type

string — Clouds minimum color

$cloudsMaximumColor

$cloudsMaximumColor : string

Type

string — Clouds maximum color

$light0Color

$light0Color : string

Type

string — Color of light source 0

$light0Intensity

$light0Intensity : float

Type

float — Intensity of light source 0

$light0PhiAngle

$light0PhiAngle : float

Type

float — Phi angle of light source 0

$light0ThetaAngle

$light0ThetaAngle : float

Type

float — Theta angle of light source 0

$lightBallColor

$lightBallColor : string

Type

string — Light ball color

$lightBallIntensity

$lightBallIntensity : float

Type

float — Light ball intensity

$lightBallRadius

$lightBallRadius : float

Type

float — Light ball radius

$fogColor

$fogColor : string

Type

string — Fog color

$selfIlluminationColor

$selfIlluminationColor : float

Type

float — Self illumination color

$skyGradientScale

$skyGradientScale : float

Type

float — Sky gradient scale

$skyGradientKeys

$skyGradientKeys : array<mixed,\FML\Stylesheet\SkyGradientKey>

Type

array<mixed,\FML\Stylesheet\SkyGradientKey> — Sky Gradient Keys

Methods

create()

create() : static

Create a new Mood

Returns

static

getLightAmbientColor()

getLightAmbientColor() : string

Get the light ambient color

Returns

string

setLightAmbientColor()

setLightAmbientColor(float  $red, float  $green, float  $blue) : static

Set the ambient color in which elements reflect the light

Parameters

float $red

Red color value

float $green

Green color value

float $blue

Blue color value

Returns

static

getCloudsMinimumColor()

getCloudsMinimumColor() : string

Get the minimum value for the background color range

Returns

string

setCloudsMinimumColor()

setCloudsMinimumColor(float  $red, float  $green, float  $blue) : static

Set the minimum value for the background color range

Parameters

float $red

Red color value

float $green

Green color value

float $blue

Blue color value

Returns

static

getCloudsMaximumColor()

getCloudsMaximumColor() : string

Get the maximum value for the background color range

Returns

string

setCloudsMaximumColor()

setCloudsMaximumColor(float  $red, float  $green, float  $blue) : static

Set the maximum value for the background color range

Parameters

float $red

Red color value

float $green

Green color value

float $blue

Blue color value

Returns

static

getLight0Color()

getLight0Color() : string

Get the RGB color of light source 0

Returns

string

setLight0Color()

setLight0Color(float  $red, float  $green, float  $blue) : static

Set the RGB color of light source 0

Parameters

float $red

Red color value

float $green

Green color value

float $blue

Blue color value

Returns

static

getLight0Intensity()

getLight0Intensity() : float

Get the intensity of light source 0

Returns

float

setLight0Intensity()

setLight0Intensity(float  $intensity) : static

Set the intensity of light source 0

Parameters

float $intensity

Light intensity

Returns

static

getLight0PhiAngle()

getLight0PhiAngle() : float

Get the phi angle of light source 0

Returns

float

setLight0PhiAngle()

setLight0PhiAngle(float  $phiAngle) : static

Set the phi angle of light source 0

Parameters

float $phiAngle

Phi angle

Returns

static

getLight0ThetaAngle()

getLight0ThetaAngle() : float

Get the theta angle of light source 0

Returns

float

setLight0ThetaAngle()

setLight0ThetaAngle(float  $thetaAngle) : static

Set the theta angle of light source 0

Parameters

float $thetaAngle

Theta angle

Returns

static

getLightBallColor()

getLightBallColor() : string

Get the light ball color

Returns

string

setLightBallColor()

setLightBallColor(float  $red, float  $green, float  $blue) : static

Set the light ball color

Parameters

float $red

Red color value

float $green

Green color value

float $blue

Blue color value

Returns

static

getLightBallIntensity()

getLightBallIntensity() : float

Get the light ball intensity

Returns

float

setLightBallIntensity()

setLightBallIntensity(float  $intensity) : static

Set the light ball intensity

Parameters

float $intensity

Light ball intensity

Returns

static

getLightBallRadius()

getLightBallRadius() : float

Get the light ball radius

Returns

float

setLightBallRadius()

setLightBallRadius(float  $radius) : static

Set the light ball radius

Parameters

float $radius

Light ball radius

Returns

static

getFogColor()

getFogColor() : string

Get the fog color

Returns

string

setFogColor()

setFogColor(float  $red, float  $green, float  $blue) : static

Set the fog color

Parameters

float $red

Red color value

float $green

Green color value

float $blue

Blue color value

Returns

static

getSelfIlluminationColor()

getSelfIlluminationColor() : string

Get the self illumination color

Returns

string

setSelfIlluminationColor()

setSelfIlluminationColor(float  $red, float  $green, float  $blue) : static

Set the self illumination color

Parameters

float $red

Red color value

float $green

Green color value

float $blue

Blue color value

Returns

static

getSkyGradientScale()

getSkyGradientScale() : float

Get the sky gradient scale

Returns

float

setSkyGradientScale()

setSkyGradientScale(float  $skyGradientScale) : static

Set the sky gradient scale

Parameters

float $skyGradientScale

Sky gradient scale

Returns

static

getSkyGradientKeys()

getSkyGradientKeys() : array<mixed,\FML\Stylesheet\SkyGradientKey>

Get Sky Gradient Keys

Returns

array<mixed,\FML\Stylesheet\SkyGradientKey>

addSkyGradientKey()

addSkyGradientKey(\FML\Stylesheet\SkyGradientKey  $skyGradientKey) : static

Add a sky gradient key

Parameters

\FML\Stylesheet\SkyGradientKey $skyGradientKey

Sky Gradient Key

Returns

static

addSkyGradient()

addSkyGradient(float  $x, string  $color) : static

Add a sky gradient

Parameters

float $x

X value

string $color

Color value

Returns

static

removeAllSkyGradientKeys()

removeAllSkyGradientKeys() : static

Remove all Sky Gradient Keys

Returns

static

render()

render(\DOMDocument  $domDocument) : \DOMElement

Render the Mood

Parameters

\DOMDocument $domDocument

DOMDocument for which the Mood should be rendered

Returns

\DOMElement