Area Properties

The rate at which objects stop spinning in this area. Represents the angular velocity lost per second.

See for more details about damping.

The name of the area's audio bus.

If true, the area's audio bus overrides the default audio bus.

The area's physics layer(s). Collidable objects can exist in any of 32 different layers. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layers that object A scans. See also CollisionMask. See Collision layers and masks in the documentation for more information.

The physics layers this area scans to determine collision detection. See Collision layers and masks in the documentation for more information.

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

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

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

World space (global) Transform of this node.

The area's gravity intensity (ranges from -1024 to 1024). This value multiplies the gravity vector. This is useful to alter the force of gravity without altering its direction.

The falloff factor for point gravity. The greater the value, the faster gravity decreases with distance.

If true, gravity is calculated from a point (set via GravityVec). See also SpaceOverride.

The area's gravity vector (not normalized). If gravity is a point (see GravityPoint), this will be the point of attraction.

If true, the CollisionObject will continue to receive input events as the mouse is dragged across its shapes.

If true, the CollisionObject's shapes will respond to RayCasts.

The rate at which objects stop moving in this area. Represents the linear velocity lost per second.

See for more details about damping.

If true, other monitoring areas can detect this area.

If true, the area detects bodies or areas entering and exiting it.

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 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.

The area's priority. Higher priority areas are processed first.

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 degree to which this area applies reverb to its associated audio. Ranges from 0 to 1 with 0.1 precision.

If true, the area applies reverb to its associated audio.

The reverb bus name to use for this area's associated audio.

The degree to which this area's reverb is a uniform effect. Ranges from 0 to 1 with 0.1 precision.

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.

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

Scale part of the local transformation.

Override mode for gravity and damping calculations within this area. See AreaSpaceOverrideEnum for possible values.

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

Local translation of this node.

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).