asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #22601 from cbscribe/kcc_class_docs

Browse source 
[DOCS] Update VisibilityEnabler* and TileSet doc
This commit is contained in:
Rémi Verschelde 2018-10-02 08:39:57 +02:00 committed by GitHub
commit dd1e8cd774
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 31 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
doc/classes/TileSet.xml
View file

@ -85,7 +85,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">
@ -117,7 +117,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">
@ -134,6 +134,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">
@ -142,7 +143,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">
@ -151,7 +152,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_modulate" qualifiers="const"> <method name="tile_get_modulate" qualifiers="const">
@ -160,6 +161,7 @@
<argument index="0" name="id" type="int"> <argument index="0" name="id" type="int">
</argument> </argument>
<description> <description>
Returns the tile's modulation color.
</description> </description>
</method> </method>
<method name="tile_get_name" qualifiers="const"> <method name="tile_get_name" qualifiers="const">
@ -168,7 +170,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">
@ -195,6 +197,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">
@ -223,6 +226,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">
@ -231,6 +235,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_offset" qualifiers="const"> <method name="tile_get_shape_offset" qualifiers="const">
@ -241,6 +246,7 @@
<argument index="1" name="shape_id" type="int"> <argument index="1" name="shape_id" type="int">
</argument> </argument>
<description> <description>
Returns the offset of a tile's shape.
</description> </description>
</method> </method>
<method name="tile_get_shape_one_way" qualifiers="const"> <method name="tile_get_shape_one_way" qualifiers="const">
@ -251,6 +257,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">
@ -261,6 +268,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">
@ -269,7 +277,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">
@ -278,7 +286,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">
@ -296,6 +304,7 @@
<argument index="0" name="id" type="int"> <argument index="0" name="id" type="int">
</argument> </argument>
<description> <description>
Returns the tile's [enum TileMode].
</description> </description>
</method> </method>
<method name="tile_get_z_index" qualifiers="const"> <method name="tile_get_z_index" qualifiers="const">
@ -304,6 +313,7 @@
<argument index="0" name="id" type="int"> <argument index="0" name="id" type="int">
</argument> </argument>
<description> <description>
Returns the tile's z-index (drawing layer).
</description> </description>
</method> </method>
<method name="tile_set_light_occluder"> <method name="tile_set_light_occluder">
@ -391,7 +401,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">
@ -402,7 +412,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">
@ -415,6 +425,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_offset"> <method name="tile_set_shape_offset">
@ -427,6 +438,7 @@
<argument index="2" name="shape_offset" type="Vector2"> <argument index="2" name="shape_offset" type="Vector2">
</argument> </argument>
<description> <description>
Sets the offset of a tile's shape.
</description> </description>
</method> </method>
<method name="tile_set_shape_one_way"> <method name="tile_set_shape_one_way">
@ -439,6 +451,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">
@ -451,6 +464,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">

2
doc/classes/VisibilityEnabler.xml
View file

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

6
doc/classes/VisibilityEnabler2D.xml
View file

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