diff options
Diffstat (limited to 'doc/classes/Area2D.xml')
| -rw-r--r-- | doc/classes/Area2D.xml | 86 |
1 files changed, 30 insertions, 56 deletions
diff --git a/doc/classes/Area2D.xml b/doc/classes/Area2D.xml index f7a116b934..25f67f0571 100644 --- a/doc/classes/Area2D.xml +++ b/doc/classes/Area2D.xml @@ -14,38 +14,32 @@ </tutorials> <methods> <method name="get_overlapping_areas" qualifiers="const"> - <return type="Area2D[]"> - </return> + <return type="Area2D[]" /> <description> Returns a list of intersecting [Area2D]s. 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="Node2D[]"> - </return> + <return type="Node2D[]" /> <description> Returns a list of intersecting [PhysicsBody2D]s. 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"> - </return> - <argument index="0" name="area" type="Node"> - </argument> + <return type="bool" /> + <argument index="0" name="area" type="Node" /> <description> If [code]true[/code], the given area overlaps the Area2D. - [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. + [b]Note:[/b] The result of this test is not immediate after moving objects. For performance, the 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"> - </return> - <argument index="0" name="body" type="Node"> - </argument> + <return type="bool" /> + <argument index="0" name="body" type="Node" /> <description> If [code]true[/code], the given physics body overlaps the Area2D. [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 [PhysicsBody2D] or a [TileMap] instance (while TileMaps are not physics body themselves, they register their tiles with collision shapes as a virtual physics body). + The [code]body[/code] argument can either be a [PhysicsBody2D] or a [TileMap] instance (while TileMaps are not physics bodies themselves, they register their tiles with collision shapes as a virtual physics body). </description> </method> </methods> @@ -54,7 +48,7 @@ The rate at which objects stop spinning in this area. Represents the angular velocity lost per second. See [member ProjectSettings.physics/2d/default_angular_damp] for more details about damping. </member> - <member name="audio_bus_name" type="StringName" setter="set_audio_bus_name" getter="get_audio_bus_name" default="@"Master""> + <member name="audio_bus_name" type="StringName" setter="set_audio_bus_name" getter="get_audio_bus_name" default="&"Master""> 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"> @@ -69,7 +63,7 @@ <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="Vector2" setter="set_gravity_vector" getter="get_gravity_vector" default="Vector2( 0, 1 )"> + <member name="gravity_vec" type="Vector2" setter="set_gravity_vector" getter="get_gravity_vector" default="Vector2(0, 1)"> 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"> @@ -91,30 +85,24 @@ </members> <signals> <signal name="area_entered"> - <argument index="0" name="area" type="Area2D"> - </argument> + <argument index="0" name="area" type="Area2D" /> <description> Emitted when another Area2D enters this Area2D. Requires [member monitoring] to be set to [code]true[/code]. [code]area[/code] the other Area2D. </description> </signal> <signal name="area_exited"> - <argument index="0" name="area" type="Area2D"> - </argument> + <argument index="0" name="area" type="Area2D" /> <description> Emitted when another Area2D exits this Area2D. Requires [member monitoring] to be set to [code]true[/code]. [code]area[/code] the other Area2D. </description> </signal> <signal name="area_shape_entered"> - <argument index="0" name="area_rid" type="RID"> - </argument> - <argument index="1" name="area" type="Area2D"> - </argument> - <argument index="2" name="area_shape" type="int"> - </argument> - <argument index="3" name="local_shape" type="int"> - </argument> + <argument index="0" name="area_rid" type="RID" /> + <argument index="1" name="area" type="Area2D" /> + <argument index="2" name="area_shape" type="int" /> + <argument index="3" name="local_shape" type="int" /> <description> Emitted when one of another Area2D's [Shape2D]s enters one of this Area2D's [Shape2D]s. Requires [member monitoring] to be set to [code]true[/code]. [code]area_id[/code] the [RID] of the other Area2D's [CollisionObject2D] used by the [PhysicsServer2D]. @@ -124,14 +112,10 @@ </description> </signal> <signal name="area_shape_exited"> - <argument index="0" name="area_rid" type="RID"> - </argument> - <argument index="1" name="area" type="Area2D"> - </argument> - <argument index="2" name="area_shape" type="int"> - </argument> - <argument index="3" name="local_shape" type="int"> - </argument> + <argument index="0" name="area_rid" type="RID" /> + <argument index="1" name="area" type="Area2D" /> + <argument index="2" name="area_shape" type="int" /> + <argument index="3" name="local_shape" type="int" /> <description> Emitted when one of another Area2D's [Shape2D]s exits one of this Area2D's [Shape2D]s. Requires [member monitoring] to be set to [code]true[/code]. [code]area_id[/code] the [RID] of the other Area2D's [CollisionObject2D] used by the [PhysicsServer2D]. @@ -141,30 +125,24 @@ </description> </signal> <signal name="body_entered"> - <argument index="0" name="body" type="Node2D"> - </argument> + <argument index="0" name="body" type="Node2D" /> <description> Emitted when a [PhysicsBody2D] or [TileMap] enters this Area2D. Requires [member monitoring] to be set to [code]true[/code]. [TileMap]s are detected if the [TileSet] has Collision [Shape2D]s. [code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody2D] or [TileMap]. </description> </signal> <signal name="body_exited"> - <argument index="0" name="body" type="Node2D"> - </argument> + <argument index="0" name="body" type="Node2D" /> <description> Emitted when a [PhysicsBody2D] or [TileMap] exits this Area2D. Requires [member monitoring] to be set to [code]true[/code]. [TileMap]s are detected if the [TileSet] has Collision [Shape2D]s. [code]body[/code] the [Node], if it exists in the tree, of the other [PhysicsBody2D] or [TileMap]. </description> </signal> <signal name="body_shape_entered"> - <argument index="0" name="body_rid" type="RID"> - </argument> - <argument index="1" name="body" type="Node2D"> - </argument> - <argument index="2" name="body_shape" type="int"> - </argument> - <argument index="3" name="local_shape" type="int"> - </argument> + <argument index="0" name="body_rid" type="RID" /> + <argument index="1" name="body" type="Node2D" /> + <argument index="2" name="body_shape" type="int" /> + <argument index="3" name="local_shape" type="int" /> <description> Emitted when one of a [PhysicsBody2D] or [TileMap]'s [Shape2D]s enters one of this Area2D's [Shape2D]s. Requires [member monitoring] to be set to [code]true[/code]. [TileMap]s are detected if the [TileSet] has Collision [Shape2D]s. [code]body_id[/code] the [RID] of the [PhysicsBody2D] or [TileSet]'s [CollisionObject2D] used by the [PhysicsServer2D]. @@ -174,14 +152,10 @@ </description> </signal> <signal name="body_shape_exited"> - <argument index="0" name="body_rid" type="RID"> - </argument> - <argument index="1" name="body" type="Node2D"> - </argument> - <argument index="2" name="body_shape" type="int"> - </argument> - <argument index="3" name="local_shape" type="int"> - </argument> + <argument index="0" name="body_rid" type="RID" /> + <argument index="1" name="body" type="Node2D" /> + <argument index="2" name="body_shape" type="int" /> + <argument index="3" name="local_shape" type="int" /> <description> Emitted when one of a [PhysicsBody2D] or [TileMap]'s [Shape2D]s exits one of this Area2D's [Shape2D]s. Requires [member monitoring] to be set to [code]true[/code]. [TileMap]s are detected if the [TileSet] has Collision [Shape2D]s. [code]body_id[/code] the [RID] of the [PhysicsBody2D] or [TileSet]'s [CollisionObject2D] used by the [PhysicsServer2D]. |