: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` Represents a glTF light. .. rst-class:: classref-introduction-group Description ----------- Represents a light as defined by the ``KHR_lights_punctual`` glTF extension. .. rst-class:: classref-introduction-group Tutorials --------- - :doc:`Runtime file loading and saving <../tutorials/io/runtime_file_loading_and_saving>` - `KHR_lights_punctual glTF extension spec `__ .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-----------------------------+--------------------------------------------------------------------+-----------------------+ | :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`` | +-----------------------------+--------------------------------------------------------------------+-----------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`GLTFLight` | :ref:`from_dictionary`\ (\ dictionary\: :ref:`Dictionary`\ ) |static| | +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`GLTFLight` | :ref:`from_node`\ (\ light_node\: :ref:`Light3D`\ ) |static| | +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`get_additional_data`\ (\ extension_name\: :ref:`StringName`\ ) | +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_additional_data`\ (\ extension_name\: :ref:`StringName`, additional_data\: :ref:`Variant`\ ) | +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`to_dictionary`\ (\ ) |const| | +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Light3D` | :ref:`to_node`\ (\ ) |const| | +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_GLTFLight_property_color: .. rst-class:: classref-property :ref:`Color` **color** = ``Color(1, 1, 1, 1)`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_color**\ (\ value\: :ref:`Color`\ ) - :ref:`Color` **get_color**\ (\ ) The :ref:`Color` of the light. Defaults to white. A black color causes the light to have no effect. .. rst-class:: classref-item-separator ---- .. _class_GLTFLight_property_inner_cone_angle: .. rst-class:: classref-property :ref:`float` **inner_cone_angle** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_inner_cone_angle**\ (\ value\: :ref:`float`\ ) - :ref:`float` **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. .. rst-class:: classref-item-separator ---- .. _class_GLTFLight_property_intensity: .. rst-class:: classref-property :ref:`float` **intensity** = ``1.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_intensity**\ (\ value\: :ref:`float`\ ) - :ref:`float` **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. .. rst-class:: classref-item-separator ---- .. _class_GLTFLight_property_light_type: .. rst-class:: classref-property :ref:`String` **light_type** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_light_type**\ (\ value\: :ref:`String`\ ) - :ref:`String` **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. .. rst-class:: classref-item-separator ---- .. _class_GLTFLight_property_outer_cone_angle: .. rst-class:: classref-property :ref:`float` **outer_cone_angle** = ``0.785398`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_outer_cone_angle**\ (\ value\: :ref:`float`\ ) - :ref:`float` **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. .. rst-class:: classref-item-separator ---- .. _class_GLTFLight_property_range: .. rst-class:: classref-property :ref:`float` **range** = ``inf`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_range**\ (\ value\: :ref:`float`\ ) - :ref:`float` **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. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_GLTFLight_method_from_dictionary: .. rst-class:: classref-method :ref:`GLTFLight` **from_dictionary**\ (\ dictionary\: :ref:`Dictionary`\ ) |static| :ref:`🔗` Creates a new GLTFLight instance by parsing the given :ref:`Dictionary`. .. rst-class:: classref-item-separator ---- .. _class_GLTFLight_method_from_node: .. rst-class:: classref-method :ref:`GLTFLight` **from_node**\ (\ light_node\: :ref:`Light3D`\ ) |static| :ref:`🔗` Create a new GLTFLight instance from the given Godot :ref:`Light3D` node. .. rst-class:: classref-item-separator ---- .. _class_GLTFLight_method_get_additional_data: .. rst-class:: classref-method :ref:`Variant` **get_additional_data**\ (\ extension_name\: :ref:`StringName`\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GLTFLight_method_set_additional_data: .. rst-class:: classref-method |void| **set_additional_data**\ (\ extension_name\: :ref:`StringName`, additional_data\: :ref:`Variant`\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GLTFLight_method_to_dictionary: .. rst-class:: classref-method :ref:`Dictionary` **to_dictionary**\ (\ ) |const| :ref:`🔗` Serializes this GLTFLight instance into a :ref:`Dictionary`. .. rst-class:: classref-item-separator ---- .. _class_GLTFLight_method_to_node: .. rst-class:: classref-method :ref:`Light3D` **to_node**\ (\ ) |const| :ref:`🔗` Converts this GLTFLight instance into a Godot :ref:`Light3D` node. .. |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.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`