HPL3/SOMA/Scripting/Scripting Api/Light

Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!

Summary

Return Type	Function and Description
void	Light_FadeTo(const tString &in asLightName, const cColor &in acColor, float afRadius, float afTime) Fades one or more lights to a specified color and radius
float	Light_GetBrightness(const tString &in asLightName) Gets the brightness of a light
void	Light_SetBrightness(const tString &in asLightName, float afBrightness) Sets the brightness of one or more lights
void	Light_SetCastShadows(const tString &in asLightName, bool abX) Sets the casts shadow
void	Light_SetCheapGobo(const tString &in asLightName, bool abX) Sets if a cheaper version of gobo rendering should be used
void	Light_SetFlickerActive(const tString &in asLightName, bool abX) Activates or deactivates the flicker of one or more lights
void	Light_SetShadowBiasMul(const tString &in asLightName, float afBias, float afSlopeBias) Sets the shadow bias for one or more lights
void	Light_SetVisible(const tString &in asLightName, bool abVisible) Sets the visibility of one or more lights

Function Detail

Light_FadeTo

void Light_FadeTo(const tString &in asLightName,
                  const cColor &in acColor,
                  float afRadius,
                  float afTime)

Fades one or more lights to a specified color and radius.

Parameters

• asLightName (tString) — name of light. Can contain wildcards.
• acColor (cColor) — color to fade to.
• afRadius (float) — radius to fade to, if lower than 0, the current radius will be used.
• afTime (float) — time to fade over.

Returns:

• void

Light_GetBrightness

float Light_GetBrightness(const tString &in asLightName)

Gets the brightness of a light

Parameters

• asLightName (tString) — name of light.

Returns:

• float—the brightness of the light

Light_SetBrightness

void Light_SetBrightness(const tString &in asLightName,
                         float afBrightness)

Sets the brightness of one or more lights

Parameters

• asLightName (tString) — name of light. Can contain wildcards.
• afBrightness (float) — the brightness to set.

Returns:

• void

Light_SetCastShadows

void Light_SetCastShadows(const tString &in asLightName,
                          bool abX)

Sets the casts shadow. Used only by spotlights (for now).

Parameters

• asLightName (tString) — name of the light. Can contain wildcards.
• abX (bool) — if light should cast shadows.

Returns:

• void

Light_SetCheapGobo

void Light_SetCheapGobo(const tString &in asLightName,
                        bool abX)

Sets if a cheaper version of gobo rendering should be used

Parameters

• asLightName (tString) — name of light. Can contain wildcards.
• abX (bool) — if cheap version should be used, off by default

Returns:

• void

Light_SetFlickerActive

void Light_SetFlickerActive(const tString &in asLightName,
                            bool abX)

Activates or deactivates the flicker of one or more lights

Parameters

• asLightName (tString) — name of light. Can contain wildcards.
• abX (bool) — if flicker should be active.

Returns:

• void

Light_SetShadowBiasMul

void Light_SetShadowBiasMul(const tString &in asLightName,
                            float afBias,
                            float afSlopeBias)

Sets the shadow bias for one or more lights

Parameters

• asLightName (tString) — name of light. Can contain wildcards.
• afBias (float) — bias mul
• afSlopeBias (float) — slope bias mul

Returns:

• void

Light_SetVisible

void Light_SetVisible(const tString &in asLightName,
                      bool abVisible)

Sets the visibility of one or more lights

Parameters

• asLightName (tString) — name of light. Can contain wildcards.
• abVisible (bool) — if light should be visible.

Returns:

• void