maxmustermann/godot
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

[DOCS] Update VisibilityEnabler* and TileSet doc

Browse source 
(cherry picked from commit 49549ce93c)
This commit is contained in:
Chris Bradfield 2018-10-01 15:20:18 -07:00 committed by Rémi Verschelde
parent 8970abd67f
commit d9d1a91c5f
3 changed files with 26 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
doc/classes/TileSet.xml
View file

@ -67,7 +67,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">
@ -99,7 +99,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">
@ -116,6 +116,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">
@ -124,7 +125,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">
@ -133,7 +134,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_name" qualifiers="const">
@ -142,7 +143,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">
@ -169,6 +170,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">
@ -197,6 +199,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">
@ -205,6 +208,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_one_way" qualifiers="const">
@ -215,6 +219,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">
@ -225,6 +230,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">
@ -233,7 +239,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">
@ -242,7 +248,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">
@ -328,7 +334,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">
@ -339,7 +345,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">
@ -352,6 +358,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_one_way">
@ -364,6 +371,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">
@ -376,6 +384,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">

2
doc/classes/VisibilityEnabler.xml
View file

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

6
doc/classes/VisibilityEnabler2D.xml
View file

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