godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: Sync classref with current source

This commit is contained in:
Rémi Verschelde 2019-05-21 13:26:37 +02:00
parent 1595dfb5db
commit 86f6d08923
8 changed files with 65 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/classes/AnimationNodeStateMachineTransition.xml
View File

@ -13,7 +13,7 @@
Turn on auto advance when this condition is set. The provided name will become a boolean parameter on the [AnimationTree] that can be controlled from code (see [url=https://docs.godotengine.org/en/latest/tutorials/animation/animation_tree.html#controlling-from-code][/url]). For example, if [member AnimationTree.tree_root] is an [AnimationNodeStateMachine] and [member advance_condition] is set to "idle":
[codeblock]
$animation_tree["parameters/conditions/idle"] = is_on_floor and linear_velocity.x == 0
[codeblock]
[/codeblock]
</member>
<member name="auto_advance" type="bool" setter="set_auto_advance" getter="has_auto_advance">
Turn on the transition automatically when this state is reached. This works best with [code]SWITCH_MODE_AT_END[/code].

32
doc/classes/Control.xml
View File

@ -512,7 +512,7 @@
</return>
<argument index="0" name="preset" type="int" enum="Control.LayoutPreset">
</argument>
<argument index="1" name="keep_margin" type="bool" default="false">
<argument index="1" name="keep_margins" type="bool" default="false">
</argument>
<description>
</description>
@ -574,6 +574,16 @@
Sets [member margin_right] and [member margin_bottom] at the same time.
</description>
</method>
<method name="set_global_position">
<return type="void">
</return>
<argument index="0" name="position" type="Vector2">
</argument>
<argument index="1" name="keep_margins" type="bool" default="false">
</argument>
<description>
</description>
</method>
<method name="set_margins_preset">
<return type="void">
</return>
@ -586,6 +596,16 @@
<description>
</description>
</method>
<method name="set_position">
<return type="void">
</return>
<argument index="0" name="position" type="Vector2">
</argument>
<argument index="1" name="keep_margins" type="bool" default="false">
</argument>
<description>
</description>
</method>
<method name="set_rotation">
<return type="void">
</return>
@ -595,6 +615,16 @@
Sets the rotation (in radians).
</description>
</method>
<method name="set_size">
<return type="void">
</return>
<argument index="0" name="size" type="Vector2">
</argument>
<argument index="1" name="keep_margins" type="bool" default="false">
</argument>
<description>
</description>
</method>
<method name="show_modal">
<return type="void">
</return>

16
doc/classes/Object.xml
View File

@ -65,14 +65,6 @@
Override this method to customize the [String] representation of the object when it's being converted to a string, for example: [code]print(obj)[/code].
</description>
</method>
<method name="to_string">
<return type="String">
</return>
<description>
Returns a [String] representing the object. Default is [code]"[ClassName:RID]"[/code].
Override the method [method _to_string] to customize the [String] representation.
</description>
</method>
<method name="add_user_signal">
<return type="void">
</return>
@ -420,6 +412,14 @@
Set a script into the object, scripts extend the object functionality.
</description>
</method>
<method name="to_string">
<return type="String">
</return>
<description>
Returns a [String] representing the object. Default is [code]"[ClassName:RID]"[/code].
Override the method [method _to_string] to customize the [String] representation.
</description>
</method>
<method name="tr" qualifiers="const">
<return type="String">
</return>

10
doc/classes/TextEdit.xml
View File

@ -382,12 +382,12 @@
<member name="context_menu_enabled" type="bool" setter="set_context_menu_enabled" getter="is_context_menu_enabled">
If [code]true[/code], a right click displays the context menu.
</member>
<member name="draw_tabs" type="bool" setter="set_draw_tabs" getter="is_drawing_tabs">
If [code]true[/code], the "tab" character will have a visible representation.
</member>
<member name="draw_spaces" type="bool" setter="set_draw_spaces" getter="is_drawing_spaces">
If [code]true[/code], the "space" character will have a visible representation.
</member>
<member name="draw_tabs" type="bool" setter="set_draw_tabs" getter="is_drawing_tabs">
If [code]true[/code], the "tab" character will have a visible representation.
</member>
<member name="fold_gutter" type="bool" setter="set_fold_gutter_enabled" getter="is_fold_gutter_enabled">
If [code]true[/code], the fold gutter is visible. This enables folding groups of indented lines.
</member>
@ -497,6 +497,8 @@
<theme_items>
<theme_item name="background_color" type="Color">
</theme_item>
<theme_item name="bookmark_color" type="Color">
</theme_item>
<theme_item name="brace_mismatch_color" type="Color">
</theme_item>
<theme_item name="breakpoint_color" type="Color">
@ -561,6 +563,8 @@
</theme_item>
<theme_item name="selection_color" type="Color">
</theme_item>
<theme_item name="space" type="Texture">
</theme_item>
<theme_item name="symbol_color" type="Color">
</theme_item>
<theme_item name="tab" type="Texture">

2
doc/classes/UndoRedo.xml
View File

@ -141,7 +141,7 @@
This is useful mostly to check if something changed from a saved version.
</description>
</method>
<method name="is_committing_action" qualifiers="const">
<method name="is_commiting_action" qualifiers="const">
<return type="bool">
</return>
<description>

13
doc/classes/VisualShaderNodeFresnel.xml Normal file
View File

@ -0,0 +1,13 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualShaderNodeFresnel" inherits="VisualShaderNode" category="Core" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<constants>
</constants>
</class>

2
doc/classes/VisualShaderNodeScalarFunc.xml
View File

@ -75,5 +75,7 @@
</constant>
<constant name="FUNC_TRUNC" value="30" enum="Function">
</constant>
<constant name="FUNC_ONEMINUS" value="31" enum="Function">
</constant>
</constants>
</class>

2
doc/classes/VisualShaderNodeVectorFunc.xml
View File

@ -81,5 +81,7 @@
</constant>
<constant name="FUNC_TRUNC" value="33" enum="Function">
</constant>
<constant name="FUNC_ONEMINUS" value="34" enum="Function">
</constant>
</constants>
</class>