Light

Provides a base class for different kinds of light nodes.

Light is the abstract base class for light nodes, so it shouldn't be used directly (It can't be instanced). Other types of light nodes inherit from it. Light contains the common variables and parameters used for lighting.

@GodotBaseClass

struct Light {

enum string _GODOT_internal_name;

union __anonymous;

alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses);

bool opEquals(Light other);

Light opAssign(T n);

bool opEquals(typeof(null) n);

mixin baseCasts ;

static Light _new();

enum Constants;

void setEditorOnly(bool editor_only);

bool isEditorOnly();

void setParam(long param, double value);

double getParam(long param);

void setShadow(bool enabled);

bool hasShadow();

void setNegative(bool enabled);

bool isNegative();

void setCullMask(long cull_mask);

long getCullMask();

void setColor(Color color);

Color getColor();

void setShadowReverseCullFace(bool enable);

bool getShadowReverseCullFace();

void setShadowColor(Color shadow_color);

Color getShadowColor();

void setBakeMode(long bake_mode);

Light.BakeMode getBakeMode();

Color lightColor [@property getter];

Color lightColor [@property setter];

double lightEnergy [@property getter];

double lightEnergy [@property setter];

double lightIndirectEnergy [@property getter];

double lightIndirectEnergy [@property setter];

bool lightNegative [@property getter];

bool lightNegative [@property setter];

double lightSpecular [@property getter];

double lightSpecular [@property setter];

Light.BakeMode lightBakeMode [@property getter];

long lightBakeMode [@property setter];

long lightCullMask [@property getter];

long lightCullMask [@property setter];

bool shadowEnabled [@property getter];

bool shadowEnabled [@property setter];

Color shadowColor [@property getter];

Color shadowColor [@property setter];

double shadowBias [@property getter];

double shadowBias [@property setter];

double shadowContact [@property getter];

double shadowContact [@property setter];

bool shadowReverseCullFace [@property getter];

bool shadowReverseCullFace [@property setter];

bool editorOnly [@property getter];

bool editorOnly [@property setter];

}

Members

Aliases

BaseClasses alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses): Undocumented in source.

Enums

BakeMode enum BakeMode
Constants enum Constants
Param enum Param

Functions

getBakeMode Light.BakeMode getBakeMode()
getColor Color getColor()
getCullMask long getCullMask()
getParam double getParam(long param)
getShadowColor Color getShadowColor()
getShadowReverseCullFace bool getShadowReverseCullFace()
hasShadow bool hasShadow()
isEditorOnly bool isEditorOnly()
isNegative bool isNegative()
opAssign Light opAssign(T n): Undocumented in source. Be warned that the author may not have intended to support it.
opEquals bool opEquals(Light other): Undocumented in source. Be warned that the author may not have intended to support it.
opEquals bool opEquals(typeof(null) n): Undocumented in source. Be warned that the author may not have intended to support it.
setBakeMode void setBakeMode(long bake_mode)
setColor void setColor(Color color)
setCullMask void setCullMask(long cull_mask)
setEditorOnly void setEditorOnly(bool editor_only)
setNegative void setNegative(bool enabled)
setParam void setParam(long param, double value)
setShadow void setShadow(bool enabled)
setShadowColor void setShadowColor(Color shadow_color)
setShadowReverseCullFace void setShadowReverseCullFace(bool enable)

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Properties

editorOnly bool editorOnly [@property setter]: If true the light only appears in the editor and will not be visible at runtime. Default value:false.
editorOnly bool editorOnly [@property getter]: If true the light only appears in the editor and will not be visible at runtime. Default value:false.
lightBakeMode Light.BakeMode lightBakeMode [@property getter]
long lightBakeMode [@property setter]: The light's bake mode. See bakemode.
lightColor Color lightColor [@property getter]
Color lightColor [@property setter]: The light's color.
lightCullMask long lightCullMask [@property getter]
long lightCullMask [@property setter]: The light will affect objects in the selected layers.
lightEnergy double lightEnergy [@property getter]
double lightEnergy [@property setter]: The light's strength multiplier.
lightIndirectEnergy double lightIndirectEnergy [@property getter]
double lightIndirectEnergy [@property setter]: Secondary multiplier used with indirect light (light bounces). This works in baked light or GIProbe.
lightNegative bool lightNegative [@property getter]
bool lightNegative [@property setter]: If true the light's effect is reversed, darkening areas and casting bright shadows. Default value: false.
lightSpecular double lightSpecular [@property getter]
double lightSpecular [@property setter]: The intensity of the specular blob in objects affected by the light. At 0 the light becomes a pure diffuse light.
shadowBias double shadowBias [@property getter]
double shadowBias [@property setter]: Used to adjust shadow appearance. Too small a value results in self shadowing, while too large a value causes shadows to separate from casters. Adjust as needed.
shadowColor Color shadowColor [@property getter]
Color shadowColor [@property setter]: The color of shadows cast by this light.
shadowContact double shadowContact [@property getter]
double shadowContact [@property setter]: Attempts to reduce shadowBias gap.
shadowEnabled bool shadowEnabled [@property getter]
bool shadowEnabled [@property setter]: If true the light will cast shadows. Default value: false.
shadowReverseCullFace bool shadowReverseCullFace [@property getter]
bool shadowReverseCullFace [@property setter]

Static functions

_new Light _new(): Undocumented in source. Be warned that the author may not have intended to support it.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

_classBinding struct _classBinding: Undocumented in source.

Unions

__anonymous union __anonymous: Undocumented in source.

Variables

_GODOT_internal_name enum string _GODOT_internal_name;: Undocumented in source.

Mixed In Members

From `mixin baseCasts`

as To as(): Undocumented in source. Be warned that the author may not have intended to support it.
as To as(): Undocumented in source. Be warned that the author may not have intended to support it.
as ToRef as(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast template opCast(To): Undocumented in source.
opCast template opCast(To): Undocumented in source.
opCast template opCast(ToRef): Undocumented in source.
opCast void* opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast godot_object opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast bool opCast(): Undocumented in source. Be warned that the author may not have intended to support it.

Meta

Source

See Implementation

godot light modules

all

structs

Light