From ac3aa29c24fbf7f6386c1fe365addf97b39cc3ba Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Tue, 26 Jan 2016 00:19:47 +0100 Subject: [PATCH] Sync API reference with current code --- doc/base/classes.xml | 374 +++++++++++++++++++++++++++++++------------ 1 file changed, 270 insertions(+), 104 deletions(-) diff --git a/doc/base/classes.xml b/doc/base/classes.xml index 435be38bc9..e642430636 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -1,5 +1,5 @@ - + Built-in GDScript functions. @@ -437,18 +437,16 @@ - Convert from a type to another in the best way possible. The "type" parameter uses the enum TYPE_* in Global Scope. + Convert from a type to another in the best way possible. The "type" parameter uses the enum TYPE_* in [@Global Scope]. - - + + - - - Convert one or more arguments to strings in the best way possible. + Returns the internal type of the given Variant object, using the TYPE_* enum in [@Global Scope]. @@ -7628,15 +7626,6 @@ Array of Color, can only contains colors. Optimized for memory usage, can't fragment the memory. - - - - - - - Get an index in the array. - - @@ -7680,7 +7669,7 @@ - + Color picker control. @@ -7702,14 +7691,14 @@ Return the current (edited) color. - - + + - - + + @@ -7726,6 +7715,12 @@ + + + + + + @@ -7749,6 +7744,10 @@ + + + + @@ -8208,20 +8207,6 @@ - - - - - Return wether this control is a [i]window[/i]. Controls are considered windows when their parent [Node] is not a Control. - - - - - - - Return the [i]window[/i] for this control, ascending the scene tree (see [method is_window]). - - @@ -8504,6 +8489,14 @@ Override a single icon ([Texture]) in the theme of this Control. If texture is empty, override is cleared. + + + + + + + + @@ -8741,6 +8734,10 @@ Emitted when an input event is received. Connecting in realtime is recommended for accepting the events. + + + + Emitted when the mouse left the control area. @@ -10742,6 +10739,8 @@ This approximation makes straight segments between each point, then subdivides t + + @@ -12020,6 +12019,24 @@ This approximation makes straight segments between each point, then subdivides t Return an Array containing the list of connections. A connection consists in a structure of the form {from_slot: 0, from: "GraphNode name 0", to_slot: 1, to: "GraphNode name 1" } + + + + + + + + + + + + + + + + + + @@ -13853,7 +13870,7 @@ returns:= "username=user&password=pass" - Emitted when a joystick device has been connected or disconnected + Emitted when a joystick device has been connected or disconnected @@ -14851,15 +14868,6 @@ returns:= "username=user&password=pass" Integer Array. Array of integers. Can only contain integers. Optimized for memory usage, can't fragment the memory. - - - - - - - Get an index in the array. - - @@ -19755,7 +19763,7 @@ returns:= "username=user&password=pass" - + @@ -20850,6 +20858,12 @@ returns:= "username=user&password=pass" + + + + + + @@ -26836,14 +26850,6 @@ This method controls whether the position between two cached points is interpola Raw byte array. Contains bytes. Optimized for memory usage, can't fragment the memory. - - - - - - - - @@ -27162,14 +27168,6 @@ This method controls whether the position between two cached points is interpola Real Array. Array of floating point values. Can only contain floats. Optimized for memory usage, can't fragment the memory. - - - - - - - - @@ -28825,25 +28823,25 @@ This method controls whether the position between two cached points is interpola - Static mode. The body behaves like a [StaticBody2D], and can only move by user code. + Static mode. The body behaves like a [StaticBody2D], and can only move by user code. - Kinematic body. The body behaves like a [KinematicBody2D], and can only move by user code. + Kinematic body. The body behaves like a [KinematicBody2D], and can only move by user code. - Rigid body. This is the "natural" state of a rigid body. It is affected by forces, and can move, rotate, and be affected by user code. + Rigid body. This is the "natural" state of a rigid body. It is affected by forces, and can move, rotate, and be affected by user code. - Character body. This behaves like a rigid body, but can not rotate. + Character body. This behaves like a rigid body, but can not rotate. - Disables continuous collision detection. This is the fastest way to detect body collisions, but can miss small, fast-moving objects. + Disables continuous collision detection. This is the fastest way to detect body collisions, but can miss small, fast-moving objects. - Enables continuous collision detection by raycasting. It is faster than shapecasting, but less precise. + Enables continuous collision detection by raycasting. It is faster than shapecasting, but less precise. - Enables continuous collision detection by shapecasting. It is the slowest CCD method, and the most precise. + Enables continuous collision detection by shapecasting. It is the slowest CCD method, and the most precise. @@ -29756,6 +29754,152 @@ This method controls whether the position between two cached points is interpola + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -32398,14 +32542,14 @@ This method controls whether the position between two cached points is interpola Return if the split is collapsed. - - + + - - + + @@ -32420,6 +32564,12 @@ This method controls whether the position between two cached points is interpola + + + + + + @@ -33569,6 +33719,18 @@ This method controls whether the position between two cached points is interpola Return true if the strings begins with the given string. + + + + + + + + + + + + @@ -33717,6 +33879,12 @@ This method controls whether the position between two cached points is interpola Check whether the string contains a valid IP address. + + + + + + @@ -33978,14 +34146,6 @@ This method controls whether the position between two cached points is interpola String Array. Array of strings. Can only contain strings. Optimized for memory usage, can't fragment the memory. - - - - - - - - @@ -34724,6 +34884,12 @@ This method controls whether the position between two cached points is interpola + + + + + + @@ -34752,13 +34918,11 @@ This method controls whether the position between two cached points is interpola - + - + - - - + @@ -34780,6 +34944,8 @@ This method controls whether the position between two cached points is interpola + + @@ -38504,15 +38670,6 @@ This method controls whether the position between two cached points is interpola An Array specifically designed to hold Vector2. - - - - - - - Returns the Vector2 at the given index. - - @@ -38769,15 +38926,6 @@ This method controls whether the position between two cached points is interpola An Array specifically designed to hold Vector3. - - - - - - - Returns the Vector3 at the given index. - - @@ -39502,6 +39650,24 @@ This method controls whether the position between two cached points is interpola + + + + + + + + + + + + + + + + + +