Click or drag to resize

ReflectionProbe Properties

The ReflectionProbe type exposes the following members.

Properties
  NameDescription
Public property_ImportPath (Inherited from Node.)
Public propertyBoxProjection

If true, enables box projection. This makes reflections look more correct in rectangle-shaped rooms by offsetting the reflection center depending on the camera's location.

Public propertyCullMask

Sets the cull mask which determines what objects are drawn by this probe. Every VisualInstance with a layer included in this cull mask will be rendered by the probe. It is best to only include large objects which are likely to take up a lot of space in the reflection in order to save on rendering cost.

Public propertyCustomMultiplayer

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

(Inherited from Node.)
Public propertyDynamicObject
Gets a new DynamicGodotObject associated with this instance.
(Inherited from Object.)
Public propertyEditorDescription (Inherited from Node.)
Public propertyEnableShadows

If true, computes shadows in the reflection probe. This makes the reflection probe slower to render; you may want to disable this if using the UpdateMode.

Public propertyExtents

The size of the reflection probe. The larger the extents the more space covered by the probe which will lower the perceived resolution. It is best to keep the extents only as large as you need them.

Public propertyFilename

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

(Inherited from Node.)
Public propertyGizmo

The SpatialGizmo for this node. Used for example in [!:Godot.EditorSpatialGizmo] as custom visualization and editing handles in Editor.

(Inherited from Spatial.)
Public propertyGlobalTransform

World space (global) Transform of this node.

(Inherited from Spatial.)
Public propertyIntensity

Defines the reflection intensity. Intensity modulates the strength of the reflection.

Public propertyInteriorAmbientColor

Sets the ambient light color to be used when this probe is set to InteriorEnable.

Public propertyInteriorAmbientContrib

Sets the contribution value for how much the reflection affects the ambient light for this reflection probe when set to InteriorEnable. Useful so that ambient light matches the color of the room.

Public propertyInteriorAmbientEnergy

Sets the energy multiplier for this reflection probe's ambient light contribution when set to InteriorEnable.

Public propertyInteriorEnable

If true, reflections will ignore sky contribution. Ambient lighting is then controlled by the interior_ambient_* properties.

Public propertyLayers

The render layer(s) this VisualInstance is drawn on.

This object will only be visible for Cameras whose cull mask includes the render object this VisualInstance is set to.

(Inherited from VisualInstance.)
Public propertyMaxDistance

Sets the max distance away from the probe an object can be before it is culled.

Public propertyMultiplayer

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

(Inherited from Node.)
Public propertyName

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.

(Inherited from Node.)
Public propertyNativeInstance (Inherited from Object.)
Public propertyOriginOffset

Sets the origin offset to be used when this reflection probe is in box project mode.

Public propertyOwner

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.

(Inherited from Node.)
Public propertyPauseMode

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

(Inherited from Node.)
Public propertyProcessPriority

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.

(Inherited from Node.)
Public propertyRotation

Rotation part of the local transformation in radians, specified in terms of YXZ-Euler angles in the format (X angle, Y angle, Z angle).

Note: In the mathematical sense, rotation is a matrix and not a vector. The three Euler angles, which are the three independent parameters of the Euler-angle parametrization of the rotation matrix, are stored in a Vector3 data structure not because the rotation is a vector, but only because Vector3 exists as a convenient data-structure to store 3 floating-point numbers. Therefore, applying affine operations on the rotation "vector" is not meaningful.

(Inherited from Spatial.)
Public propertyRotationDegrees

Rotation part of the local transformation in degrees, specified in terms of YXZ-Euler angles in the format (X angle, Y angle, Z angle).

(Inherited from Spatial.)
Public propertyScale

Scale part of the local transformation.

(Inherited from Spatial.)
Public propertyTransform

Local space Transform of this node, with respect to the parent node.

(Inherited from Spatial.)
Public propertyTranslation

Local translation of this node.

(Inherited from Spatial.)
Public propertyUpdateMode

Sets how frequently the probe is updated. Can be or .

Public propertyVisible

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

(Inherited from Spatial.)
Top
See Also