[DOCS] Update VisibilityEnabler* and TileSet doc
(cherry picked from commit 49549ce93c
)
This commit is contained in:
parent
8970abd67f
commit
d9d1a91c5f
|
@ -67,7 +67,7 @@
|
||||||
<argument index="0" name="id" type="int">
|
<argument index="0" name="id" type="int">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
Creates a new tile which will be referenced by the given ID.
|
Creates a new tile with the given ID.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="find_tile_by_name" qualifiers="const">
|
<method name="find_tile_by_name" qualifiers="const">
|
||||||
|
@ -99,7 +99,7 @@
|
||||||
<argument index="0" name="id" type="int">
|
<argument index="0" name="id" type="int">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
Removes the tile referenced by the given ID.
|
Removes the given tile ID.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="tile_add_shape">
|
<method name="tile_add_shape">
|
||||||
|
@ -116,6 +116,7 @@
|
||||||
<argument index="4" name="autotile_coord" type="Vector2" default="Vector2( 0, 0 )">
|
<argument index="4" name="autotile_coord" type="Vector2" default="Vector2( 0, 0 )">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
|
Adds a shape to the tile.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="tile_get_light_occluder" qualifiers="const">
|
<method name="tile_get_light_occluder" qualifiers="const">
|
||||||
|
@ -124,7 +125,7 @@
|
||||||
<argument index="0" name="id" type="int">
|
<argument index="0" name="id" type="int">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
Returns the light occluder of the tile.
|
Returns the tile's light occluder.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="tile_get_material" qualifiers="const">
|
<method name="tile_get_material" qualifiers="const">
|
||||||
|
@ -133,7 +134,7 @@
|
||||||
<argument index="0" name="id" type="int">
|
<argument index="0" name="id" type="int">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
Returns the material of the tile.
|
Returns the tile's material.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="tile_get_name" qualifiers="const">
|
<method name="tile_get_name" qualifiers="const">
|
||||||
|
@ -142,7 +143,7 @@
|
||||||
<argument index="0" name="id" type="int">
|
<argument index="0" name="id" type="int">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
Returns the name of the tile.
|
Returns the tile's name.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="tile_get_navigation_polygon" qualifiers="const">
|
<method name="tile_get_navigation_polygon" qualifiers="const">
|
||||||
|
@ -169,6 +170,7 @@
|
||||||
<argument index="0" name="id" type="int">
|
<argument index="0" name="id" type="int">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
|
Returns the tile's normal map texture.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="tile_get_occluder_offset" qualifiers="const">
|
<method name="tile_get_occluder_offset" qualifiers="const">
|
||||||
|
@ -197,6 +199,7 @@
|
||||||
<argument index="1" name="shape_id" type="int">
|
<argument index="1" name="shape_id" type="int">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
|
Returns a tile's given shape.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="tile_get_shape_count" qualifiers="const">
|
<method name="tile_get_shape_count" qualifiers="const">
|
||||||
|
@ -205,6 +208,7 @@
|
||||||
<argument index="0" name="id" type="int">
|
<argument index="0" name="id" type="int">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
|
Returns the number of shapes assigned to a tile.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="tile_get_shape_one_way" qualifiers="const">
|
<method name="tile_get_shape_one_way" qualifiers="const">
|
||||||
|
@ -215,6 +219,7 @@
|
||||||
<argument index="1" name="shape_id" type="int">
|
<argument index="1" name="shape_id" type="int">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
|
Returns the one-way collision value of a tile's shape.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="tile_get_shape_transform" qualifiers="const">
|
<method name="tile_get_shape_transform" qualifiers="const">
|
||||||
|
@ -225,6 +230,7 @@
|
||||||
<argument index="1" name="shape_id" type="int">
|
<argument index="1" name="shape_id" type="int">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
|
Returns the [Transform2D] of a tile's sahpe.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="tile_get_shapes" qualifiers="const">
|
<method name="tile_get_shapes" qualifiers="const">
|
||||||
|
@ -233,7 +239,7 @@
|
||||||
<argument index="0" name="id" type="int">
|
<argument index="0" name="id" type="int">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
Returns the array of shapes of the tile.
|
Returns an array of the tile's shapes.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="tile_get_texture" qualifiers="const">
|
<method name="tile_get_texture" qualifiers="const">
|
||||||
|
@ -242,7 +248,7 @@
|
||||||
<argument index="0" name="id" type="int">
|
<argument index="0" name="id" type="int">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
Returns the texture of the tile.
|
Returns the tile's texture.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="tile_get_texture_offset" qualifiers="const">
|
<method name="tile_get_texture_offset" qualifiers="const">
|
||||||
|
@ -328,7 +334,7 @@
|
||||||
<argument index="1" name="occluder_offset" type="Vector2">
|
<argument index="1" name="occluder_offset" type="Vector2">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
Set an offset for the tile's light occluder.
|
Sets an offset for the tile's light occluder.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="tile_set_region">
|
<method name="tile_set_region">
|
||||||
|
@ -339,7 +345,7 @@
|
||||||
<argument index="1" name="region" type="Rect2">
|
<argument index="1" name="region" type="Rect2">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
Set the tile's sub-region in the texture. This is common in texture atlases.
|
Sets the tile's sub-region in the texture. This is common in texture atlases.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="tile_set_shape">
|
<method name="tile_set_shape">
|
||||||
|
@ -352,6 +358,7 @@
|
||||||
<argument index="2" name="shape" type="Shape2D">
|
<argument index="2" name="shape" type="Shape2D">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
|
Sets a shape for the tile, enabling collision.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="tile_set_shape_one_way">
|
<method name="tile_set_shape_one_way">
|
||||||
|
@ -364,6 +371,7 @@
|
||||||
<argument index="2" name="one_way" type="bool">
|
<argument index="2" name="one_way" type="bool">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
|
Enables one-way collision on a tile's shape.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="tile_set_shape_transform">
|
<method name="tile_set_shape_transform">
|
||||||
|
@ -376,6 +384,7 @@
|
||||||
<argument index="2" name="shape_transform" type="Transform2D">
|
<argument index="2" name="shape_transform" type="Transform2D">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
|
Sets a [Transform2D] on a tile's shape.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="tile_set_shapes">
|
<method name="tile_set_shapes">
|
||||||
|
|
|
@ -14,8 +14,10 @@
|
||||||
</methods>
|
</methods>
|
||||||
<members>
|
<members>
|
||||||
<member name="freeze_bodies" type="bool" setter="set_enabler" getter="is_enabler_enabled">
|
<member name="freeze_bodies" type="bool" setter="set_enabler" getter="is_enabler_enabled">
|
||||||
|
If [code]true[/code] [RigidBody] nodes will be paused.
|
||||||
</member>
|
</member>
|
||||||
<member name="pause_animations" type="bool" setter="set_enabler" getter="is_enabler_enabled">
|
<member name="pause_animations" type="bool" setter="set_enabler" getter="is_enabler_enabled">
|
||||||
|
If [code]true[/code] [AnimationPlayer] nodes will be paused.
|
||||||
</member>
|
</member>
|
||||||
</members>
|
</members>
|
||||||
<constants>
|
<constants>
|
||||||
|
|
|
@ -14,16 +14,22 @@
|
||||||
</methods>
|
</methods>
|
||||||
<members>
|
<members>
|
||||||
<member name="freeze_bodies" type="bool" setter="set_enabler" getter="is_enabler_enabled">
|
<member name="freeze_bodies" type="bool" setter="set_enabler" getter="is_enabler_enabled">
|
||||||
|
If [code]true[/code] [RigidBody2D] nodes will be paused.
|
||||||
</member>
|
</member>
|
||||||
<member name="pause_animated_sprites" type="bool" setter="set_enabler" getter="is_enabler_enabled">
|
<member name="pause_animated_sprites" type="bool" setter="set_enabler" getter="is_enabler_enabled">
|
||||||
|
If [code]true[/code] [AnimatedSprite] nodes will be paused.
|
||||||
</member>
|
</member>
|
||||||
<member name="pause_animations" type="bool" setter="set_enabler" getter="is_enabler_enabled">
|
<member name="pause_animations" type="bool" setter="set_enabler" getter="is_enabler_enabled">
|
||||||
|
If [code]true[/code] [AnimationPlayer] nodes will be paused.
|
||||||
</member>
|
</member>
|
||||||
<member name="pause_particles" type="bool" setter="set_enabler" getter="is_enabler_enabled">
|
<member name="pause_particles" type="bool" setter="set_enabler" getter="is_enabler_enabled">
|
||||||
|
If [code]true[/code] [Particles2D] nodes will be paused.
|
||||||
</member>
|
</member>
|
||||||
<member name="physics_process_parent" type="bool" setter="set_enabler" getter="is_enabler_enabled">
|
<member name="physics_process_parent" type="bool" setter="set_enabler" getter="is_enabler_enabled">
|
||||||
|
If [code]true[/code] the parent's [method Node._physics_process] will be stopped.
|
||||||
</member>
|
</member>
|
||||||
<member name="process_parent" type="bool" setter="set_enabler" getter="is_enabler_enabled">
|
<member name="process_parent" type="bool" setter="set_enabler" getter="is_enabler_enabled">
|
||||||
|
If [code]true[/code] the parent's [method Node._process] will be stopped.
|
||||||
</member>
|
</member>
|
||||||
</members>
|
</members>
|
||||||
<constants>
|
<constants>
|
||||||
|
|
Loading…
Reference in New Issue