From eefc2bf5f74b5aed5a6f25986f9380d3a410851e Mon Sep 17 00:00:00 2001 From: George Marques Date: Tue, 20 Oct 2015 14:26:37 -0200 Subject: Syncing classes.xml with current binary --- doc/base/classes.xml | 296 ++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 243 insertions(+), 53 deletions(-) diff --git a/doc/base/classes.xml b/doc/base/classes.xml index 157d49fbc8..c789fc35ee 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -10867,27 +10867,25 @@ - + - + - - - + - + - + - + - + - + - + - + @@ -11556,10 +11554,10 @@ - GraphEdit is an area capable of showing various GraphNodes. It manages connection events between them. + GraphEdit is an area capable of showing various GraphNodes. It manages connection events between them. - GraphEdit manages the showing of GraphNodes it contains, as well as connections an disconnections between them. Signals are sent for each of these two events. Disconnection between GraphNodes slots is disabled by default. + GraphEdit manages the showing of GraphNodes it contains, as well as connections an disconnections between them. Signals are sent for each of these two events. Disconnection between GraphNodes slots is disabled by default. It is greatly advised to enable low processor usage mode [OS.set_low_processor_usage_mode()] when using GraphEdits. @@ -11575,7 +11573,7 @@ - Create a connection between 'from_port' slot of 'from' GraphNode and 'to_port' slot of 'to' GraphNode. If the connection already exists, no connection is created. + Create a connection between 'from_port' slot of 'from' GraphNode and 'to_port' slot of 'to' GraphNode. If the connection already exists, no connection is created. @@ -11590,7 +11588,7 @@ - Return true if the 'from_port' slot of 'from' GraphNode is connected to the 'to_port' slot of 'to' GraphNode. + Return true if the 'from_port' slot of 'from' GraphNode is connected to the 'to_port' slot of 'to' GraphNode. @@ -11603,32 +11601,50 @@ - Remove the connection between 'from_port' slot of 'from' GraphNode and 'to_port' slot of 'to' GraphNode, if connection exists. + Remove the connection between 'from_port' slot of 'from' GraphNode and 'to_port' slot of 'to' GraphNode, if connection exists. - 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" } + 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" } - Enable the disconnection of existing connections in the visual GraphEdit by left-clicking a connection and releasing into the void. + Enable the disconnection of existing connections in the visual GraphEdit by left-clicking a connection and releasing into the void. - Return true is the disconnection of connections is enable in the visual GraphEdit. False otherwise. + Return true is the disconnection of connections is enable in the visual GraphEdit. False otherwise. + + + + + + + + + + + + + + + + + + @@ -11639,7 +11655,7 @@ - Signal sent to the GraphEdit when the connection between 'from_slot' slot of 'from' GraphNode and 'to_slot' slot of 'to' GraphNode is attempted to be removed. + Signal sent to the GraphEdit when the connection between 'from_slot' slot of 'from' GraphNode and 'to_slot' slot of 'to' GraphNode is attempted to be removed. @@ -11652,7 +11668,11 @@ - Signal sent to the GraphEdit when the connection between 'from_slot' slot of 'from' GraphNode and 'to_slot' slot of 'to' GraphNode is attempted to be created. + Signal sent to the GraphEdit when the connection between 'from_slot' slot of 'from' GraphNode and 'to_slot' slot of 'to' GraphNode is attempted to be created. + + + + @@ -11661,24 +11681,24 @@ - A GraphNode is a container with several input and output slots allowing connections between GraphNodes. Slots can have different, incompatible types. + A GraphNode is a container with several input and output slots allowing connections between GraphNodes. Slots can have different, incompatible types. - A GraphNode is a container defined by a title. It can have 1 or more input and output slots, which can be enabled (shown) or disabled (not shown) and have different (incompatible) types. Colors can also be assigned to slots. A tuple of input and output slots is defined for each GUI element included in the GraphNode. Input and output connections are left and right slots, but only enabled slots are counted as connections. + A GraphNode is a container defined by a title. It can have 1 or more input and output slots, which can be enabled (shown) or disabled (not shown) and have different (incompatible) types. Colors can also be assigned to slots. A tuple of input and output slots is defined for each GUI element included in the GraphNode. Input and output connections are left and right slots, but only enabled slots are counted as connections. - Set the title of the GraphNode. + Set the title of the GraphNode. - Return the title of the GraphNode. + Return the title of the GraphNode. @@ -11697,19 +11717,19 @@ - Set the tuple of input/output slots defined by 'idx' ID. 'left' slots are input, 'right' are output. 'type' is an integer defining the type of the slot. Refer to description for the compatibility between slot types. + Set the tuple of input/output slots defined by 'idx' ID. 'left' slots are input, 'right' are output. 'type' is an integer defining the type of the slot. Refer to description for the compatibility between slot types. - Disable input and ouput slot whose index is 'idx'. + Disable input and ouput slot whose index is 'idx'. - Disable all input and output slots of the GraphNode. + Disable all input and output slots of the GraphNode. @@ -11718,7 +11738,7 @@ - Return true if left (input) slot 'idx' is enabled. False otherwise. + Return true if left (input) slot 'idx' is enabled. False otherwise. @@ -11727,7 +11747,7 @@ - Return the (integer) type of left (input) 'idx' slot. + Return the (integer) type of left (input) 'idx' slot. @@ -11736,7 +11756,7 @@ - Return the color set to 'idx' left (input) slot. + Return the color set to 'idx' left (input) slot. @@ -11745,7 +11765,7 @@ - Return true if right (output) slot 'idx' is enabled. False otherwise. + Return true if right (output) slot 'idx' is enabled. False otherwise. @@ -11754,7 +11774,7 @@ - Return the (integer) type of right (output) 'idx' slot. + Return the (integer) type of right (output) 'idx' slot. @@ -11763,35 +11783,35 @@ - Return the color set to 'idx' right (output) slot. + Return the color set to 'idx' right (output) slot. - Set the offset of the GraphNode. + Set the offset of the GraphNode. - Return the offset of the GraphNode. + Return the offset of the GraphNode. - Return the number of enabled output slots (connections) of the GraphNode. + Return the number of enabled output slots (connections) of the GraphNode. - Return the number of enabled input slots (connections) to the GraphNode. + Return the number of enabled input slots (connections) to the GraphNode. @@ -11800,7 +11820,7 @@ - Return the position of the output connection 'idx'. + Return the position of the output connection 'idx'. @@ -11809,7 +11829,7 @@ - Return the type of the output connection 'idx'. + Return the type of the output connection 'idx'. @@ -11818,7 +11838,7 @@ - Return the color of the output connection 'idx'. + Return the color of the output connection 'idx'. @@ -11827,7 +11847,7 @@ - Return the position of the input connection 'idx'. + Return the position of the input connection 'idx'. @@ -11836,7 +11856,7 @@ - Return the type of the input connection 'idx'. + Return the type of the input connection 'idx'. @@ -11845,33 +11865,33 @@ - Return the color of the input connection 'idx'. + Return the color of the input connection 'idx'. - Show the close button on the GraphNode if 'show' is true (disabled by default). If enabled, a connection on the signal close_request is needed for the close button to work. + Show the close button on the GraphNode if 'show' is true (disabled by default). If enabled, a connection on the signal close_request is needed for the close button to work. - Returns true if the close button is shown. False otherwise. + Returns true if the close button is shown. False otherwise. - Signal sent when the GraphNode is requested to be displayed over other ones. Happens on focusing (clicking into) the GraphNode. + Signal sent when the GraphNode is requested to be displayed over other ones. Happens on focusing (clicking into) the GraphNode. - Signal sent on closing the GraphNode. + Signal sent on closing the GraphNode. @@ -11880,12 +11900,12 @@ - Signal sent when the GraphNode is dragged. + Signal sent when the GraphNode is dragged. - Signal sent when the GraphNode is moved. + Signal sent when the GraphNode is moved. @@ -11910,6 +11930,12 @@ + + + + + + @@ -14292,6 +14318,22 @@ + + + + + + + + + + + + + + + + Integer Array. @@ -18124,7 +18166,11 @@ - + + + + + @@ -20171,7 +20217,7 @@ - + @@ -20421,6 +20467,18 @@ + + + + + + + + + + + + @@ -24688,6 +24746,18 @@ Pin Joint for 2D Rigid Bodies. It pins 2 bodies (rigid or static) together, or a single body to a fixed position in space. + + + + + + + + + + + + @@ -26292,6 +26362,18 @@ + + + + + + + + + + + + @@ -29446,6 +29528,28 @@ + + + + + + + + + + + + + + + + + + + + + + @@ -33549,6 +33653,12 @@ + + + + + + @@ -33569,6 +33679,14 @@ + + + + + + + + @@ -34262,8 +34380,68 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -37272,6 +37450,12 @@ + + + + + + @@ -37323,6 +37507,12 @@ Return the dot product with b. + + + + + + -- cgit v1.2.3 From baa59c067031a790912239277f5fdff96193af7a Mon Sep 17 00:00:00 2001 From: George Marques Date: Tue, 20 Oct 2015 14:31:30 -0200 Subject: Add missing reference documentation for Array class --- doc/base/classes.xml | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/doc/base/classes.xml b/doc/base/classes.xml index c789fc35ee..9798aff0ac 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -3766,6 +3766,7 @@ + Append an element at the end of the array (alias of [method push_back]). @@ -3784,6 +3785,7 @@ + Remove the first occurence of a value from the array. @@ -3792,6 +3794,7 @@ + Searches the array for a value and returns its index or -1 if not found. @@ -3812,12 +3815,14 @@ + Reverse the order of the elements in the array (so first element will now be the last). + Get whether this is a shared array instance. @@ -3850,6 +3855,7 @@ + Sort the array using natural order. @@ -3858,6 +3864,7 @@ + Sort the array using a custom method. The arguments are an object that holds the method and the name of such method. The custom method receives two arguments (a pair of elements from the array) and must return true if the first argument is less than the second, and return false otherwise. -- cgit v1.2.3 From 44057ed4aec3e8a04a71dcc1bebeb20e43809eb7 Mon Sep 17 00:00:00 2001 From: Brickcaster Date: Sun, 25 Oct 2015 10:38:24 -0400 Subject: Updated classes/matrix32 The 3 members of a matrix 32 are Vector2, not float. Updated documentation to reflect this. --- doc/base/classes.xml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/base/classes.xml b/doc/base/classes.xml index 157d49fbc8..32115e604a 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -16517,11 +16517,11 @@ - + - + - + -- cgit v1.2.3 From 18964798b77c3a2c47078a22664d8851e50bbca6 Mon Sep 17 00:00:00 2001 From: Brickcaster Date: Sun, 25 Oct 2015 10:58:38 -0400 Subject: classes/color - Documenting a trick with set_modulate I wanted to document a trick using class color to highlight a sprite. --- doc/base/classes.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/base/classes.xml b/doc/base/classes.xml index 32115e604a..a26931d5aa 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -7291,7 +7291,7 @@ Color in RGBA format. - A color is represented as red, green and blue (r,g,b) components. Additionally, "a" represents the alpha component, often used for transparency. Values are in floating point, ranging from 0 to 1. + A color is represented as red, green and blue (r,g,b) components. Additionally, "a" represents the alpha component, often used for transparency. Values are in floating point and usually range from 0 to 1. Some methods (such as set_modulate() ) may accept values > 1. @@ -31619,7 +31619,7 @@ - Set color modulation for the sprite. All sprite pixels are multiplied by this color. + Set color modulation for the sprite. All sprite pixels are multiplied by this color. Color may contain rgb values above 1 to achieve a highlight effect. -- cgit v1.2.3 From e0e4bcc6a6ce25b311dc66664e746f5ef35e5d96 Mon Sep 17 00:00:00 2001 From: Brickcaster Date: Tue, 27 Oct 2015 17:43:31 -0400 Subject: Added description to classes/ScrollContainer Added description to help understand how to utilize the ScrollContainer node. --- doc/base/classes.xml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/base/classes.xml b/doc/base/classes.xml index a26931d5aa..db8b5b8ab1 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -29178,8 +29178,10 @@ + A helper node for displaying scollable elements (e.g. lists). + A ScrollContainer node with a [Control] child and scrollbar child ([HScrollbar], [VScrollBar], or both) will only draw the Control within the ScrollContainer area. Scrollbars will automatically be drawn at the right (for vertical) or bottom (for horizontal) and will enable dragging to move the viewable Control (and its children) within the ScrollContainer. Scrollbars will also automatically resize the grabber based on the minimum_size of the Control relative to the ScrollContainer. Works great with a [Panel] control. -- cgit v1.2.3