godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2026-01-06 10:11:57 +03:00
Code Issues Packages Projects Releases Wiki Activity

Proofread and improve the whole class reference

Browse Source 
- Document a few more properties and methods
- Add more information to many classes
- Fix lots of typos and gramar mistakes
- Use [code] tags for parameters consistently
- Use [b] and [i] tags consistently
- Put "Warning:" and "Note:" on their own line to be more visible,
  and make them always bold
- Tweak formatting in code examples to be more readable
- Use double quotes consistently
- Add more links to third-party technologies
This commit is contained in:
Hugo Locurcio
2019-06-22 01:04:47 +02:00
parent 538c8eec15
commit f7f6115f76
330 changed files with 2585 additions and 2474 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
doc/classes/Skeleton.xml
View File

@@ -17,7 +17,7 @@
<argument index="0" name="name" type="String">
</argument>
<description>
Add a bone, with name "name". [method get_bone_count] will become the bone index.
Adds a bone, with name [code]name[/code]. [method get_bone_count] will become the bone index.
</description>
</method>
<method name="bind_child_node_to_bone">
@@ -28,7 +28,7 @@
<argument index="1" name="node" type="Node">
</argument>
<description>
Deprecated soon.
[i]Deprecated soon.[/i]
</description>
</method>
<method name="clear_bones">
@@ -44,7 +44,7 @@
<argument index="0" name="name" type="String">
</argument>
<description>
Returns the bone index that matches "name" as its name.
Returns the bone index that matches [code]name[/code] as its name.
</description>
</method>
<method name="get_bone_count" qualifiers="const">
@@ -78,7 +78,7 @@
<argument index="0" name="bone_idx" type="int">
</argument>
<description>
Returns the name of the bone at index "index".
Returns the name of the bone at index [code]index[/code].
</description>
</method>
<method name="get_bone_parent" qualifiers="const">
@@ -87,7 +87,8 @@
<argument index="0" name="bone_idx" type="int">
</argument>
<description>
Returns the bone index which is the parent of the bone at "bone_idx". If -1, then bone has no parent. Note that the parent bone returned will always be less than "bone_idx".
Returns the bone index which is the parent of the bone at [code]bone_idx[/code]. If -1, then bone has no parent.
[b]Note:[/b] The parent bone returned will always be less than [code]bone_idx[/code].
</description>
</method>
<method name="get_bone_pose" qualifiers="const">
@@ -105,7 +106,7 @@
<argument index="0" name="bone_idx" type="int">
</argument>
<description>
Returns the rest transform for a bone "bone_idx".
Returns the rest transform for a bone [code]bone_idx[/code].
</description>
</method>
<method name="get_bone_transform" qualifiers="const">
@@ -123,7 +124,7 @@
<argument index="0" name="bone_idx" type="int">
</argument>
<description>
Deprecated soon.
[i]Deprecated soon.[/i]
</description>
</method>
<method name="is_bone_rest_disabled" qualifiers="const">
@@ -218,7 +219,8 @@
<argument index="1" name="parent_idx" type="int">
</argument>
<description>
Set the bone index "parent_idx" as the parent of the bone at "bone_idx". If -1, then bone has no parent. Note: "parent_idx" must be less than "bone_idx".
Sets the bone index [code]parent_idx[/code] as the parent of the bone at [code]bone_idx[/code]. If -1, then bone has no parent.
[b]Note:[/b] [code]parent_idx[/code] must be less than [code]bone_idx[/code].
</description>
</method>
<method name="set_bone_pose">
@@ -229,7 +231,7 @@
<argument index="1" name="pose" type="Transform">
</argument>
<description>
Returns the pose transform for bone "bone_idx".
Returns the pose transform for bone [code]bone_idx[/code].
</description>
</method>
<method name="set_bone_rest">
@@ -240,7 +242,7 @@
<argument index="1" name="rest" type="Transform">
</argument>
<description>
Set the rest transform for bone "bone_idx"
Sets the rest transform for bone [code]bone_idx[/code].
</description>
</method>
<method name="unbind_child_node_from_bone">
@@ -251,7 +253,7 @@
<argument index="1" name="node" type="Node">
</argument>
<description>
Deprecated soon.
[i]Deprecated soon.[/i]
</description>
</method>
<method name="unparent_bone_and_rest">