summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat
-rw-r--r--doc/classes/TileSet.xml32
-rw-r--r--doc/classes/VisibilityEnabler.xml2
-rw-r--r--doc/classes/VisibilityEnabler2D.xml6
3 files changed, 31 insertions, 9 deletions
diff --git a/doc/classes/TileSet.xml b/doc/classes/TileSet.xml
index b98161e483..3f0d6317a6 100644
--- a/doc/classes/TileSet.xml
+++ b/doc/classes/TileSet.xml
@@ -85,7 +85,7 @@
<argument index="0" name="id" type="int">
</argument>
<description>
- Creates a new tile which will be referenced by the given ID.
+ Creates a new tile with the given ID.
</description>
</method>
<method name="find_tile_by_name" qualifiers="const">
@@ -117,7 +117,7 @@
<argument index="0" name="id" type="int">
</argument>
<description>
- Removes the tile referenced by the given ID.
+ Removes the given tile ID.
</description>
</method>
<method name="tile_add_shape">
@@ -134,6 +134,7 @@
<argument index="4" name="autotile_coord" type="Vector2" default="Vector2( 0, 0 )">
</argument>
<description>
+ Adds a shape to the tile.
</description>
</method>
<method name="tile_get_light_occluder" qualifiers="const">
@@ -142,7 +143,7 @@
<argument index="0" name="id" type="int">
</argument>
<description>
- Returns the light occluder of the tile.
+ Returns the tile's light occluder.
</description>
</method>
<method name="tile_get_material" qualifiers="const">
@@ -151,7 +152,7 @@
<argument index="0" name="id" type="int">
</argument>
<description>
- Returns the material of the tile.
+ Returns the tile's material.
</description>
</method>
<method name="tile_get_modulate" qualifiers="const">
@@ -160,6 +161,7 @@
<argument index="0" name="id" type="int">
</argument>
<description>
+ Returns the tile's modulation color.
</description>
</method>
<method name="tile_get_name" qualifiers="const">
@@ -168,7 +170,7 @@
<argument index="0" name="id" type="int">
</argument>
<description>
- Returns the name of the tile.
+ Returns the tile's name.
</description>
</method>
<method name="tile_get_navigation_polygon" qualifiers="const">
@@ -195,6 +197,7 @@
<argument index="0" name="id" type="int">
</argument>
<description>
+ Returns the tile's normal map texture.
</description>
</method>
<method name="tile_get_occluder_offset" qualifiers="const">
@@ -223,6 +226,7 @@
<argument index="1" name="shape_id" type="int">
</argument>
<description>
+ Returns a tile's given shape.
</description>
</method>
<method name="tile_get_shape_count" qualifiers="const">
@@ -231,6 +235,7 @@
<argument index="0" name="id" type="int">
</argument>
<description>
+ Returns the number of shapes assigned to a tile.
</description>
</method>
<method name="tile_get_shape_offset" qualifiers="const">
@@ -241,6 +246,7 @@
<argument index="1" name="shape_id" type="int">
</argument>
<description>
+ Returns the offset of a tile's shape.
</description>
</method>
<method name="tile_get_shape_one_way" qualifiers="const">
@@ -251,6 +257,7 @@
<argument index="1" name="shape_id" type="int">
</argument>
<description>
+ Returns the one-way collision value of a tile's shape.
</description>
</method>
<method name="tile_get_shape_transform" qualifiers="const">
@@ -261,6 +268,7 @@
<argument index="1" name="shape_id" type="int">
</argument>
<description>
+ Returns the [Transform2D] of a tile's sahpe.
</description>
</method>
<method name="tile_get_shapes" qualifiers="const">
@@ -269,7 +277,7 @@
<argument index="0" name="id" type="int">
</argument>
<description>
- Returns the array of shapes of the tile.
+ Returns an array of the tile's shapes.
</description>
</method>
<method name="tile_get_texture" qualifiers="const">
@@ -278,7 +286,7 @@
<argument index="0" name="id" type="int">
</argument>
<description>
- Returns the texture of the tile.
+ Returns the tile's texture.
</description>
</method>
<method name="tile_get_texture_offset" qualifiers="const">
@@ -296,6 +304,7 @@
<argument index="0" name="id" type="int">
</argument>
<description>
+ Returns the tile's [enum TileMode].
</description>
</method>
<method name="tile_get_z_index" qualifiers="const">
@@ -304,6 +313,7 @@
<argument index="0" name="id" type="int">
</argument>
<description>
+ Returns the tile's z-index (drawing layer).
</description>
</method>
<method name="tile_set_light_occluder">
@@ -391,7 +401,7 @@
<argument index="1" name="occluder_offset" type="Vector2">
</argument>
<description>
- Set an offset for the tile's light occluder.
+ Sets an offset for the tile's light occluder.
</description>
</method>
<method name="tile_set_region">
@@ -402,7 +412,7 @@
<argument index="1" name="region" type="Rect2">
</argument>
<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>
</method>
<method name="tile_set_shape">
@@ -415,6 +425,7 @@
<argument index="2" name="shape" type="Shape2D">
</argument>
<description>
+ Sets a shape for the tile, enabling collision.
</description>
</method>
<method name="tile_set_shape_offset">
@@ -427,6 +438,7 @@
<argument index="2" name="shape_offset" type="Vector2">
</argument>
<description>
+ Sets the offset of a tile's shape.
</description>
</method>
<method name="tile_set_shape_one_way">
@@ -439,6 +451,7 @@
<argument index="2" name="one_way" type="bool">
</argument>
<description>
+ Enables one-way collision on a tile's shape.
</description>
</method>
<method name="tile_set_shape_transform">
@@ -451,6 +464,7 @@
<argument index="2" name="shape_transform" type="Transform2D">
</argument>
<description>
+ Sets a [Transform2D] on a tile's shape.
</description>
</method>
<method name="tile_set_shapes">
diff --git a/doc/classes/VisibilityEnabler.xml b/doc/classes/VisibilityEnabler.xml
index 83ba9495e5..5f0a4ef0f4 100644
--- a/doc/classes/VisibilityEnabler.xml
+++ b/doc/classes/VisibilityEnabler.xml
@@ -14,8 +14,10 @@
</methods>
<members>
<member name="freeze_bodies" type="bool" setter="set_enabler" getter="is_enabler_enabled">
+ If [code]true[/code] [RigidBody] nodes will be paused.
</member>
<member name="pause_animations" type="bool" setter="set_enabler" getter="is_enabler_enabled">
+ If [code]true[/code] [AnimationPlayer] nodes will be paused.
</member>
</members>
<constants>
diff --git a/doc/classes/VisibilityEnabler2D.xml b/doc/classes/VisibilityEnabler2D.xml
index 8dfbaec6e8..eab9bd1991 100644
--- a/doc/classes/VisibilityEnabler2D.xml
+++ b/doc/classes/VisibilityEnabler2D.xml
@@ -14,16 +14,22 @@
</methods>
<members>
<member name="freeze_bodies" type="bool" setter="set_enabler" getter="is_enabler_enabled">
+ If [code]true[/code] [RigidBody2D] nodes will be paused.
</member>
<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 name="pause_animations" type="bool" setter="set_enabler" getter="is_enabler_enabled">
+ If [code]true[/code] [AnimationPlayer] nodes will be paused.
</member>
<member name="pause_particles" type="bool" setter="set_enabler" getter="is_enabler_enabled">
+ If [code]true[/code] [Particles2D] nodes will be paused.
</member>
<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 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>
</members>
<constants>
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-23 12:20:31 +0000