godot/doc/classes/Area.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="Area" inherits="CollisionObject" version="3.6" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		3D area for detection and physics and audio influence.
	</brief_description>
	<description>
		3D area that detects [CollisionObject] nodes overlapping, entering, or exiting. Can also alter or override local physics parameters (gravity, damping) and route audio to a custom audio bus.
		To give the area its shape, add a [CollisionShape] or a [CollisionPolygon] node as a [i]direct[/i] child (or add multiple such nodes as direct children) of the area.
		[b]Warning:[/b] See [ConcavePolygonShape] (also called "trimesh") for a warning about possibly unexpected behavior when using that shape for an area.
		[b]Warning:[/b] With a non-uniform scale this node will probably not function as expected. Please make sure to keep its scale uniform (i.e. the same on all axes), and change the size(s) of its collision shape(s) instead.
	</description>
	<tutorials>
		<link title="3D Platformer Demo">https://godotengine.org/asset-library/asset/125</link>
		<link title="GUI in 3D Demo">https://godotengine.org/asset-library/asset/127</link>
	</tutorials>
	<methods>
		<method name="get_overlapping_areas" qualifiers="const">
			<return type="Array" />
			<description>
				Returns a list of intersecting [Area]s. The overlapping area's [member CollisionObject.collision_layer] must be part of this area's [member CollisionObject.collision_mask] in order to be detected.
				For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead.
			</description>
		</method>
		<method name="get_overlapping_bodies" qualifiers="const">
			<return type="Array" />
			<description>
				Returns a list of intersecting [PhysicsBody]s. The overlapping body's [member CollisionObject.collision_layer] must be part of this area's [member CollisionObject.collision_mask] in order to be detected.
				For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead.
			</description>
		</method>
		<method name="overlaps_area" qualifiers="const">
			<return type="bool" />
			<argument index="0" name="area" type="Node" />
			<description>
				If [code]true[/code], the given area overlaps the Area.
				[b]Note:[/b] The result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead.
			</description>
		</method>
		<method name="overlaps_body" qualifiers="const">
			<return type="bool" />
			<argument index="0" name="body" type="Node" />
			<description>
				If [code]true[/code], the given physics body overlaps the Area.
				[b]Note:[/b] The result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead.
				The [code]body[/code] argument can either be a [PhysicsBody] or a [GridMap] instance (while GridMaps are not physics body themselves, they register their tiles with collision shapes as a virtual physics body).
			</description>
		</method>
	</methods>
	<members>
		<member name="angular_damp" type="float" setter="set_angular_damp" getter="get_angular_damp" default="0.1">
			The rate at which objects stop spinning in this area. Represents the angular velocity lost per second.
			See [member ProjectSettings.physics/3d/default_angular_damp] for more details about damping.
		</member>
		<member name="audio_bus_name" type="String" setter="set_audio_bus" getter="get_audio_bus" default="&quot;Master&quot;">
			The name of the area's audio bus.
		</member>
		<member name="audio_bus_override" type="bool" setter="set_audio_bus_override" getter="is_overriding_audio_bus" default="false">
			If [code]true[/code], the area's audio bus overrides the default audio bus.
		</member>
		<member name="gravity" type="float" setter="set_gravity" getter="get_gravity" default="9.8">
			The area's gravity intensity (in meters per second squared). This value multiplies the gravity vector. This is useful to alter the force of gravity without altering its direction.
		</member>
		<member name="gravity_distance_scale" type="float" setter="set_gravity_distance_scale" getter="get_gravity_distance_scale" default="0.0">
			The falloff factor for point gravity. The greater the value, the faster gravity decreases with distance.
		</member>
		<member name="gravity_point" type="bool" setter="set_gravity_is_point" getter="is_gravity_a_point" default="false">
			If [code]true[/code], gravity is calculated from a point (set via [member gravity_vec]). See also [member space_override].
		</member>
		<member name="gravity_vec" type="Vector3" setter="set_gravity_vector" getter="get_gravity_vector" default="Vector3( 0, -1, 0 )">
			The area's gravity vector (not normalized). If gravity is a point (see [member gravity_point]), this will be the point of attraction.
		</member>
		<member name="linear_damp" type="float" setter="set_linear_damp" getter="get_linear_damp" default="0.1">
			The rate at which objects stop moving in this area. Represents the linear velocity lost per second.
			See [member ProjectSettings.physics/3d/default_linear_damp] for more details about damping.
		</member>
		<member name="monitorable" type="bool" setter="set_monitorable" getter="is_monitorable" default="true">
			If [code]true[/code], other monitoring areas can detect this area.
		</member>
		<member name="monitoring" type="bool" setter="set_monitoring" getter="is_monitoring" default="true">
			If [code]true[/code], the area detects bodies or areas entering and exiting it.
		</member>
		<member name="priority" type="float" setter="set_priority" getter="get_priority" default="0.0">
			The area's priority. Higher priority areas are processed first.
		</member>
		<member name="reverb_bus_amount" type="float" setter="set_reverb_amount" getter="get_reverb_amount" default="0.0">
			The degree to which this area applies reverb to its associated audio. Ranges from [code]0[/code] to [code]1[/code] with [code]0.1[/code] precision.
		</member>
		<member name="reverb_bus_enable" type="bool" setter="set_use_reverb_bus" getter="is_using_reverb_bus" default="false">
			If [code]true[/code], the area applies reverb to its associated audio.
		</member>
		<member name="reverb_bus_name" type="String" setter="set_reverb_bus" getter="get_reverb_bus" default="&quot;Master&quot;">
			The reverb bus name to use for this area's associated audio.
		</member>
		<member name="reverb_bus_uniformity" type="float" setter="set_reverb_uniformity" getter="get_reverb_uniformity" default="0.0">
			The degree to which this area's reverb is a uniform effect. Ranges from [code]0[/code] to [code]1[/code] with [code]0.1[/code] precision.
		</member>
		<member name="space_override" type="int" setter="set_space_override_mode" getter="get_space_override_mode" enum="Area.SpaceOverride" default="0">
			Override mode for gravity and damping calculations within this area. See [enum SpaceOverride] for possible values.
		</member>
	</members>
	<signals>
		<signal name="area_entered">
			<argument index="0" name="area" type="Area" />
			<description>
				Emitted when another Area enters this Area. Requires [member monitoring] to be set to [code]true[/code].
				[code]area[/code] the other Area.
			</description>
		</signal>
		<signal name="area_exited">
			<argument index="0" name="area" type="Area" />
			<description>
				Emitted when another Area exits this Area. Requires [member monitoring] to be set to [code]true[/code].
				[code]area[/code] the other Area.
			</description>
		</signal>
		<signal name="area_shape_entered">
			<argument index="0" name="area_rid" type="RID" />
			<argument index="1" name="area" type="Area" />
			<argument index="2" name="area_shape_index" type="int" />
			<argument index="3" name="local_shape_index" type="int" />
			<description>
				Emitted when one of another Area's [Shape]s enters one of this Area's [Shape]s. Requires [member monitoring] to be set to [code]true[/code].
				[code]area_rid[/code] the [RID] of the other Area's [CollisionObject] used by the [PhysicsServer].
				[code]area[/code] the other Area.
				[code]area_shape_index[/code] the index of the [Shape] from the other Area.
				[code]local_shape_index[/code] the index of the [Shape] from this Area.
				[b]Example of getting the[/b] [CollisionShape] [b]node from the shape index:[/b]
				[codeblock]
				var other_shape_owner = area.shape_find_owner(area_shape_index)
				var other_shape_node = area.shape_owner_get_owner(other_shape_owner)

				var local_shape_owner = shape_find_owner(local_shape_index)
				var local_shape_node = shape_owner_get_owner(local_shape_owner)
				[/codeblock]
			</description>
		</signal>
		<signal name="area_shape_exited">
			<argument index="0" name="area_rid" type="RID" />
			<argument index="1" name="area" type="Area" />
			<argument index="2" name="area_shape_index" type="int" />
			<argument index="3" name="local_shape_index" type="int" />
			<description>
				Emitted when one of another Area's [Shape]s enters one of this Area's [Shape]s. Requires [member monitoring] to be set to [code]true[/code].
				[code]area_rid[/code] the [RID] of the other Area's [CollisionObject] used by the [PhysicsServer].
				[code]area[/code] the other Area.
				[code]area_shape_index[/code] the index of the [Shape] from the other Area.
				[code]local_shape_index[/code] the index of the [Shape] from this Area.
				See also [signal area_shape_entered].
			</description>
		</signal>
		<signal name="body_entered">
			<argument index="0" name="body" type="Node" />
			<description>
				Emitted when a [PhysicsBody] or [GridMap] enters this Area. Requires [member monitoring] to be set to [code]true[/code]. [GridMap]s are detected if the [MeshLibrary] has Collision [Shape]s.
				[code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody] or [GridMap].
			</description>
		</signal>
		<signal name="body_exited">
			<argument index="0" name="body" type="Node" />
			<description>
				Emitted when a [PhysicsBody] or [GridMap] exits this Area. Requires [member monitoring] to be set to [code]true[/code]. [GridMap]s are detected if the [MeshLibrary] has Collision [Shape]s.
				[code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody] or [GridMap].
			</description>
		</signal>
		<signal name="body_shape_entered">
			<argument index="0" name="body_rid" type="RID" />
			<argument index="1" name="body" type="Node" />
			<argument index="2" name="body_shape_index" type="int" />
			<argument index="3" name="local_shape_index" type="int" />
			<description>
				Emitted when one of a [PhysicsBody] or [GridMap]'s [Shape]s enters one of this Area's [Shape]s. Requires [member monitoring] to be set to [code]true[/code]. [GridMap]s are detected if the [MeshLibrary] has Collision [Shape]s.
				[code]body_rid[/code] the [RID] of the [PhysicsBody] or [MeshLibrary]'s [CollisionObject] used by the [PhysicsServer].
				[code]body[/code] the [Node], if it exists in the tree, of the [PhysicsBody] or [GridMap].
				[code]body_shape_index[/code] the index of the [Shape] from the [PhysicsBody] or [GridMap].
				[code]local_shape_index[/code] the index of the [Shape] from this Area.
				[b]Example of getting the[/b] [CollisionShape] [b]node from the shape index:[/b]
				[codeblock]
				var body_shape_owner = body.shape_find_owner(body_shape_index)
				var body_shape_node = body.shape_owner_get_owner(body_shape_owner)

				var local_shape_owner = shape_find_owner(local_shape_index)
				var local_shape_node = shape_owner_get_owner(local_shape_owner)
				[/codeblock]
			</description>
		</signal>
		<signal name="body_shape_exited">
			<argument index="0" name="body_rid" type="RID" />
			<argument index="1" name="body" type="Node" />
			<argument index="2" name="body_shape_index" type="int" />
			<argument index="3" name="local_shape_index" type="int" />
			<description>
				Emitted when one of a [PhysicsBody] or [GridMap]'s [Shape]s enters one of this Area's [Shape]s. Requires [member monitoring] to be set to [code]true[/code]. [GridMap]s are detected if the [MeshLibrary] has Collision [Shape]s.
				[code]body_rid[/code] the [RID] of the [PhysicsBody] or [MeshLibrary]'s [CollisionObject] used by the [PhysicsServer].
				[code]body[/code] the [Node], if it exists in the tree, of the [PhysicsBody] or [GridMap].
				[code]body_shape_index[/code] the index of the [Shape] from the [PhysicsBody] or [GridMap].
				[code]local_shape_index[/code] the index of the [Shape] from this Area.
				See also [signal body_shape_entered].
			</description>
		</signal>
	</signals>
	<constants>
		<constant name="SPACE_OVERRIDE_DISABLED" value="0" enum="SpaceOverride">
			This area does not affect gravity/damping.
		</constant>
		<constant name="SPACE_OVERRIDE_COMBINE" value="1" enum="SpaceOverride">
			This area adds its gravity/damping values to whatever has been calculated so far (in [member priority] order).
		</constant>
		<constant name="SPACE_OVERRIDE_COMBINE_REPLACE" value="2" enum="SpaceOverride">
			This area adds its gravity/damping values to whatever has been calculated so far (in [member priority] order), ignoring any lower priority areas.
		</constant>
		<constant name="SPACE_OVERRIDE_REPLACE" value="3" enum="SpaceOverride">
			This area replaces any gravity/damping, even the defaults, ignoring any lower priority areas.
		</constant>
		<constant name="SPACE_OVERRIDE_REPLACE_COMBINE" value="4" enum="SpaceOverride">
			This area replaces any gravity/damping calculated so far (in [member priority] order), but keeps calculating the rest of the areas.
		</constant>
	</constants>
</class>