From 8652c1d5b129faa76210dfa757b3e91e48e5428d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Sat, 21 Oct 2017 12:02:08 +0200 Subject: [PATCH] classref: Sync with current source --- doc/classes/@Global Scope.xml | 2 + doc/classes/EditorScript.xml | 4 +- doc/classes/GraphEdit.xml | 4 +- doc/classes/PhysicsServer.xml | 21 +- doc/classes/PluginScript.xml | 15 + doc/classes/RichTextLabel.xml | 16 + doc/classes/SceneTree.xml | 8 +- doc/classes/StyleBoxFlat.xml | 2 +- doc/classes/TextEdit.xml | 16 + doc/classes/VisualScriptBuiltinFunc.xml | 66 +- doc/classes/VisualScriptSequence.xml | 2 +- doc/classes/VisualServer.xml | 2006 +++++++++++++++++ .../doc_classes/ARVRInterfaceGDNative.xml | 9 - modules/gdnative/doc_classes/GDNative.xml | 6 +- modules/gridmap/doc_classes/GridMap.xml | 20 + 15 files changed, 2137 insertions(+), 60 deletions(-) create mode 100644 doc/classes/PluginScript.xml diff --git a/doc/classes/@Global Scope.xml b/doc/classes/@Global Scope.xml index d8c9a57a88..0d509e6e51 100644 --- a/doc/classes/@Global Scope.xml +++ b/doc/classes/@Global Scope.xml @@ -29,6 +29,8 @@ [Geometry] singleton + + [IP] singleton diff --git a/doc/classes/EditorScript.xml b/doc/classes/EditorScript.xml index 9e774345a2..39d5ab7254 100644 --- a/doc/classes/EditorScript.xml +++ b/doc/classes/EditorScript.xml @@ -4,7 +4,7 @@ Base script that can be used to add extension functions to the editor. - Scripts extending this class and implementing its [code]_run()[/code] method can be executed from the Script Editor's [code]File -> Run[/code] menu option (or by pressing [code]CTRL+Shift+X[/code]) while the editor is running. This is useful for adding custom in-editor functionality to Godot. For more complex additions, consider using [EditorPlugin]\ s instead. Note that extending scripts need to have [code]tool mode[/code] enabled. + Scripts extending this class and implementing its [code]_run()[/code] method can be executed from the Script Editor's [code]File -> Run[/code] menu option (or by pressing [code]CTRL+Shift+X[/code]) while the editor is running. This is useful for adding custom in-editor functionality to Godot. For more complex additions, consider using [EditorPlugin]\ s instead. Note that extending scripts need to have [code]tool mode[/code] enabled. Example script: [codeblock] tool @@ -24,7 +24,7 @@ - This method is executed by the Editor when [code]File -> Run[/code] is used. + This method is executed by the Editor when [code]File -> Run[/code] is used. diff --git a/doc/classes/GraphEdit.xml b/doc/classes/GraphEdit.xml index f064029a01..01d578be5e 100644 --- a/doc/classes/GraphEdit.xml +++ b/doc/classes/GraphEdit.xml @@ -228,8 +228,6 @@ - - @@ -246,5 +244,7 @@ + + diff --git a/doc/classes/PhysicsServer.xml b/doc/classes/PhysicsServer.xml index 12c1abccc6..71cdd6f6df 100644 --- a/doc/classes/PhysicsServer.xml +++ b/doc/classes/PhysicsServer.xml @@ -376,14 +376,15 @@ Returns the physics layer or layers a body can collide with. -- -- -- -- -- -- -- -- +- + + + + + + + + Returns the [PhysicsDirectBodyState] of the body. @@ -534,7 +535,7 @@ - Locks velocity along one axis to 0 and only allows rotation along this axis, can also be set to disabled which disables this functionality. + Locks velocity along one axis to 0 and only allows rotation along this axis, can also be set to disabled which disables this functionality. @@ -746,7 +747,7 @@ - + Gets a generic_6_DOF_joint flag (see G6DOF_JOINT_FLAG* constants). diff --git a/doc/classes/PluginScript.xml b/doc/classes/PluginScript.xml new file mode 100644 index 0000000000..334921016b --- /dev/null +++ b/doc/classes/PluginScript.xml @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + + diff --git a/doc/classes/RichTextLabel.xml b/doc/classes/RichTextLabel.xml index 9f8cdcce6d..0e15785d0d 100644 --- a/doc/classes/RichTextLabel.xml +++ b/doc/classes/RichTextLabel.xml @@ -102,6 +102,12 @@ + + + + + + @@ -247,6 +253,14 @@ + + + + + + + + @@ -330,6 +344,8 @@ + + diff --git a/doc/classes/SceneTree.xml b/doc/classes/SceneTree.xml index fd32f35a06..f6a6ce36e3 100644 --- a/doc/classes/SceneTree.xml +++ b/doc/classes/SceneTree.xml @@ -313,7 +313,7 @@ - + @@ -352,6 +352,12 @@ + + + + + + diff --git a/doc/classes/StyleBoxFlat.xml b/doc/classes/StyleBoxFlat.xml index 756b7f9225..eb9f82af6c 100644 --- a/doc/classes/StyleBoxFlat.xml +++ b/doc/classes/StyleBoxFlat.xml @@ -202,7 +202,7 @@ - + diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index d77cb69eef..9a500af347 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -239,6 +239,12 @@ Returns true if highlight all occurrences is enabled. + + + + + + @@ -343,6 +349,14 @@ Set the maximum amount of characters editable. + + + + + + + + @@ -421,6 +435,8 @@ + + diff --git a/doc/classes/VisualScriptBuiltinFunc.xml b/doc/classes/VisualScriptBuiltinFunc.xml index f48f5a5308..5891b24bfd 100644 --- a/doc/classes/VisualScriptBuiltinFunc.xml +++ b/doc/classes/VisualScriptBuiltinFunc.xml @@ -114,97 +114,101 @@ Return a number linearly interpolated between the first two inputs, based on the third input. Uses the formula [code]a + (a - b) * t[/code]. - + + + + + Return the result of 'value' decreased by 'step' * 'amount'. - + Randomize the seed (or the internal state) of the random number generator. Current implementation reseeds using a number based on time. - + Return a random 32 bits integer value. To obtain a random value between 0 to N (where N is smaller than 2^32 - 1), you can use it with the remainder function. - + Return a random floating-point value between 0 and 1. To obtain a random value between 0 to N, you can use it with multiplication. - + Return a random floating-point value between the two inputs. - + Set the seed for the random number generator. - + Return a random value from the given seed, along with the new seed. - + Convert the input from degrees to radians. - + Convert the input from radians to degrees. - + Convert the input from linear volume to decibel volume. - + Convert the input from decibel volume to linear volume. - + Return the greater of the two numbers, also known as their maximum. - + Return the lesser of the two numbers, also known as their minimum. - + Return the input clamped inside the given range, ensuring the result is never outside it. Equivalent to `min(max(input, range_low), range_high)` - + Return the nearest power of 2 to the input. - + Create a [WeakRef] from the input. - + Create a [FuncRef] from the input. - + Convert between types. - + Return the type of the input as an integer. Check [enum Variant.Type] for the integers that might be returned. - + Checks if a type is registered in the [ClassDB]. - + Return a character with the given ascii value. - + Convert the input to a string. - + Print the given string to the output window. - + Print the given string to the standard error output. - + Print the given string to the standard output, without adding a newline. - + Serialize a [Variant] to a string. - + Deserialize a [Variant] from a string serialized using [VAR_TO_STR]. - + Serialize a [Variant] to a [PoolByteArray]. - + Deserialize a [Variant] from a [PoolByteArray] serialized using [VAR_TO_BYTES]. - + Return the [Color] with the given name and alpha ranging from 0 to 1. Note: names are defined in color_names.inc. - + The maximum value the [member function] property can have. diff --git a/doc/classes/VisualScriptSequence.xml b/doc/classes/VisualScriptSequence.xml index 4ea4203407..845da4e50b 100644 --- a/doc/classes/VisualScriptSequence.xml +++ b/doc/classes/VisualScriptSequence.xml @@ -1,7 +1,7 @@ - Executes a series of Sequence ports. + Executes a series of Sequence ports. Steps through a series of one or more output Sequence ports. The [code]current[/code] data port outputs the currently executing item. diff --git a/doc/classes/VisualServer.xml b/doc/classes/VisualServer.xml index 4bc6a49e91..5c6a951e7d 100644 --- a/doc/classes/VisualServer.xml +++ b/doc/classes/VisualServer.xml @@ -12,6 +12,820 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -24,6 +838,380 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -38,6 +1226,128 @@ The callback method must use only 1 argument which will be called with 'userdata'. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -54,6 +1364,22 @@ + + + + + + + + + + + + + + + + @@ -62,6 +1388,14 @@ + + + + + + + + @@ -70,6 +1404,22 @@ + + + + + + + + + + + + + + + + @@ -78,6 +1428,18 @@ + + + + + + + + + + + + @@ -88,6 +1450,16 @@ + + + + + + + + + + @@ -96,7 +1468,641 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/modules/gdnative/doc_classes/ARVRInterfaceGDNative.xml b/modules/gdnative/doc_classes/ARVRInterfaceGDNative.xml index 74f71ff603..308a7d5946 100644 --- a/modules/gdnative/doc_classes/ARVRInterfaceGDNative.xml +++ b/modules/gdnative/doc_classes/ARVRInterfaceGDNative.xml @@ -11,15 +11,6 @@ - - - - - - - Bind this GDNative library to our interface. The library must be a GDNative ARVR Interface for this to work. - - diff --git a/modules/gdnative/doc_classes/GDNative.xml b/modules/gdnative/doc_classes/GDNative.xml index ba813c4564..83a1cf06f0 100644 --- a/modules/gdnative/doc_classes/GDNative.xml +++ b/modules/gdnative/doc_classes/GDNative.xml @@ -12,11 +12,11 @@ - + - + - + diff --git a/modules/gridmap/doc_classes/GridMap.xml b/modules/gridmap/doc_classes/GridMap.xml index ed8c27e5d0..5b0fe56f25 100644 --- a/modules/gridmap/doc_classes/GridMap.xml +++ b/modules/gridmap/doc_classes/GridMap.xml @@ -103,6 +103,18 @@ Array of [Vector3] with the non empty cell coordinates in the grid map. + + + + + + + + + + + + @@ -198,6 +210,14 @@ Sets the collection of meshes for the map. + + + + + + + +