Light2D Properties

The Light2D's Color.

The override to the default MultiplayerAPI. Set to null to use the default SceneTree one.

If true, Light2D will only appear when editing the scene.

If true, Light2D will emit light.

The Light2D's energy value. The larger the value, the stronger the light.

When a scene is instanced from a file, its topmost node contains the filename from which it was loaded.

Global position.

Global rotation in radians.

Global rotation in degrees.

Global scale.

Global Transform2D.

The rendering layers in which this CanvasItem responds to Light2D nodes.

The material applied to textures on this CanvasItem.

The Light2D's mode. See Light2DModeEnum constants for values.

The color applied to textures on this CanvasItem.

The MultiplayerAPI instance associated with this node. Either the CustomMultiplayer, or the default SceneTree one (if inside tree).

The name of the node. This name is unique among the siblings (other child nodes from the same parent). When set to an existing name, the node will be automatically renamed.

Note: Auto-generated names might include the @ character, which is reserved for unique names when using AddChild(Node, Boolean). When setting the name manually, any @ will be removed.

The offset of the Light2D's texture.

The node owner. A node can have any other node as owner (as long as it is a valid parent, grandparent, etc. ascending in the tree). When saving a node (using PackedScene), all the nodes it owns will be saved with it. This allows for the creation of complex SceneTrees, with instancing and subinstancing.

Pause mode. How the node will behave if the SceneTree is paused.

Position, relative to the node's parent.

The node's priority in the execution order of the enabled processing callbacks (i.e. , and their internal counterparts). Nodes whose process priority value is lower will have their processing callbacks executed first.

The height of the Light2D. Used with 2D normal mapping.

The layer mask. Only objects with a matching mask will be affected by the Light2D.

Maximum layer value of objects that are affected by the Light2D.

Minimum layer value of objects that are affected by the Light2D.

Maximum z value of objects that are affected by the Light2D.

Minimum z value of objects that are affected by the Light2D.

Rotation in radians, relative to the node's parent.

Rotation in degrees, relative to the node's parent.

The node's scale. Unscaled value: (1, 1).

The color applied to textures on this CanvasItem. This is not inherited by children CanvasItems.

Shadow buffer size.

Color of shadows cast by the Light2D.

If true, the Light2D will cast shadows.

Shadow filter type. See Light2DShadowFilterEnum for possible values.

Smoothing value for shadows.

Smooth shadow gradient length.

The shadow mask. Used with LightOccluder2D to cast shadows. Only occluders with a matching light mask will cast shadows.

If true, the object draws behind its parent.

If true, the object draws on top of its parent.

Texture used for the Light2D's appearance.

The texture's scale factor.

Local Transform2D.

If true, the parent CanvasItem's Material property is used as this one's material.

If true, this CanvasItem is drawn. The node is only visible if all of its antecedents are visible as well (in other words, IsVisibleInTree must return true).

Note: For controls that inherit Popup, the correct way to make them visible is to call one of the multiple popup*() functions instead.

If true, the node's Z index is relative to its parent's Z index. If this node's Z index is 2 and its parent's effective Z index is 3, then this node's effective Z index will be 2 + 3 = 5.

Z index. Controls the order in which the nodes render. A node with a higher Z index will display in front of others.