From 2fce0010f0d0eb2476028ed62335508bceabd820 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Mon, 13 Nov 2017 09:24:36 +0100 Subject: classref: Sync with current source [ci skip] --- doc/classes/@GDScript.xml | 2 +- doc/classes/@Global Scope.xml | 6 ++- doc/classes/ARVRController.xml | 16 ++++++ doc/classes/ARVRPositionalTracker.xml | 18 +++++++ doc/classes/AStar.xml | 44 ++++++++-------- doc/classes/Array.xml | 8 +++ doc/classes/AtlasTexture.xml | 16 ++++++ doc/classes/BulletPhysicsDirectBodyState.xml | 15 ++++++ doc/classes/BulletPhysicsServer.xml | 15 ++++++ doc/classes/Geometry.xml | 40 +++++++------- doc/classes/LineEdit.xml | 14 ++--- doc/classes/Physics2DServer.xml | 59 ++++++++++++++++----- doc/classes/PhysicsDirectBodyStateSW.xml | 15 ------ doc/classes/PhysicsServer.xml | 22 +++++++- doc/classes/PhysicsServerSW.xml | 17 ------ doc/classes/Polygon2D.xml | 14 +++++ doc/classes/String.xml | 6 +++ doc/classes/StyleBoxLine.xml | 79 ++++++++++++++++++++++++++++ doc/classes/TextEdit.xml | 39 +++++++------- doc/classes/TileMap.xml | 16 ++++++ doc/classes/ViewportContainer.xml | 16 ++++++ doc/classes/VisualScriptBuiltinFunc.xml | 44 +++++++++------- 22 files changed, 386 insertions(+), 135 deletions(-) create mode 100644 doc/classes/BulletPhysicsDirectBodyState.xml create mode 100644 doc/classes/BulletPhysicsServer.xml delete mode 100644 doc/classes/PhysicsDirectBodyStateSW.xml delete mode 100644 doc/classes/PhysicsServerSW.xml create mode 100644 doc/classes/StyleBoxLine.xml (limited to 'doc/classes') diff --git a/doc/classes/@GDScript.xml b/doc/classes/@GDScript.xml index 3c794a4c4c..47003d08e0 100644 --- a/doc/classes/@GDScript.xml +++ b/doc/classes/@GDScript.xml @@ -1119,7 +1119,7 @@ Constant that represents how many times the diameter of a circle fits around its perimeter. - + The circle constant, the circumference of the unit circle. diff --git a/doc/classes/@Global Scope.xml b/doc/classes/@Global Scope.xml index 20f323bb4f..5e571e0284 100644 --- a/doc/classes/@Global Scope.xml +++ b/doc/classes/@Global Scope.xml @@ -1038,7 +1038,11 @@ Joypad Right Trigger Analog Axis - + + + + + Joypad Left Stick Horizontal Axis diff --git a/doc/classes/ARVRController.xml b/doc/classes/ARVRController.xml index af1deda2f0..2e6afe47cf 100644 --- a/doc/classes/ARVRController.xml +++ b/doc/classes/ARVRController.xml @@ -57,6 +57,12 @@ Returns the ID of the joystick object bound to this. Every controller tracked by the ARVR Server that has buttons and axis will also be registered as a joystick within Godot. This means that all the normal joystick tracking and input mapping will work for buttons and axis found on the AR/VR controllers. This ID is purely offered as information so you can link up the controller with its joystick entry. + + + + + + @@ -75,11 +81,21 @@ Changes the id that identifies the controller bound to this node. The first controller that the ARVR Server detects will have id 1, the second id 2, the third id 3, etc. When a controller is turned off that slot is freed ensuring that controllers will keep the same id while it is turned on even when controllers with lower ids are turned off. + + + + + + + + The controller's id. The first controller that the [ARVRServer] detects will have id 1, the second id 2, the third id 3, etc. When a controller is turned off, it's slot is freed. This ensures controllers will keep the same id even when controllers with lower ids are turned off. + + diff --git a/doc/classes/ARVRPositionalTracker.xml b/doc/classes/ARVRPositionalTracker.xml index 686ac1db77..dbb676f88c 100644 --- a/doc/classes/ARVRPositionalTracker.xml +++ b/doc/classes/ARVRPositionalTracker.xml @@ -48,6 +48,12 @@ Returns the position of the controller adjusted by world scale. + + + + + + @@ -78,7 +84,19 @@ Type of tracker. + + + + + + + + + + + + The hand this tracker is held in is unknown or not applicable. diff --git a/doc/classes/AStar.xml b/doc/classes/AStar.xml index 10ca3035fb..a2199c8f01 100644 --- a/doc/classes/AStar.xml +++ b/doc/classes/AStar.xml @@ -168,6 +168,28 @@ If you change the 2nd point's weight to 3, then the result will be [code][1, 4, 3][/code] instead, because now even though the distance is longer, it's "easier" to get through point 4 than through point 2. + + + + + + + Returns an array with the ids of the points that form the connect with the given point. + [codeblock] + var as = AStar.new() + + as.add_point(1, Vector3(0,0,0)) + as.add_point(2, Vector3(0,1,0)) + as.add_point(3, Vector3(1,1,0)) + as.add_point(4, Vector3(2,0,0)) + + as.connect_points(1, 2, true) + as.connect_points(1, 3, true) + + var neighbors = as.get_point_connections(1) # returns [2, 3] + [/codeblock] + + @@ -243,28 +265,6 @@ Sets the [code]weight_scale[/code] for the point with the given id. - - - - - - - Returns an array with the ids of the points that form the connect with the given point. - [codeblock] - var as = AStar.new() - - as.add_point(1, Vector3(0,0,0)) - as.add_point(2, Vector3(0,1,0)) - as.add_point(3, Vector3(1,1,0)) - as.add_point(4, Vector3(2,0,0)) - - as.connect_points(1, 2, true) - as.connect_points(1, 3, true) - - var neighbors = as.get_point_connections(1) # returns [2, 3] - [/codeblock] - - diff --git a/doc/classes/Array.xml b/doc/classes/Array.xml index 7c1d72333b..05a571fb5e 100644 --- a/doc/classes/Array.xml +++ b/doc/classes/Array.xml @@ -82,6 +82,8 @@ + + Returns the last element of the array if the array is not empty (size>0). @@ -142,6 +144,8 @@ + + Returns the first element of the array if the array is not empty (size>0). @@ -183,11 +187,15 @@ + + Remove the last element of the array. + + Remove the first element of the array. diff --git a/doc/classes/AtlasTexture.xml b/doc/classes/AtlasTexture.xml index 179f78f16f..924dae8495 100644 --- a/doc/classes/AtlasTexture.xml +++ b/doc/classes/AtlasTexture.xml @@ -30,6 +30,12 @@ + + + + + + @@ -38,6 +44,14 @@ + + + + + + + + @@ -59,6 +73,8 @@ The texture that contains the atlas. Can be any [Texture] subtype. + + The margin around the region. The [Rect2]'s 'size' parameter ('w' and 'h' in the editor) resizes the texture so it fits within the margin. diff --git a/doc/classes/BulletPhysicsDirectBodyState.xml b/doc/classes/BulletPhysicsDirectBodyState.xml new file mode 100644 index 0000000000..3d7be54e19 --- /dev/null +++ b/doc/classes/BulletPhysicsDirectBodyState.xml @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + + diff --git a/doc/classes/BulletPhysicsServer.xml b/doc/classes/BulletPhysicsServer.xml new file mode 100644 index 0000000000..ac5d510486 --- /dev/null +++ b/doc/classes/BulletPhysicsServer.xml @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + + diff --git a/doc/classes/Geometry.xml b/doc/classes/Geometry.xml index 1589a9a906..283d77c954 100644 --- a/doc/classes/Geometry.xml +++ b/doc/classes/Geometry.xml @@ -50,6 +50,26 @@ Returns an array of [Plane]s closely bounding a faceted cylinder centered at the origin with radius [code]radius[/code] and height [code]height[/code]. The parameter [code]sides[/code] defines how many planes will be generated for the round part of the cylinder. The parameter [code]axis[/code] describes the axis along which the cylinder is oriented (0 for X, 1 for Y, 2 for Z). + + + + + + + + + Clips the polygon defined by the points in [code]points[/code] against the [code]plane[/code] and returns the points of the clipped polygon. + + + + + + + + + Given an array of [Vector2]s, returns the convex hull as a list of points in counter-clockwise order. The last point is the same as the first one. + + @@ -280,26 +300,6 @@ Triangulates the polygon specified by the points in [code]polygon[/code]. Returns a [PoolIntArray] where each triangle consists of three consecutive point indices into [code]polygon[/code] (i.e. the returned array will have [code]n * 3[/code] elements, with [code]n[/code] being the number of found triangles). If the triangulation did not succeed, an empty [PoolIntArray] is returned. - - - - - - - Given an array of [Vector2]s, returns the convex hull as a list of points in counter-clockwise order. The last point is the same as the first one. - - - - - - - - - - - Clips the polygon defined by the points in [code]points[/code] against the [code]plane[/code] and returns the points of the clipped polygon. - - diff --git a/doc/classes/LineEdit.xml b/doc/classes/LineEdit.xml index bf81d90efe..a9626d945c 100644 --- a/doc/classes/LineEdit.xml +++ b/doc/classes/LineEdit.xml @@ -114,7 +114,7 @@ Return the text in the [code]LineEdit[/code]. - + @@ -180,7 +180,7 @@ - + Set the status of the context menu. When enabled, the context menu will appear when the [code]LineEdit[/code] is right clicked. @@ -268,6 +268,9 @@ Duration (in seconds) of a caret's blinking cycle. + + If [code]true[/code] the context menu will appear when right clicked. + If [code]false[/code] existing text cannot be modified and new text cannot be added. @@ -292,9 +295,6 @@ String value of the [LineEdit]. - - If [code]true[/code] the context menu will appear when right clicked. - @@ -343,7 +343,9 @@ Undoes the previous action. - + + + diff --git a/doc/classes/Physics2DServer.xml b/doc/classes/Physics2DServer.xml index 6e3381c200..764f18c427 100644 --- a/doc/classes/Physics2DServer.xml +++ b/doc/classes/Physics2DServer.xml @@ -338,10 +338,6 @@ - - - - Creates a physics body. The first parameter can be any value from constants BODY_MODE*, for the type of body created. Additionally, the body can be created in sleeping state to save processing time. @@ -725,6 +721,30 @@ Returns whether a body can move from a given point in a given direction. Apart from the boolean return value, a [Physics2DTestMotionResult] can be passed to return additional information in. + + + + + + + + + + + + + + + + + + + + + + + + @@ -832,6 +852,12 @@ Sets a joint parameter. Parameters are explained in the JOINT_PARAM* constants. + + + + + + @@ -845,22 +871,31 @@ Creates a pin joint between two bodies. If not specified, the second body is assumed to be the joint itself. - - + + - - - Activates or deactivates the 2D physics engine. - + - + + + + + + + + + + + + + - Creates a shape of type SHAPE_*. Does not assign it to a body or an area. To do so, you must use [method area_set_shape] or [method body_set_shape]. + Activates or deactivates the 2D physics engine. diff --git a/doc/classes/PhysicsDirectBodyStateSW.xml b/doc/classes/PhysicsDirectBodyStateSW.xml deleted file mode 100644 index 6d283f307e..0000000000 --- a/doc/classes/PhysicsDirectBodyStateSW.xml +++ /dev/null @@ -1,15 +0,0 @@ - - - - - - - - - - - - - - - diff --git a/doc/classes/PhysicsServer.xml b/doc/classes/PhysicsServer.xml index b0f42b83a3..c165ee3c1e 100644 --- a/doc/classes/PhysicsServer.xml +++ b/doc/classes/PhysicsServer.xml @@ -388,6 +388,14 @@ Returns the [PhysicsDirectBodyState] of the body. + + + + + + + + @@ -598,6 +606,16 @@ Sets the function used to calculate physics for an object, if that object allows it (see [method body_set_omit_force integration]). + + + + + + + + + + @@ -1422,7 +1440,9 @@ Constant for rigid bodies. - + + + Constant for rigid bodies in character mode. In this mode, a body can not rotate, and only its linear velocity is affected by physics. diff --git a/doc/classes/PhysicsServerSW.xml b/doc/classes/PhysicsServerSW.xml deleted file mode 100644 index 53e1c0057e..0000000000 --- a/doc/classes/PhysicsServerSW.xml +++ /dev/null @@ -1,17 +0,0 @@ - - - - Software implementation of [PhysicsServer]. - - - This class exposes no new methods or properties and should not be used, as [PhysicsServer] automatically selects the best implementation available. - - - - - - - - - - diff --git a/doc/classes/Polygon2D.xml b/doc/classes/Polygon2D.xml index 5aa7146ff7..57494fe6d6 100644 --- a/doc/classes/Polygon2D.xml +++ b/doc/classes/Polygon2D.xml @@ -73,6 +73,12 @@ Return the rotation in radians of the texture polygon. + + + + + + @@ -173,6 +179,14 @@ Set the amount of rotation of the polygon texture, [code]texture_rotation[/code] is specified in radians and clockwise rotation. + + + + + + + + diff --git a/doc/classes/String.xml b/doc/classes/String.xml index 546712f223..8c8fbc620c 100644 --- a/doc/classes/String.xml +++ b/doc/classes/String.xml @@ -273,6 +273,12 @@ Performs a case-sensitive comparison to another string. Returns [code]-1[/code] if less than, [code]+1[/code] if greater than, or [code]0[/code] if equal. + + + + + + diff --git a/doc/classes/StyleBoxLine.xml b/doc/classes/StyleBoxLine.xml new file mode 100644 index 0000000000..83d87176f2 --- /dev/null +++ b/doc/classes/StyleBoxLine.xml @@ -0,0 +1,79 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index 3cb33c78c0..43c7e02fbf 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -232,19 +232,18 @@ Insert a given text at the cursor position. - + - Returns true if highlight all occurrences is enabled. + Returns true if the context menu is enabled. - - + - Returns true if the context menu is enabled. + Returns true if highlight all occurrences is enabled. @@ -260,12 +259,12 @@ -+ -+ -+ -+ Return true if the text editor is in read-only mode (see [method set_readonly]). -+ -+ + + + + Return true if the text editor is in read-only mode (see [method set_readonly]). + + @@ -355,7 +354,7 @@ - + Set the status of the context menu. When enabled, the context menu will appear when the [code]TextEdit[/code] is right clicked. @@ -465,32 +464,32 @@ - - String value of the [TextEdit]. - - - If [code]true[/code] read-only mode is enabled. Existing text cannot be modified and new text cannot be added. - + + - + + If [code]true[/code] read-only mode is enabled. Existing text cannot be modified and new text cannot be added. - + + + String value of the [TextEdit]. + diff --git a/doc/classes/TileMap.xml b/doc/classes/TileMap.xml index c44fa500cd..49eaf5bc31 100644 --- a/doc/classes/TileMap.xml +++ b/doc/classes/TileMap.xml @@ -59,6 +59,12 @@ Return true if tiles are to be centered in y coordinate (by default this is false and they are drawn from upper left cell corner). + + + + + + @@ -298,6 +304,14 @@ Set tiles to be centered in y coordinate. (by default this is false and they are drawn from upper left cell corner). + + + + + + + + @@ -450,6 +464,8 @@ + + The custom [Transform2D] to be applied to the TileMap's cells. diff --git a/doc/classes/ViewportContainer.xml b/doc/classes/ViewportContainer.xml index d4d42ad4fb..8d5feaec68 100644 --- a/doc/classes/ViewportContainer.xml +++ b/doc/classes/ViewportContainer.xml @@ -9,6 +9,12 @@ + + + + + + @@ -23,10 +29,20 @@ + + + + + + + + + + diff --git a/doc/classes/VisualScriptBuiltinFunc.xml b/doc/classes/VisualScriptBuiltinFunc.xml index 5891b24bfd..c896ff6410 100644 --- a/doc/classes/VisualScriptBuiltinFunc.xml +++ b/doc/classes/VisualScriptBuiltinFunc.xml @@ -151,64 +151,68 @@ 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. -- cgit v1.2.3