From 3708d887191d1b1518375e812d501b558f3f6f19 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Fri, 7 Apr 2017 19:44:42 +0200 Subject: classref: Sync with current source --- doc/base/classes.xml | 3056 +++++++++++++++++++++++++++++++++----------------- 1 file changed, 2001 insertions(+), 1055 deletions(-) (limited to 'doc') diff --git a/doc/base/classes.xml b/doc/base/classes.xml index 5bb85aedc1..f108a48310 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -1,5 +1,15 @@ + + + + + + + + + + Built-in GDScript functions. @@ -1959,6 +1969,22 @@ + + + + + + + + + + + + + + + + @@ -8381,7 +8407,7 @@ - + Get the material of this item. @@ -8519,7 +8545,7 @@ - + Set the material of this item. @@ -8580,7 +8606,7 @@ - + @@ -8650,52 +8676,6 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Canvas Item layer. @@ -11191,7 +11171,7 @@ - Set when the control is ignoring mouse events (even touchpad events send mouse events). (see the MOUSE_FILTER_* constants) + Set when the control is ignoring mouse events (even touchpad events send mouse events). (see the MOUSE_FILTER_* constants) @@ -12007,6 +11987,134 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Damped spring constraint for 2D physics. @@ -15155,1033 +15263,399 @@ - + - Simple Material with a fixed parameter set. + Internationalized font and text drawing support. - FixedSpatialMaterial is a simple type of material [Resource], which contains a fixed amount of parameters. It is the only type of material supported in fixed-pipeline devices and APIs. It is also an often a better alternative to [ShaderMaterial] for most simple use cases. + Font contains an unicode compatible character set, as well as the ability to draw it with variable width, ascent, descent and kerning. For creating fonts from TTF files (or other font formats), see the editor support for fonts. TODO check wikipedia for graph of ascent/baseline/descent/height/etc. - - - + + + + + + + + + + + + Draw "string" into a canvas item using the font at a given "pos" position, with "modulate" color, and optionally clipping the width. "pos" specifies the baseline, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis. - + + + + + + + + + + + + Draw character "char" into a canvas item using the font at a given "pos" position, with "modulate" color, and optionally kerning if "next" is passed. clipping the width. "pos" specifies the baseline, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis. The width used by the character is returned, making this function useful for drawing strings character by character. - - + + + Return the font ascent (number of pixels above the baseline). - + + Return the font descent (number of pixels below the baseline). - + + Return the total font height (ascent plus descent) in pixels. - - + + + + + Return the size of a string, taking kerning and advance into account. - - + + - - - + + After editing a font (changing size, ascent, char rects, etc.). Call this function to propagate changes to controls that might use it. - - + + + + + + + Reference to a function in an object. + + + In GDScript, functions are not [i]first-class objects[/i]. This means it is impossible to store them directly as variables, return them from another function, or pass them as arguments. + However, by creating a [FuncRef] using the [method @GDScript.funcref] function, a reference to a function in a given object can be created, passed around and called. + + + + - - - + + + + Set the name of the function to call on the object, without parentheses or any parameters. - - - + + + + Set the object on which to call the referenced function. This object must be of a type actually inheriting from [Object], not a built-in type such as [int], [Vector2] or [Dictionary]. - - + + + + + + + State of a function call after yielding. + + + Calling [method @GDScript.yield] within a function will cause that function to yield and return its current state as an object of this type. The yielded function call can then be resumed later by calling [method resume] on this state object. + + + + + Check whether the function call may be resumed. This is not the case if the function state was already resumed. - - + + - + + Resume execution of the yielded function call. + If handed an argument, return the argument from the [method @GDScript.yield] call in the yielded function call. You can pass e.g. an [Array] to hand multiple arguments. + This function returns what the resumed function call returns, possibly another function state if yielded again. - - - - - + + + + + + + + + + + - - + + + + + + + + + + + + - - + + - - - + + + + + + + + + + + + + + + - - - + - + - - + + - + - - + + - - + + - + - - + + - - + + - - + + - - - - + + - - - + + + - - - + + + - - - + + + - - - + + + - - + + - - + + - - + + - - + + - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Internationalized font and text drawing support. - - - Font contains an unicode compatible character set, as well as the ability to draw it with variable width, ascent, descent and kerning. For creating fonts from TTF files (or other font formats), see the editor support for fonts. TODO check wikipedia for graph of ascent/baseline/descent/height/etc. - - - - - - - - - - - - - - - Draw "string" into a canvas item using the font at a given "pos" position, with "modulate" color, and optionally clipping the width. "pos" specifies the baseline, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis. - - - - - - - - - - - - - - - - - Draw character "char" into a canvas item using the font at a given "pos" position, with "modulate" color, and optionally kerning if "next" is passed. clipping the width. "pos" specifies the baseline, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis. The width used by the character is returned, making this function useful for drawing strings character by character. - - - - - - - Return the font ascent (number of pixels above the baseline). - - - - - - - Return the font descent (number of pixels below the baseline). - - - - - - - Return the total font height (ascent plus descent) in pixels. - - - - - - - - - Return the size of a string, taking kerning and advance into account. - - - - - - - - - - - After editing a font (changing size, ascent, char rects, etc.). Call this function to propagate changes to controls that might use it. - - - - - - - - - Reference to a function in an object. - - - In GDScript, functions are not [i]first-class objects[/i]. This means it is impossible to store them directly as variables, return them from another function, or pass them as arguments. - However, by creating a [FuncRef] using the [method @GDScript.funcref] function, a reference to a function in a given object can be created, passed around and called. - - - - - - - - - - - - - Set the name of the function to call on the object, without parentheses or any parameters. - - - - - - - Set the object on which to call the referenced function. This object must be of a type actually inheriting from [Object], not a built-in type such as [int], [Vector2] or [Dictionary]. - - - - - - - - - State of a function call after yielding. - - - Calling [method @GDScript.yield] within a function will cause that function to yield and return its current state as an object of this type. The yielded function call can then be resumed later by calling [method resume] on this state object. - - - - - - - Check whether the function call may be resumed. This is not the case if the function state was already resumed. - - - - - - - - - Resume execution of the yielded function call. - If handed an argument, return the argument from the [method @GDScript.yield] call in the yielded function call. You can pass e.g. an [Array] to hand multiple arguments. - This function returns what the resumed function call returns, possibly another function state if yielded again. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + @@ -16913,29 +16387,17 @@ - - - - - - - + - + - - - - - - - + @@ -17091,6 +16553,114 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + GraphEdit is an area capable of showing various GraphNodes. It manages connection events between them. @@ -26099,6 +25669,8 @@ + + @@ -28486,6 +28058,246 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 2D Particle emitter @@ -29026,14 +28838,378 @@ - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -34849,6 +35025,32 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Quaternion. @@ -38207,6 +38409,12 @@ + + + + + + @@ -38774,6 +38982,42 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -39335,300 +39579,988 @@ - - + + + + + Return the global transform, relative to worldspace. + + + + + + + Return the parent [Spatial], or an empty [Object] if no parent exists or parent is not of type [Spatial]. + + + + + + + + + + + + + + + + + + + + + + + + + Return the local transform, relative to the bone parent. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Set the transform globally, relative to worldspace. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Set the transform locally, relative to the parent spatial node. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Spatial nodes receive this notification with their global transform changes. This means that either the current or a parent node changed its transform. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - Return the global transform, relative to worldspace. - - + + - Return the parent [Spatial], or an empty [Object] if no parent exists or parent is not of type [Spatial]. - - + + - - + + - - + + - - + + - Return the local transform, relative to the bone parent. - - + + - - + + - - - - - + + + - - - + + + - + + + + + - - + + - - + + - - + + - - + + - - - + + + - - + + - + + + + + - - + + - + + + + + - + + + + + - + + + - - + + - + + + + + - - + + - - + + - - + + - - + + - - + + + + - - + + + + - Set the transform globally, relative to worldspace. - + + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - Set the transform locally, relative to the parent spatial node. - - + + - - + + - + + + - - + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - + - + - + - + - + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - Spatial nodes receive this notification with their global transform changes. This means that either the current or a parent node changed its transform. + - + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - @@ -44425,7 +45357,7 @@ - + @@ -44535,7 +45467,7 @@ - + Set the material of the tile. @@ -44857,6 +45789,12 @@ + + + + + + @@ -44887,6 +45825,12 @@ + + + + + + @@ -44921,6 +45865,8 @@ + + -- cgit v1.2.3