:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/modules/gltf/doc_classes/GLTFLight.xml. .. _class_GLTFLight: GLTFLight ========= **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` Properties ---------- +-----------------------------+--------------------------------------------------------------------+-----------------------+ | :ref:`Color` | :ref:`color` | ``Color(1, 1, 1, 1)`` | +-----------------------------+--------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`inner_cone_angle` | ``0.0`` | +-----------------------------+--------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`intensity` | ``1.0`` | +-----------------------------+--------------------------------------------------------------------+-----------------------+ | :ref:`String` | :ref:`light_type` | ``""`` | +-----------------------------+--------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`outer_cone_angle` | ``0.785398`` | +-----------------------------+--------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`range` | ``inf`` | +-----------------------------+--------------------------------------------------------------------+-----------------------+ Property Descriptions --------------------- .. _class_GLTFLight_property_color: - :ref:`Color` **color** +-----------+-----------------------+ | *Default* | ``Color(1, 1, 1, 1)`` | +-----------+-----------------------+ | *Setter* | set_color(value) | +-----------+-----------------------+ | *Getter* | get_color() | +-----------+-----------------------+ The :ref:`Color` of the light. Defaults to white. A black color causes the light to have no effect. ---- .. _class_GLTFLight_property_inner_cone_angle: - :ref:`float` **inner_cone_angle** +-----------+-----------------------------+ | *Default* | ``0.0`` | +-----------+-----------------------------+ | *Setter* | set_inner_cone_angle(value) | +-----------+-----------------------------+ | *Getter* | get_inner_cone_angle() | +-----------+-----------------------------+ The inner angle of the cone in a spotlight. Must be less than or equal to the outer cone angle. Within this angle, the light is at full brightness. Between the inner and outer cone angles, there is a transition from full brightness to zero brightness. When creating a Godot :ref:`SpotLight3D`, the ratio between the inner and outer cone angles is used to calculate the attenuation of the light. ---- .. _class_GLTFLight_property_intensity: - :ref:`float` **intensity** +-----------+----------------------+ | *Default* | ``1.0`` | +-----------+----------------------+ | *Setter* | set_intensity(value) | +-----------+----------------------+ | *Getter* | get_intensity() | +-----------+----------------------+ The intensity of the light. This is expressed in candelas (lumens per steradian) for point and spot lights, and lux (lumens per m²) for directional lights. When creating a Godot light, this value is converted to a unitless multiplier. ---- .. _class_GLTFLight_property_light_type: - :ref:`String` **light_type** +-----------+-----------------------+ | *Default* | ``""`` | +-----------+-----------------------+ | *Setter* | set_light_type(value) | +-----------+-----------------------+ | *Getter* | get_light_type() | +-----------+-----------------------+ The type of the light. The values accepted by Godot are "point", "spot", and "directional", which correspond to Godot's :ref:`OmniLight3D`, :ref:`SpotLight3D`, and :ref:`DirectionalLight3D` respectively. ---- .. _class_GLTFLight_property_outer_cone_angle: - :ref:`float` **outer_cone_angle** +-----------+-----------------------------+ | *Default* | ``0.785398`` | +-----------+-----------------------------+ | *Setter* | set_outer_cone_angle(value) | +-----------+-----------------------------+ | *Getter* | get_outer_cone_angle() | +-----------+-----------------------------+ The outer angle of the cone in a spotlight. Must be greater than or equal to the inner angle. At this angle, the light drops off to zero brightness. Between the inner and outer cone angles, there is a transition from full brightness to zero brightness. If this angle is a half turn, then the spotlight emits in all directions. When creating a Godot :ref:`SpotLight3D`, the outer cone angle is used as the angle of the spotlight. ---- .. _class_GLTFLight_property_range: - :ref:`float` **range** +-----------+------------------+ | *Default* | ``inf`` | +-----------+------------------+ | *Setter* | set_range(value) | +-----------+------------------+ | *Getter* | get_range() | +-----------+------------------+ The range of the light, beyond which the light has no effect. GLTF lights with no range defined behave like physical lights (which have infinite range). When creating a Godot light, the range is clamped to 4096. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`