diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Makefile | 2 | ||||
| -rw-r--r-- | doc/base/classes.xml | 835 | ||||
| -rw-r--r-- | doc/tools/makerst.py | 475 |
3 files changed, 996 insertions, 316 deletions
diff --git a/doc/Makefile b/doc/Makefile index 286a5162af..d59c77063b 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -38,7 +38,7 @@ rst: rm -rf $(OUTPUTDIR)/rst mkdir -p $(OUTPUTDIR)/rst pushd $(OUTPUTDIR)/rst - echo "TODO" + python2 $(TOOLSDIR)/makerst.py $(CLASSES) popd textile: diff --git a/doc/base/classes.xml b/doc/base/classes.xml index 8128771b6a..1defac1cda 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<doc version="2.0.alpha.custom_build" name="Engine Types"> +<doc version="2.0.beta.custom_build" name="Engine Types"> <class name="@GDScript" category="Core"> <brief_description> Built-in GDScript functions. @@ -97,7 +97,7 @@ <argument index="1" name="y" type="float"> </argument> <description> - Arc-tangent that takes a 2D vector as argument, retuns the full -pi to +pi range. + Arc-tangent that takes a 2D vector as argument, returns the full -pi to +pi range. </description> </method> <method name="sqrt"> @@ -344,7 +344,7 @@ <argument index="0" name="rad" type="float"> </argument> <description> - Convert from radias to degrees. + Convert from radians to degrees. </description> </method> <method name="linear2db"> @@ -437,18 +437,16 @@ <argument index="1" name="type" type="int"> </argument> <description> - 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]. </description> </method> - <method name="str"> - <return type="String"> + <method name="typeof"> + <return type="int"> </return> <argument index="0" name="what" type="Variant"> </argument> - <argument index="1" name="..." type="Variant"> - </argument> <description> - 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]. </description> </method> <method name="str"> @@ -683,9 +681,9 @@ </member> <member name="PS2D" type="Physics2DServer"> </member> - <member name="SpatialSoundServer" type="SpatialSound2DServer"> + <member name="SpatialSoundServer" type="SpatialSoundServer"> </member> - <member name="SS" type="SpatialSound2DServer"> + <member name="SS" type="SpatialSoundServer"> </member> <member name="SpatialSound2DServer" type="SpatialSound2DServer"> </member> @@ -1249,6 +1247,10 @@ </constant> <constant name="BUTTON_WHEEL_DOWN" value="5"> </constant> + <constant name="BUTTON_WHEEL_LEFT" value="6"> + </constant> + <constant name="BUTTON_WHEEL_RIGHT" value="7"> + </constant> <constant name="BUTTON_MASK_LEFT" value="1"> </constant> <constant name="BUTTON_MASK_RIGHT" value="2"> @@ -1405,7 +1407,7 @@ <constant name="JOY_ANALOG_R2" value="7"> </constant> <constant name="OK" value="0"> - Functions that return [Error] return OK when everything went ok. Most functions don't return error anyway and/or just print errors to stdout. + Functions that return Error return OK when everything went ok. Most functions don't return error anyway and/or just print errors to stdout. </constant> <constant name="FAILED" value="1"> Generic fail return error. @@ -1547,6 +1549,22 @@ <constant name="PROPERTY_USAGE_DEFAULT" value="7"> Default usage (storage and editor). </constant> + <constant name="METHOD_FLAG_NORMAL" value="1"> + </constant> + <constant name="METHOD_FLAG_EDITOR" value="2"> + </constant> + <constant name="METHOD_FLAG_NOSCRIPT" value="4"> + </constant> + <constant name="METHOD_FLAG_CONST" value="8"> + </constant> + <constant name="METHOD_FLAG_REVERSE" value="16"> + </constant> + <constant name="METHOD_FLAG_VIRTUAL" value="32"> + </constant> + <constant name="METHOD_FLAG_FROM_SCRIPT" value="64"> + </constant> + <constant name="METHOD_FLAGS_DEFAULT" value="1"> + </constant> <constant name="TYPE_NIL" value="0"> Variable is of type nil (only applied for null). </constant> @@ -1762,7 +1780,7 @@ <argument index="0" name="with" type="AABB"> </argument> <description> - Return the intersection between two [AABB]s. An empty AABB (size 0,0,0) is returned on failure. + Return the intersection between two [AABB]. An empty AABB (size 0,0,0) is returned on failure. </description> </method> <method name="intersects"> @@ -1955,7 +1973,7 @@ <return type="bool"> </return> <description> - Return true when centered. See [set_centered]. + Return true when centered. See [method set_centered]. </description> </method> <method name="set_offset"> @@ -2083,7 +2101,8 @@ Contains data used to animate everything in the engine. </brief_description> <description> - An Animation resource contains data used to animate everything in the engine. Animations are divided into tracks, and each track must be linked to a node. The state of that node can be changed through time, by adding timed keys (events) to the track. [br] Animations are just data containers, and must be added to odes such as an [AnimationPlayer] or [AnimationTreePlayer] to be played back. + An Animation resource contains data used to animate everything in the engine. Animations are divided into tracks, and each track must be linked to a node. The state of that node can be changed through time, by adding timed keys (events) to the track. + Animations are just data containers, and must be added to odes such as an [AnimationPlayer] or [AnimationTreePlayer] to be played back. </description> <methods> <method name="add_track"> @@ -2094,7 +2113,7 @@ <argument index="1" name="at_pos" type="int" default="-1"> </argument> <description> - Add a track to the Animation. The track type must be specified as any of the values in te TYPE_* enumeration. + Add a track to the Animation. The track type must be specified as any of the values in the TYPE_* enumeration. </description> </method> <method name="remove_track"> @@ -2157,7 +2176,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Nove a track down. + Move a track down. </description> </method> <method name="transform_track_insert_key"> @@ -2327,7 +2346,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return wether interpolation is enabled or disabled for a whole track. By default tracks are interpolated. + Return whether interpolation is enabled or disabled for a whole track. By default tracks are interpolated. </description> </method> <method name="value_track_get_key_indices" qualifiers="const"> @@ -2403,7 +2422,7 @@ <return type="bool"> </return> <description> - Return wether the animation has the loop flag set. + Return whether the animation has the loop flag set. </description> </method> <method name="set_step"> @@ -2450,7 +2469,7 @@ Container and player of [Animation] resources. </brief_description> <description> - An animation player is used for general purpose playback of [Animation] resources. It contains a dictionary of animations (referenced by name) and custom blend times between their transitions. Additionally, animations can be played and blended in diferent channels. + An animation player is used for general purpose playback of [Animation] resources. It contains a dictionary of animations (referenced by name) and custom blend times between their transitions. Additionally, animations can be played and blended in different channels. </description> <methods> <method name="add_animation"> @@ -2486,7 +2505,7 @@ <argument index="0" name="name" type="String"> </argument> <description> - Request wether an [Animation] name exist within the player. + Request whether an [Animation] name exist within the player. </description> </method> <method name="get_animation" qualifiers="const"> @@ -2513,7 +2532,7 @@ <argument index="2" name="sec" type="float"> </argument> <description> - Specify a blend time (in seconds) between two animations, referemced by their names. + Specify a blend time (in seconds) between two animations, referenced by their names. </description> </method> <method name="get_blend_time" qualifiers="const"> @@ -2524,7 +2543,7 @@ <argument index="1" name="anim_to" type="String"> </argument> <description> - Get the blend time between two animations, referemced by their names. + Get the blend time between two animations, referenced by their names. </description> </method> <method name="set_default_blend_time"> @@ -2577,7 +2596,7 @@ <return type="bool"> </return> <description> - Return wether an animation is playing. + Return whether an animation is playing. </description> </method> <method name="set_current_animation"> @@ -2660,7 +2679,7 @@ <return type="NodePath"> </return> <description> - Return path to root node (see [set_root]). + Return path to root node (see [method set_root]). </description> </method> <method name="seek"> @@ -3795,7 +3814,7 @@ <argument index="3" name="area_shape" type="int"> </argument> <description> - This signal triggers only once when a body enters this area. The first parameter is the body's [RID]. The second one is the body as an object. The third one is the index of the shape of the body that entered this area, and the fourth one is the index of the shape in this area that repored the entering. + This signal triggers only once when a body enters this area. The first parameter is the body's [RID]. The second one is the body as an object. The third one is the index of the shape of the body that entered this area, and the fourth one is the index of the shape in this area that reported the entering. </description> </signal> <signal name="area_enter"> @@ -3893,7 +3912,7 @@ <argument index="0" name="value" type="var"> </argument> <description> - Remove the first occurence of a value from the array. + Remove the first occurrence of a value from the array. </description> </method> <method name="find"> @@ -4175,7 +4194,7 @@ <argument index="1" name="data" type="RealArray"> </argument> <description> - Set the sample data for a given sample as an array of floats. The length must be equal to the sample lenght or an error will be produced. + Set the sample data for a given sample as an array of floats. The length must be equal to the sample length or an error will be produced. For this method, a stereo sample is made from two samples. Thus, in case of a stereo sample, the array length must be twice the length returned by [method sample_get_length]. Trying to alter a SAMPLE_FORMAT_IMA_ADPCM sample is not supported. It will throw an error to the console, but will not alter the sample data. </description> @@ -4186,7 +4205,7 @@ <argument index="1" name="data" type="RawArray"> </argument> <description> - Set the sample data for a given sample as an array of bytes. The length must be equal to the sample lenght expected in bytes or an error will be produced. The byte length can be calculated as follows: + Set the sample data for a given sample as an array of bytes. The length must be equal to the sample length expected in bytes or an error will be produced. The byte length can be calculated as follows: Get the sample length ([method get_sample_length]). If the sample format is SAMPLE_FORMAT_PCM16, multiply it by 2. If the sample format is SAMPLE_FORMAT_IMA_ADPCM, divide it by 2 (rounding any fraction up), then add 4. @@ -4362,7 +4381,7 @@ <argument index="1" name="enabled" type="bool"> </argument> <description> - Set wether a given voice is positional. This is only interpreted as a hint and used for backends that may support binaural encoding. + Set whether a given voice is positional. This is only interpreted as a hint and used for backends that may support binaural encoding. </description> </method> <method name="voice_get_volume" qualifiers="const"> @@ -4470,7 +4489,7 @@ <argument index="0" name="voice" type="RID"> </argument> <description> - Return wether the current voice is positional. See [method voice_set_positional]. + Return whether the current voice is positional. See [method voice_set_positional]. </description> </method> <method name="voice_stop"> @@ -4599,7 +4618,7 @@ Base class for audio streams. </brief_description> <description> - Base class for audio streams. Audio streams are used for music playback, or other types of streamed sounds that don't fit or requiere more flexibility than a [Sample]. + Base class for audio streams. Audio streams are used for music playback, or other types of streamed sounds that don't fit or require more flexibility than a [Sample]. </description> <methods> </methods> @@ -5147,7 +5166,7 @@ Provides a base class for different kinds of buttons. </brief_description> <description> - BaseButton is the abstract base class for buttons, so it shouldn't be used directly (It doesnt display anything). Other types of buttons inherit from it. + BaseButton is the abstract base class for buttons, so it shouldn't be used directly (It doesn't display anything). Other types of buttons inherit from it. </description> <methods> <method name="_pressed" qualifiers="virtual"> @@ -5205,14 +5224,14 @@ <return type="bool"> </return> <description> - Return wether the button is in disabled state (see [method set_disabled]). + Return whether the button is in disabled state (see [method set_disabled]). </description> </method> <method name="set_click_on_press"> <argument index="0" name="enable" type="bool"> </argument> <description> - Set the button click_on_press mode. This mode generates click events when a mousebutton or key is just pressed (by default events are generated when the button/keys are released and both press and release occur in the visual area of the Button). + Set the button click_on_press mode. This mode generates click events when a mouse button or key is just pressed (by default events are generated when the button/keys are released and both press and release occur in the visual area of the Button). </description> </method> <method name="get_click_on_press" qualifiers="const"> @@ -5226,7 +5245,7 @@ <return type="int"> </return> <description> - Return the visual state used to draw the button. This is useful mainly when implementing your own draw code by either overiding _draw() or connecting to "draw" signal. The visual state of the button is defined by the DRAW_* enum. + Return the visual state used to draw the button. This is useful mainly when implementing your own draw code by either overriding _draw() or connecting to "draw" signal. The visual state of the button is defined by the DRAW_* enum. </description> </method> </methods> @@ -5421,7 +5440,7 @@ <argument index="0" name="enabled" type="bool"> </argument> <description> - Set the [i]flat[/i] property of a Button. Flat buttons don't display decoration unless hoevered or pressed. + Set the [i]flat[/i] property of a Button. Flat buttons don't display decoration unless hovered or pressed. </description> </method> <method name="set_clip_text"> @@ -5490,7 +5509,7 @@ Array of Buttons. </brief_description> <description> - Array of Buttons. A Button array is useful to have an array of buttons laid out vertically or horizontally. Only one can be selected. This is useful for joypad based interfaces and option menus. + Array of Buttons. A Button array is useful to have an array of buttons laid out vertically or horizontally. Only one can be selected. This is useful for joy pad based interfaces and option menus. </description> <methods> <method name="add_button"> @@ -5568,7 +5587,7 @@ <argument index="0" name="button" type="int"> </argument> <description> - Sekect a button in the array. + Select a button in the array. </description> </method> <method name="erase_button"> @@ -5595,7 +5614,7 @@ </signals> <constants> <constant name="ALIGN_BEGIN" value="0"> - Align buttons at the begining. + Align buttons at the beginning. </constant> <constant name="ALIGN_CENTER" value="1"> Align buttons in the middle. @@ -5616,7 +5635,7 @@ Group of Buttons. </brief_description> <description> - Group of [Button]s. All direct and indirect children buttons become radios. Only one allows being pressed. + Group of [Button]. All direct and indirect children buttons become radios. Only one allows being pressed. </description> <methods> <method name="get_pressed_button" qualifiers="const"> @@ -5702,7 +5721,7 @@ <argument index="0" name="world_point" type="Vector3"> </argument> <description> - Return how a 3D point in worldpsace maps to a 2D coordinate in the [Viewport] rectangle. + Return how a 3D point in worldspace maps to a 2D coordinate in the [Viewport] rectangle. </description> </method> <method name="is_position_behind" qualifiers="const"> @@ -5756,7 +5775,7 @@ <return type="bool"> </return> <description> - Return wether the Camera is the current one in the [Viewport], or plans to become current (if outside the scene tree). + Return whether the Camera is the current one in the [Viewport], or plans to become current (if outside the scene tree). </description> </method> <method name="get_camera_transform" qualifiers="const"> @@ -5906,7 +5925,7 @@ <return type="bool"> </return> <description> - Return true of this is the current camera (see [method Camera2D.make_current]). + Return true of this is the current camera (see [method make_current]). </description> </method> <method name="set_limit"> @@ -6061,7 +6080,7 @@ </brief_description> <description> Base class of anything 2D. Canvas items are laid out in a tree and children inherit and extend the transform of their parent. CanvasItem is extended by [Control], for anything GUI related, and by [Node2D] for anything 2D engine related. - Any CanvasItem can draw. For this, the "update" function must be called, then NOTIFICATION_DRAW will be received on idle time to request redraw. Because of this, canvas items don't need to be redraw on every frame, improving the performance significan'tly. Several functions for drawing on the CanvasItem are provided (see draw_* functions). They can only be used inside the notification, signal or _draw() overrided function, though. + Any CanvasItem can draw. For this, the "update" function must be called, then NOTIFICATION_DRAW will be received on idle time to request redraw. Because of this, canvas items don't need to be redraw on every frame, improving the performance significan'tly. Several functions for drawing on the CanvasItem are provided (see draw_* functions). They can only be used inside the notification, signal or _draw() overrides function, though. Canvas items are draw in tree order. By default, children are on top of their parents so a root CanvasItem will be drawn behind everything (this can be changed per item though). Canvas items can also be hidden (hiding also their subtree). They provide many means for changing standard parameters such as opacity (for it and the subtree) and self opacity, blend mode. Ultimately, a transform notification can be requested, which will notify the node that its global position changed in case the parent tree changed. @@ -6076,7 +6095,7 @@ <argument index="0" name="state" type="var"> </argument> <description> - Used for editing, returns an opaque value represeting the transform state. + Used for editing, returns an opaque value representing the transform state. </description> </method> <method name="edit_get" qualifiers="const"> @@ -6156,7 +6175,7 @@ <return type="bool"> </return> <description> - Return if set as toplevel. See [method set_as_toplevel]/ + Return if set as toplevel. See [method set_as_toplevel]. </description> </method> <method name="set_blend_mode"> @@ -6490,7 +6509,7 @@ <signals> <signal name="item_rect_changed"> <description> - Emitted when the intem rect has changed. + Emitted when the item rect has changed. </description> </signal> <signal name="draw"> @@ -6779,7 +6798,7 @@ Capsule 2D shape resource for physics. </brief_description> <description> - Capsule 2D shape resource for physics. A capsule (or sometimes called "pill") is like a line grown in all directions. It has a radius and a height, and is often useful for modelling biped characters. + Capsule 2D shape resource for physics. A capsule (or sometimes called "pill") is like a line grown in all directions. It has a radius and a height, and is often useful for modeling biped characters. </description> <methods> <method name="set_radius"> @@ -6929,7 +6948,7 @@ Circular Shape for 2D Physics. </brief_description> <description> - Circular Shape for 2D Physics. This shape is useful for modelling balls or small characters and it's collision detection with everything else is very fast. + Circular Shape for 2D Physics. This shape is useful for modeling balls or small characters and it's collision detection with everything else is very fast. </description> <methods> <method name="set_radius"> @@ -7320,7 +7339,7 @@ </argument> <description> Set the array of points forming the polygon. - When editing the point list via the editor, depending on [method get_build_mode], it has to be a list of points (for [code]build_mode[/code]=0), or a list of lines (for [code]build_mode[/code]=1). In the second case, the even elements of the array define the start point of the line, and the odd elements the end point. + When editing the point list via the editor, depending on [method get_build_mode], it has to be a list of points (for [code]build_mode==0[/code]), or a list of lines (for [code]build_mode==1[/code]). In the second case, the even elements of the array define the start point of the line, and the odd elements the end point. </description> </method> <method name="get_polygon" qualifiers="const"> @@ -7334,14 +7353,14 @@ <argument index="0" name="build_mode" type="int"> </argument> <description> - Set whether the polygon is to be a [ConvexPolygon2D] ([code]build_mode[/code]=0), or a [ConcavePolygon2D] ([code]build_mode[/code]=1). + Set whether the polygon is to be a [ConvexPolygon2D] ([code]build_mode==0[/code]), or a [ConcavePolygon2D] ([code]build_mode==1[/code]). </description> </method> <method name="get_build_mode" qualifiers="const"> <return type="int"> </return> <description> - Return whether the polygon is a [ConvexPolygon2D] ([code]build_mode[/code]=0), or a [ConcavePolygon2D] ([code]build_mode[/code]=1). + Return whether the polygon is a [ConvexPolygon2D] ([code]build_mode==0[/code]), or a [ConcavePolygon2D] ([code]build_mode==1[/code]). </description> </method> <method name="set_trigger"> @@ -7363,7 +7382,7 @@ </return> <description> Return the index of the first shape generated by the editor. - When [code]build_mode[/code] is set to generate convex polygons, the shape shown in the editor may be decomopsed into many convex polygons. In that case, a range of indexes is needed to directly access the [Shape2D]s. + When [code]build_mode[/code] is set to generate convex polygons, the shape shown in the editor may be decomposed into many convex polygons. In that case, a range of indexes is needed to directly access the [Shape2D]. When [code]build_mode[/code] is set to generate concave polygons, there is only one [Shape2D] generated, so the start index and the end index are the same. </description> </method> @@ -7527,7 +7546,7 @@ <return type="int"> </return> <description> - Convert the color to a 32 its integer (each byte represets a RGBA). + Convert the color to a 32 its integer (each byte represents a RGBA). </description> </method> <method name="to_ARGB32"> @@ -7628,15 +7647,6 @@ Array of Color, can only contains colors. Optimized for memory usage, can't fragment the memory. </description> <methods> - <method name="get"> - <return type="Color"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <description> - Get an index in the array. - </description> - </method> <method name="push_back"> <argument index="0" name="color" type="Color"> </argument> @@ -7680,7 +7690,7 @@ <constants> </constants> </class> -<class name="ColorPicker" inherits="HBoxContainer" category="Core"> +<class name="ColorPicker" inherits="BoxContainer" category="Core"> <brief_description> Color picker control. </brief_description> @@ -7702,14 +7712,14 @@ Return the current (edited) color. </description> </method> - <method name="set_mode"> - <argument index="0" name="mode" type="int"> + <method name="set_raw_mode"> + <argument index="0" name="mode" type="bool"> </argument> <description> </description> </method> - <method name="get_mode" qualifiers="const"> - <return type="int"> + <method name="is_raw_mode" qualifiers="const"> + <return type="bool"> </return> <description> </description> @@ -7726,6 +7736,12 @@ <description> </description> </method> + <method name="add_preset"> + <argument index="0" name="arg0" type="Color"> + </argument> + <description> + </description> + </method> </methods> <signals> <signal name="color_changed"> @@ -7749,6 +7765,10 @@ </theme_item> <theme_item name="hseparator" type="int"> </theme_item> + <theme_item name="add_preset" type="Texture"> + </theme_item> + <theme_item name="screen_picker" type="Texture"> + </theme_item> </theme_items> </class> <class name="ColorPickerButton" inherits="Button" category="Core"> @@ -8085,7 +8105,7 @@ Dialog for confirmation of actions. </brief_description> <description> - Dialog for confirmation of actions. This dialog inherits from [AcceptDialog], but has by default an OK and Cancel buton (in host OS order). + Dialog for confirmation of actions. This dialog inherits from [AcceptDialog], but has by default an OK and Cancel button (in host OS order). </description> <methods> <method name="get_cancel"> @@ -8104,8 +8124,8 @@ Base node for containers. </brief_description> <description> - Base node for conainers. A [Container] contains other controls and automatically arranges them in a certain way. - A Control can inherit this to reate custom container classes. + Base node for containers. A [Container] contains other controls and automatically arranges them in a certain way. + A Control can inherit this to create custom container classes. </description> <methods> <method name="queue_sort"> @@ -8126,7 +8146,7 @@ <signals> <signal name="sort_children"> <description> - Enmitted when sorting the children is needed. + Emitted when sorting the children is needed. </description> </signal> </signals> @@ -8144,7 +8164,7 @@ Control is the base class Node for all the GUI components. Every GUI component inherits from it, directly or indirectly. In this way, sections of the scene tree made of contiguous control nodes, become user interfaces. Controls are relative to the parent position and size by using anchors and margins. This ensures that they can adapt easily in most situation to changing dialog and screen sizes. When more flexibility is desired, [Container] derived nodes can be used. Anchors work by defining which margin do they follow, and a value relative to it. Allowed anchoring modes are ANCHOR_BEGIN, where the margin is relative to the top or left margins of the parent (in pixels), ANCHOR_END for the right and bottom margins of the parent and ANCHOR_RATIO, which is a ratio from 0 to 1 in the parent range. - Input device events ([InputEvent]) are first sent to the root controls via the [method Node._input], which distribute it through the tree, then delivers them to the adequate one (under cursor or keyboard focus based) by calling [Node._input_event]. There is no need to enable input processing on controls to receive such events. To ensure that no one else will receive the event (not even [method Node._unhandled_input]), the control can accept it by calling [method accept_event]. + Input device events ([InputEvent]) are first sent to the root controls via the [method Node._input], which distribute it through the tree, then delivers them to the adequate one (under cursor or keyboard focus based) by calling [method Node._input_event]. There is no need to enable input processing on controls to receive such events. To ensure that no one else will receive the event (not even [method Node._unhandled_input]), the control can accept it by calling [method accept_event]. Only one control can hold the keyboard focus (receiving keyboard events), for that the control must define the focus mode with [method set_focus_mode]. Focus is lost when another control gains it, or the current focus owner is hidden. It is sometimes desired for a control to ignore mouse/pointer events. This is often the case when placing other controls on top of a button, in such cases. Calling [method set_ignore_mouse] enables this function. Finally, controls are skinned according to a [Theme]. Setting a [Theme] on a control will propagate all the skinning down the tree. Optionally, skinning can be overrided per each control by calling the add_*_override functions, or from the editor. @@ -8208,27 +8228,13 @@ <description> </description> </method> - <method name="is_window" qualifiers="const"> - <return type="bool"> - </return> - <description> - Return wether this control is a [i]window[/i]. Controls are considered windows when their parent [Node] is not a Control. - </description> - </method> - <method name="get_window" qualifiers="const"> - <return type="Object"> - </return> - <description> - Return the [i]window[/i] for this control, ascending the scene tree (see [method is_window]). - </description> - </method> <method name="set_anchor"> <argument index="0" name="margin" type="int"> </argument> <argument index="1" name="anchor_mode" type="int"> </argument> <description> - Change the anchor (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) type for a margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). Changing the anchor mode converts the current margin offset from the previos anchor mode to the new one, so margin offsets ([method set_margin]) must be done after setting anchors, or at the same time ([method set_anchor_and_margin]). + Change the anchor (ANCHOR_BEGIN, ANCHOR_END, ANCHOR_RATIO) type for a margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). Changing the anchor mode converts the current margin offset from the previous anchor mode to the new one, so margin offsets ([method set_margin]) must be done after setting anchors, or at the same time ([method set_anchor_and_margin]). </description> </method> <method name="get_anchor" qualifiers="const"> @@ -8339,7 +8345,7 @@ <return type="Vector2"> </return> <description> - Returns the Control position, relative to the top-left corner of the parent Control and independly of the anchor mode. + Returns the Control position, relative to the top-left corner of the parent Control and independent of the anchor mode. </description> </method> <method name="get_size" qualifiers="const"> @@ -8384,21 +8390,21 @@ <return type="Rect2"> </return> <description> - Return position and size of the Control, relative to the top-left corner of the parent Control. This is a helper (see [method get_pos],[method get_size]). + Return position and size of the Control, relative to the top-left corner of the parent Control. This is a helper (see [method get_pos], [method get_size]). </description> </method> <method name="get_global_rect" qualifiers="const"> <return type="Rect2"> </return> <description> - Return position and size of the Control, relative to the top-left corner of the [i]window[/i] Control. This is a helper (see [method get_global_pos],[method get_size]). + Return position and size of the Control, relative to the top-left corner of the [i]window[/i] Control. This is a helper (see [method get_global_pos], [method get_size]). </description> </method> <method name="set_area_as_parent_rect"> <argument index="0" name="margin" type="int" default="0"> </argument> <description> - Change all margins and anchors, so this Control always takes up the same area as the parent Control. This is a helper (see [method set_anchor],[method set_margin]). + Change all margins and anchors, so this Control always takes up the same area as the parent Control. This is a helper (see [method set_anchor], [method set_margin]). </description> </method> <method name="show_modal"> @@ -8419,7 +8425,7 @@ <return type="bool"> </return> <description> - Return wether the Control is the current focused control (see [method set_focus_mode]). + Return whether the Control is the current focused control (see [method set_focus_mode]). </description> </method> <method name="grab_focus"> @@ -8504,6 +8510,14 @@ Override a single icon ([Texture]) in the theme of this Control. If texture is empty, override is cleared. </description> </method> + <method name="add_shader_override"> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="shader" type="Shader"> + </argument> + <description> + </description> + </method> <method name="add_style_override"> <argument index="0" name="name" type="String"> </argument> @@ -8741,6 +8755,10 @@ Emitted when an input event is received. Connecting in realtime is recommended for accepting the events. </description> </signal> + <signal name="modal_close"> + <description> + </description> + </signal> <signal name="mouse_exit"> <description> Emitted when the mouse left the control area. @@ -9221,7 +9239,7 @@ If "atpos" is given, the point is inserted before the point number "atpos", movi </argument> <description> Sets the tilt angle in radians for the point "idx". If the index is out of bounds, the function sends an error to the console. -The tilt controls the rotation along the look-at axis an object travelling the path would have. In the case of a curve controlling a [PathFollow], this tilt is an offset over the natural tilt the PathFollow calculates. +The tilt controls the rotation along the look-at axis an object traveling the path would have. In the case of a curve controlling a [PathFollow], this tilt is an offset over the natural tilt the PathFollow calculates. </description> </method> <method name="get_point_tilt" qualifiers="const"> @@ -10315,7 +10333,7 @@ This approximation makes straight segments between each point, then subdivides t </argument> <description> Set the playback volume for this player. This is a float between 0.0 (silent) and 1.0 (full volume). Values over 1.0 may amplify sound even more, but may introduce distortion. Negative values may just invert the output waveform, which produces no audible difference. - The effect of these special values uiltimately depends on the low-level implementation of the file format being played. + The effect of these special values ultimately depends on the low-level implementation of the file format being played. </description> </method> <method name="get_volume" qualifiers="const"> @@ -10357,7 +10375,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="db" type="float"> </argument> <description> - Set the playback volume for this player, in decibels. This is a float between -80.0 (silent) and 0.0 (full volume). Values under -79.0 get truncated to -80, but values over 0.0 do not, so the warnings for overamplifying (see [set_volume]) still apply. + Set the playback volume for this player, in decibels. This is a float between -80.0 (silent) and 0.0 (full volume). Values under -79.0 get truncated to -80, but values over 0.0 do not, so the warnings for over amplifying (see [method set_volume]) still apply. </description> </method> <method name="get_volume_db" qualifiers="const"> @@ -10422,7 +10440,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="1" name="channel_volume" type="float"> </argument> <description> - Set the volume scale for an individual channel of the stream, with the same value range as [methid set_volume]. The channel number depends on the stream format. For example, MIDIs range from 0 to 15, and MODs from 0 to 63. + Set the volume scale for an individual channel of the stream, with the same value range as [method set_volume]. The channel number depends on the stream format. For example, MIDIs range from 0 to 15, and MODs from 0 to 63. Many stream formats are multichannel, so this allows to affect only a part of the music. </description> </method> @@ -10466,10 +10484,10 @@ This approximation makes straight segments between each point, then subdivides t Driver for MOD playback. </brief_description> <description> - This driver plays MOD music. MOD music, as all event-based streams, is a music format defined by note events ocurring at defined moments, instead of a stream of audio samples. + This driver plays MOD music. MOD music, as all event-based streams, is a music format defined by note events occurring at defined moments, instead of a stream of audio samples. Currently, this driver supports the MOD, S3M, IT, and XM formats. This class exposes no methods. - This class can return its playback positon in seconds, but does not allow to set it, failing with only a console warning. + This class can return its playback position in seconds, but does not allow to set it, failing with only a console warning. This class can not return its song length, returning 1.0 when queried. This class does not limit its volume settings, allowing for overflow/distortion and wave inversion. </description> @@ -10645,6 +10663,8 @@ This approximation makes straight segments between each point, then subdivides t <method name="get_csv_line" qualifiers="const"> <return type="StringArray"> </return> + <argument index="0" name="delim" type="String" default="",""> + </argument> <description> </description> </method> @@ -10742,6 +10762,8 @@ This approximation makes straight segments between each point, then subdivides t </constant> <constant name="READ_WRITE" value="3"> </constant> + <constant name="WRITE_READ" value="7"> + </constant> </constants> </class> <class name="FileDialog" inherits="ConfirmationDialog" category="Core"> @@ -10907,7 +10929,7 @@ This approximation makes straight segments between each point, then subdivides t Simple Material with a fixed parameter set. </brief_description> <description> - FixedMaterial is a simple type of material [Resource], which contains a fixed amount of paramters. 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. + FixedMaterial 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. </description> <methods> <method name="set_parameter"> @@ -11231,7 +11253,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="4" name="clip_w" type="int" default="-1"> </argument> <description> - Draw "string" into a canvas item using the font at a given "pos" position, with "modulate" color, and optionally clipping the width. "pos" specifies te baseline, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis. + 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. </description> </method> <method name="draw_char" qualifiers="const"> @@ -11248,7 +11270,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="4" name="modulate" type="Color" default="Color(1,1,1,1)"> </argument> <description> - Draw character "char" into a canvas item using the font at a given "pos" position, with "modulate" color, and optionally kerning if "next" is apassed. clipping the width. "pos" specifies te 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. + Draw character "char" into a canvas item using the font at a given "pos" position, with "modulate" color, and optionally kerning if "next" is apassed. 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. </description> </method> <method name="set_fallback"> @@ -11967,7 +11989,7 @@ This approximation makes straight segments between each point, then subdivides t </brief_description> <description> 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. + It is greatly advised to enable low processor usage mode (see [method OS.set_low_processor_usage_mode]) when using GraphEdits. </description> <methods> <method name="connect_node"> @@ -12020,6 +12042,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" } </description> </method> + <method name="get_scroll_ofs" qualifiers="const"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="set_zoom"> + <argument index="0" name="p_zoom" type="float"> + </argument> + <description> + </description> + </method> + <method name="get_zoom" qualifiers="const"> + <return type="float"> + </return> + <description> + </description> + </method> <method name="set_right_disconnects"> <argument index="0" name="enable" type="bool"> </argument> @@ -12133,7 +12173,7 @@ This approximation makes straight segments between each point, then subdivides t <argument index="0" name="idx" type="int"> </argument> <description> - Disable input and ouput slot whose index is 'idx'. + Disable input and output slot whose index is 'idx'. </description> </method> <method name="clear_all_slots"> @@ -12869,19 +12909,13 @@ verify_host will check the SSL identity of the host if set to true. <argument index="3" name="body" type="String" default=""""> </argument> <description> - Sends a request to the connected host. The url is the what is normally behind the hostname, i.e: -http://somehost.com/index.php -url would be "index.php" - -Headers are HTTP request headers - -To create a POST request with query strings to push to the server, do: -var fields = {"username" : "user", - "password" : "pass"} -var queryString = httpClient.query_string_from_dict(fields) -var headers = ["Content-Type: application/x-www-form-urlencoded", - "Content-Length: " + str(queryString.length())] -var result = httpClient.request(httpClient.METHOD_POST, "index.php", headers, queryString) + Sends a request to the connected host. The url is what is normally behind the hostname, i.e. in [code]http://somehost.com/index.php[/code], url would be "index.php". + Headers are HTTP request headers. + To create a POST request with query strings to push to the server, do:: + var fields = {"username" : "user", "password" : "pass"} + var queryString = httpClient.query_string_from_dict(fields) + var headers = ["Content-Type: application/x-www-form-urlencoded", "Content-Length: " + str(queryString.length())] + var result = httpClient.request(httpClient.METHOD_POST, "index.php", headers, queryString) </description> </method> <method name="send_body_text"> @@ -12988,12 +13022,10 @@ var result = httpClient.request(httpClient.METHOD_POST, "index.php", headers, qu <argument index="0" name="fields" type="Dictionary"> </argument> <description> - Generates a GET/POST application/x-www-form-urlencoded style query string from a provided dictionary. - -var fields = {"username": "user", "password": "pass"} -String queryString = httpClient.query_string_from_dict(fields) - -returns:= "username=user&password=pass" + Generates a GET/POST application/x-www-form-urlencoded style query string from a provided dictionary, e.g.:: + var fields = {"username": "user", "password": "pass"} + String queryString = httpClient.query_string_from_dict(fields) + returns:= "username=user&password=pass" </description> </method> </methods> @@ -13714,6 +13746,7 @@ returns:= "username=user&password=pass" <argument index="0" name="button" type="int"> </argument> <description> + Returns true or false depending on whether mouse button is pressed or not. You can pass BUTTON_*, which are pre-defined constants listed in [@Global Scope]. </description> </method> <method name="is_joy_button_pressed"> @@ -13724,7 +13757,7 @@ returns:= "username=user&password=pass" <argument index="1" name="button" type="int"> </argument> <description> - Returns true if the joystick button at the given index is currently pressed. Returns false otherwise. (see JOY_* constans in [InputEvent]) + Returns if the joystick button at the given index is currently pressed. (see JOY_* constants in [@Global Scope]) </description> </method> <method name="is_action_pressed"> @@ -13757,7 +13790,7 @@ returns:= "username=user&password=pass" <argument index="0" name="device" type="int"> </argument> <description> - Returns true if the specified device is known by the system. This means that it sets all button and axis indices exactly as defined in [InputEvent]. Unknown joysticks are not expected to match these constants, but you can still retrieve events from them. + Returns if the specified device is known by the system. This means that it sets all button and axis indices exactly as defined in the JOY_* constants (see [@Global Scope]). Unknown joysticks are not expected to match these constants, but you can still retrieve events from them. </description> </method> <method name="get_joy_axis"> @@ -13768,7 +13801,7 @@ returns:= "username=user&password=pass" <argument index="1" name="axis" type="int"> </argument> <description> - Returns the current value of the joystick axis at given index (see JOY_* enum in [InputEvent]) + Returns the current value of the joystick axis at given index (see JOY_* constants in [@Global Scope]) </description> </method> <method name="get_joy_name"> @@ -13853,6 +13886,7 @@ returns:= "username=user&password=pass" <argument index="1" name="connected" type="bool"> </argument> <description> + Emitted when a joystick device has been connected or disconnected </description> </signal> </signals> @@ -13953,7 +13987,7 @@ returns:= "username=user&password=pass" Mouse button event. </constant> <constant name="JOYSTICK_MOTION" value="4"> - Jostick motion event. + Joystick motion event. </constant> <constant name="JOYSTICK_BUTTON" value="5"> Joystick button event. @@ -14850,15 +14884,6 @@ returns:= "username=user&password=pass" Integer Array. Array of integers. Can only contain integers. Optimized for memory usage, can't fragment the memory. </description> <methods> - <method name="get"> - <return type="int"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <description> - Get an index in the array. - </description> - </method> <method name="push_back"> <argument index="0" name="integer" type="int"> </argument> @@ -15618,7 +15643,7 @@ returns:= "username=user&password=pass" <return type="Variant"> </return> <description> - Return the metadata of the shape that collided with this body. If there is no collision, it will return 0, so collisions must be checked first with [method is_colliding]. Aditionally, this metadata can not be set with [method Object.set_meta], it must be set with [method Physics2DServer.body_set_shape_metadata]. + Return the metadata of the shape that collided with this body. If there is no collision, it will return 0, so collisions must be checked first with [method is_colliding]. Additionally, this metadata can not be set with [method Object.set_meta], it must be set with [method Physics2DServer.body_set_shape_metadata]. </description> </method> <method name="set_collision_margin"> @@ -17153,7 +17178,7 @@ returns:= "username=user&password=pass" Special button that brings up a [PopupMenu] when clicked. </brief_description> <description> - Special button that brings up a [PopupMenu] when clicked. That's pretty much all it does, as it's just a helper class when bulding GUIs. + Special button that brings up a [PopupMenu] when clicked. That's pretty much all it does, as it's just a helper class when building GUIs. </description> <methods> <method name="get_popup"> @@ -17202,7 +17227,7 @@ returns:= "username=user&password=pass" A [Resource] that contains vertex-array based geometry. </brief_description> <description> - Mesh is a type of [Resource] that contains vertex-array based geometry, divided in [i]surfaces[/i]. Each surface contains a completely separate array and a material used to draw it. Design wise, a mesh with multiple surfaces is prefered to a single surface, because objects created in 3D editing software commonly contain multiple materials. + Mesh is a type of [Resource] that contains vertex-array based geometry, divided in [i]surfaces[/i]. Each surface contains a completely separate array and a material used to draw it. Design wise, a mesh with multiple surfaces is preferred to a single surface, because objects created in 3D editing software commonly contain multiple materials. </description> <methods> <method name="add_morph_target"> @@ -17369,22 +17394,22 @@ returns:= "username=user&password=pass" Amount of weights/bone indices per vertex (always 4). </constant> <constant name="ARRAY_VERTEX" value="0"> - Vertex array (array of [Vector3]() vertices). + Vertex array (array of [Vector3] vertices). </constant> <constant name="ARRAY_NORMAL" value="1"> - Normal array (array of [Vector3]() normals). + Normal array (array of [Vector3] normals). </constant> <constant name="ARRAY_TANGENT" value="2"> Tangent array, array of groups of 4 floats. first 3 floats determine the tangent, and the last the binormal direction as -1 or 1. </constant> <constant name="ARRAY_COLOR" value="3"> - Vertex array (array of [Color]() colors). + Vertex array (array of [Color] colors). </constant> <constant name="ARRAY_TEX_UV" value="4"> - UV array (array of [Vector3]() UVs or float array of groups of 2 floats (u,v)). + UV array (array of [Vector3] UVs or float array of groups of 2 floats (u,v)). </constant> <constant name="ARRAY_TEX_UV2" value="5"> - Second UV array (array of [Vector3]() UVs or float array of groups of 2 floats (u,v)). + Second UV array (array of [Vector3] UVs or float array of groups of 2 floats (u,v)). </constant> <constant name="ARRAY_BONES" value="6"> Array of bone indices, as a float array. Each element in groups of 4 floats. @@ -17750,7 +17775,7 @@ returns:= "username=user&password=pass" Node that instances meshes into a [Scenario]. </brief_description> <description> - MeshInstance is a [Node] that takes a [Mesh] resource and adds it to the current [Scenario] by creating an instance of it. This is the class most often used to get 3D geometry rendered and can be used to instance a sigle [Mesh] in many places. This allows to reuse geometry and save on resources. When a [Mesh] has to be instanced more than thousands of times at close proximity, consider using a [MultiMesh] in a [MultiMeshInstance] instead. + MeshInstance is a [Node] that takes a [Mesh] resource and adds it to the current [Scenario] by creating an instance of it. This is the class most often used to get 3D geometry rendered and can be used to instance a single [Mesh] in many places. This allows to reuse geometry and save on resources. When a [Mesh] has to be instanced more than thousands of times at close proximity, consider using a [MultiMesh] in a [MultiMeshInstance] instead. </description> <methods> <method name="set_mesh"> @@ -17898,11 +17923,12 @@ returns:= "username=user&password=pass" </class> <class name="MultiMesh" inherits="Resource" category="Core"> <brief_description> - Provides high perfomance mesh instancing. + Provides high performance mesh instancing. </brief_description> <description> MultiMesh provides low level mesh instancing. If the amount of [Mesh] instances needed goes from hundreds to thousands (and most need to be visible at close proximity) creating such a large amount of [MeshInstance] nodes may affect performance by using too much CPU or video memory. - For this case a MultiMesh becomes very useful, as it can draw thousands of instances with little API overhead.[br] As a drawback, if the instances are too far away of each other, performance may be reduced as every sigle instance will always rendered (they are spatially indexed as one, for the whole object). + For this case a MultiMesh becomes very useful, as it can draw thousands of instances with little API overhead. + As a drawback, if the instances are too far away of each other, performance may be reduced as every single instance will always rendered (they are spatially indexed as one, for the whole object). Since instances may have any behavior, the AABB used for visibility must be provided by the user, or generated with [method generate_aabb]. </description> <methods> @@ -17924,14 +17950,14 @@ returns:= "username=user&password=pass" <argument index="0" name="count" type="int"> </argument> <description> - Set the amount of instnces that is going to be drawn. Changing this number will erase all the existing instance transform and color data. + Set the amount of instances that is going to be drawn. Changing this number will erase all the existing instance transform and color data. </description> </method> <method name="get_instance_count" qualifiers="const"> <return type="int"> </return> <description> - Return the amount of instnces that is going to be drawn. + Return the amount of instances that is going to be drawn. </description> </method> <method name="set_instance_transform"> @@ -18598,12 +18624,12 @@ returns:= "username=user&password=pass" <description> Nodes can be set as children of other nodes, resulting in a tree arrangement. Any tree of nodes is called a "Scene". Scenes can be saved to disk, and then instanced into other scenes. This allows for very high flexibility in the architecture and data model of the projects. - [SceneMainLoop] contains the "active" tree of nodes, and a node becomes active (receinving NOTIFICATION_ENTER_SCENE) when added to that tree. - A node can contain any number of nodes as a children (but there is only one tree root) with the requirement that no two childrens with the same name can exist. + [SceneMainLoop] contains the "active" tree of nodes, and a node becomes active (receiving NOTIFICATION_ENTER_SCENE) when added to that tree. + A node can contain any number of nodes as a children (but there is only one tree root) with the requirement that no two children with the same name can exist. Nodes can, optionally, be added to groups. This makes it easy to reach a number of nodes from the code (for example an "enemies" group). Nodes can be set to "process" state, so they constantly receive a callback requesting them to process (do anything). Normal processing ([method _process]) happens as fast as possible and is dependent on the frame rate, so the processing time delta is variable. Fixed processing ([method _fixed_process]) happens a fixed amount of times per second (by default 60) and is useful to link itself to the physics. Nodes can also process input events. When set, the [method _input] function will be called with every input that the program receives. Since this is usually too overkill (unless used for simple projects), an [method _unhandled_input] function is called when the input was not handled by anyone else (usually, GUI [Control] nodes). - To keep track of the scene hieararchy (specially when instancing scenes into scenes) an "owner" can be set to a node. This keeps track of who instanced what. This is mostly useful when writing editors and tools, though. + To keep track of the scene hierarchy (specially when instancing scenes into scenes) an "owner" can be set to a node. This keeps track of who instanced what. This is mostly useful when writing editors and tools, though. Finally, when a node is freed, it will free all its children nodes too. </description> <methods> @@ -18803,7 +18829,7 @@ returns:= "username=user&password=pass" <return type="NodePath"> </return> <description> - Return the absolute path of the current node. This only works if the curent node is inside the scene tree (see [method is_inside_scene]). + Return the absolute path of the current node. This only works if the current node is inside the scene tree (see [method is_inside_scene]). </description> </method> <method name="get_path_to" qualifiers="const"> @@ -18845,7 +18871,7 @@ returns:= "username=user&password=pass" <argument index="1" name="to_pos" type="int"> </argument> <description> - Move a child node to a different position (order) amongst the other children. Since calls, signals, etc are performed by tree order, changing the order of chilren nodes may be useful. + Move a child node to a different position (order) amongst the other children. Since calls, signals, etc are performed by tree order, changing the order of children nodes may be useful. </description> </method> <method name="get_groups" qualifiers="const"> @@ -18875,7 +18901,7 @@ returns:= "username=user&password=pass" </method> <method name="remove_and_skip"> <description> - Remove a node and set all its children as childrens of the parent node (if exists). All even subscriptions that pass by the removed node will be unsubscribed. + Remove a node and set all its children as children of the parent node (if exists). All even subscriptions that pass by the removed node will be unsubscribed. </description> </method> <method name="get_index" qualifiers="const"> @@ -18887,7 +18913,7 @@ returns:= "username=user&password=pass" </method> <method name="print_tree"> <description> - Print the screne to stdout. Used mainly for debugging purposes. + Print the scene to stdout. Used mainly for debugging purposes. </description> </method> <method name="set_filename"> @@ -18908,21 +18934,21 @@ returns:= "username=user&password=pass" <argument index="0" name="what" type="int"> </argument> <description> - Notify the current node and all its chldren recursively by calling notification() in all of them. + Notify the current node and all its children recursively by calling notification() in all of them. </description> </method> <method name="set_fixed_process"> <argument index="0" name="enable" type="bool"> </argument> <description> - Enables or disables node fixed framerate processing. When a node is being processed, it will receive a NOTIFICATION_PROCESS at a fixed (usually 60fps, check [OS] to change that) interval (and the [method _fixed_process] callback will be called if exists). It is common to check how much time was elapsed since the previous frame by calling [method get_fixed_process_time]. + Enables or disables node fixed framerate processing. When a node is being processed, it will receive a NOTIFICATION_PROCESS at a fixed (usually 60 fps, check [OS] to change that) interval (and the [method _fixed_process] callback will be called if exists). It is common to check how much time was elapsed since the previous frame by calling [method get_fixed_process_time]. </description> </method> <method name="get_fixed_process_delta_time" qualifiers="const"> <return type="float"> </return> <description> - Return the time elapsed since the last fixed frame. This is always the same in fixed proecssing unless the frames per second is changed in [OS]. + Return the time elapsed since the last fixed frame. This is always the same in fixed processing unless the frames per second is changed in [OS]. </description> </method> <method name="is_fixed_processing" qualifiers="const"> @@ -18957,7 +18983,7 @@ returns:= "username=user&password=pass" <argument index="0" name="enable" type="bool"> </argument> <description> - Enable input processing for node. This is not requiered for GUI controls! It hooks up the node to receive all input (see [method _input]). + Enable input processing for node. This is not required for GUI controls! It hooks up the node to receive all input (see [method _input]). </description> </method> <method name="is_processing_input" qualifiers="const"> @@ -18971,7 +18997,7 @@ returns:= "username=user&password=pass" <argument index="0" name="enable" type="bool"> </argument> <description> - Enable unhandled input processing for node. This is not requiered for GUI controls! It hooks up the node to receive all input that was not previously handled before (usually by a [Control]). (see [method _unhandled_input]). + Enable unhandled input processing for node. This is not required for GUI controls! It hooks up the node to receive all input that was not previously handled before (usually by a [Control]). (see [method _unhandled_input]). </description> </method> <method name="is_processing_unhandled_input" qualifiers="const"> @@ -19122,7 +19148,7 @@ returns:= "username=user&password=pass" Base node for 2D system. </brief_description> <description> - Base node for 2D system. Node2D contains a position, rotation and scale, which is used to position and animate. It can alternatively be used with a custom 2D transform ([Matrix32]). A tree of Node2Ds allows complex hierachies for animation and positioning. + Base node for 2D system. Node2D contains a position, rotation and scale, which is used to position and animate. It can alternatively be used with a custom 2D transform ([Matrix32]). A tree of Node2Ds allows complex hierarchies for animation and positioning. </description> <methods> <method name="set_pos"> @@ -19702,7 +19728,7 @@ returns:= "username=user&password=pass" <argument index="0" name="environment" type="String"> </argument> <description> - Return true if an envieronment variable exists. + Return true if an environment variable exists. </description> </method> <method name="get_name" qualifiers="const"> @@ -19754,7 +19780,7 @@ returns:= "username=user&password=pass" <description> </description> </method> - <method name="get_system_time_msec" qualifiers="const"> + <method name="get_system_time_secs" qualifiers="const"> <return type="int"> </return> <description> @@ -19997,6 +20023,14 @@ returns:= "username=user&password=pass" <description> </description> </method> + <method name="set_thread_name"> + <return type="int"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> </methods> <constants> <constant name="DAY_SUNDAY" value="0"> @@ -20076,8 +20110,8 @@ returns:= "username=user&password=pass" <description> Base class for all non built-in types. Everything not a built-in type starts the inheritance chain from this class. Objects do not manage memory, if inheriting from one the object will most likely have to be deleted manually (call the [method free] function from the script or delete from C++). - Some derivates add memory management, such as [Reference] (which keps a reference count and deletes itself automatically when no longer referenced) and [Node], which deletes the children tree when deleted. - Objects export properties, which are mainly useful for storage and editing, but not really so much in programming. Properties are exported in [method _get_property_list] and handled in [method _get] and [_set]. However, scripting languages and C++ have simper means to export them. + Some derivates add memory management, such as [Reference] (which keeps a reference count and deletes itself automatically when no longer referenced) and [Node], which deletes the children tree when deleted. + Objects export properties, which are mainly useful for storage and editing, but not really so much in programming. Properties are exported in [method _get_property_list] and handled in [method _get] and [method _set]. However, scripting languages and C++ have simper means to export them. Objects also receive notifications ([method _notification]). Notifications are a simple way to notify the object about simple events, so they can all be handled together. </description> <methods> @@ -20092,7 +20126,7 @@ returns:= "username=user&password=pass" <return type="Array"> </return> <description> - Return the property list, array of dictionaries, dictionaries must countain: name:String, type:int (see TYPE_* enum in globals) and optionally: hint:int (see PROPERTY_HINT_* in globals), hint_string:String, usage:int (see PROPERTY_USAGE_* in globals). + Return the property list, array of dictionaries, dictionaries must contain: name:String, type:int (see TYPE_* enum in globals) and optionally: hint:int (see PROPERTY_HINT_* in globals), hint_string:String, usage:int (see PROPERTY_USAGE_* in globals). </description> </method> <method name="_init" qualifiers="virtual"> @@ -20132,7 +20166,7 @@ returns:= "username=user&password=pass" <argument index="0" name="type" type="String"> </argument> <description> - Check the type of the obeject against a string (including inheritance). + Check the type of the object against a string (including inheritance). </description> </method> <method name="set"> @@ -20155,7 +20189,7 @@ returns:= "username=user&password=pass" <return type="Array"> </return> <description> - Return the list of properties as an array of dictionaries, dictionaries countain: name:String, type:int (see TYPE_* enum in globals) and optionally: hint:int (see PROPERTY_HINT_* in globals), hint_string:String, usage:int (see PROPERTY_USAGE_* in globals). + Return the list of properties as an array of dictionaries, dictionaries contain: name:String, type:int (see TYPE_* enum in globals) and optionally: hint:int (see PROPERTY_HINT_* in globals), hint_string:String, usage:int (see PROPERTY_USAGE_* in globals). </description> </method> <method name="get_method_list" qualifiers="const"> @@ -20200,7 +20234,7 @@ returns:= "username=user&password=pass" <argument index="1" name="value" type="var"> </argument> <description> - Set a metadata into the object. Medatada is serialized. Metadata can be [i]anything[/i]. + Set a metadata into the object. Metadata is serialized. Metadata can be [i]anything[/i]. </description> </method> <method name="get_meta" qualifiers="const"> @@ -20223,7 +20257,7 @@ returns:= "username=user&password=pass" <return type="StringArray"> </return> <description> - Return the list of metadatas in the object. + Return the list of metadata in the object. </description> </method> <method name="add_user_signal"> @@ -20232,7 +20266,7 @@ returns:= "username=user&password=pass" <argument index="1" name="arguments" type="Array" default="Array()"> </argument> <description> - Add a user signal (can be added anytime). Arguments are optional, but can be added as an array of dictionaries, each containing "name" and "type" (from [@GlobalScope] TYPE_*). + Add a user signal (can be added anytime). Arguments are optional, but can be added as an array of dictionaries, each containing "name" and "type" (from [@Global Scope] TYPE_*). </description> </method> <method name="has_user_signal" qualifiers="const"> @@ -20513,7 +20547,7 @@ returns:= "username=user&password=pass" </class> <class name="OmniLight" inherits="Light" category="Core"> <brief_description> - OmniDirectional Light, such as a lightbulb or a candle. + OmniDirectional Light, such as a light bulb or a candle. </brief_description> <description> An OmniDirectional light is a type of [Light] node that emits lights in all directions. The light is attenuated through the distance and this attenuation can be configured by changing the energy, radius and attenuation parameters of [Light]. TODO: Image of an omnilight. @@ -20832,7 +20866,7 @@ returns:= "username=user&password=pass" <argument index="0" name="path" type="Node"> </argument> <description> - Pack will ignore any sub-nodes not owned by given node. See [Node.set_owner]. + Pack will ignore any sub-nodes not owned by given node. See [method Node.set_owner]. </description> </method> <method name="instance" qualifiers="const"> @@ -20849,6 +20883,12 @@ returns:= "username=user&password=pass" <description> </description> </method> + <method name="get_state"> + <return type="SceneState"> + </return> + <description> + </description> + </method> </methods> <constants> </constants> @@ -20858,7 +20898,7 @@ returns:= "username=user&password=pass" Abstraction and base class for packet-based protocols. </brief_description> <description> - PacketPeer is an abstration and base class for packet-based protocols (such as UDP). It provides an API for sending and receiving packets both as raw data or variables. This makes it easy to transfer data over a protocol, without having to encode data as low level bytes or having to worry about network ordering. + PacketPeer is an abstraction and base class for packet-based protocols (such as UDP). It provides an API for sending and receiving packets both as raw data or variables. This makes it easy to transfer data over a protocol, without having to encode data as low level bytes or having to worry about network ordering. </description> <methods> <method name="get_var" qualifiers="const"> @@ -20991,7 +21031,7 @@ returns:= "username=user&password=pass" Provides an opaque background for [Control] children. </brief_description> <description> - Panel is a [Control] that displays an opaque background. It's commoly used as a parent and container for other types of [Control] nodes. [center][img]images/panel_example.png[/img][/center] + Panel is a [Control] that displays an opaque background. It's commonly used as a parent and container for other types of [Control] nodes. [center][img]images/panel_example.png[/img][/center] </description> <methods> </methods> @@ -22211,7 +22251,7 @@ This method controls whether the position between two cached points is interpola Singleton containing the list of remapped resources. </brief_description> <description> - When exporting, the types of some resources may change internally so they are converted to more optimized versions. While it's not usually necesary to access to this directly (path remapping happens automatically when opeining a file), it's exported just for information. + When exporting, the types of some resources may change internally so they are converted to more optimized versions. While it's not usually necessary to access to this directly (path remapping happens automatically when opening a file), it's exported just for information. </description> <methods> <method name="add_remap"> @@ -22599,11 +22639,11 @@ This method controls whether the position between two cached points is interpola Intersect a ray in a given space, the returned object is a dictionary with the following fields: position: place where ray is stopped. normal: normal of the object at the point where the ray was stopped. - shape: shape index of the object agaisnt which the ray was stopped. - collider_: collider agaisnt which the ray was stopped. - collider_id: collider id of the object agaisnt which the ray was stopped. - collider: collider object agaisnt which the ray was stopped. - rid: [RID] of the object agaisnt which the ray was stopped. + shape: shape index of the object against which the ray was stopped. + collider_: collider against which the ray was stopped. + collider_id: collider id of the object against which the ray was stopped. + collider: collider object against which the ray was stopped. + rid: [RID] of the object against which the ray was stopped. If the ray did not intersect anything, then an empty dictionary (dir.empty()==true) is returned instead. </description> </method> @@ -25518,7 +25558,7 @@ This method controls whether the position between two cached points is interpola <argument index="1" name="epsilon" type="float" default="0.00001"> </argument> <description> - Returns true if "point" is inside the plane (by a very minimum treshold). + Returns true if "point" is inside the plane (by a very minimum threshold). </description> </method> <method name="intersect_3"> @@ -25867,14 +25907,14 @@ This method controls whether the position between two cached points is interpola Base container control for popups and dialogs. </brief_description> <description> - PopUp is a base [Control] used to show dialogs and popups. It's a subwindow and modal by default (see [Control]) and has helpers for custom popup behavior. + Popup is a base [Control] used to show dialogs and popups. It's a subwindow and modal by default (see [Control]) and has helpers for custom popup behavior. </description> <methods> <method name="popup_centered"> <argument index="0" name="size" type="Vector2" default="Vector2(0,0)"> </argument> <description> - Popup (show the control in modal form) in the center of the screen, at the curent size, or at a size determined by "size". + Popup (show the control in modal form) in the center of the screen, at the current size, or at a size determined by "size". </description> </method> <method name="popup_centered_ratio"> @@ -25955,7 +25995,7 @@ This method controls whether the position between two cached points is interpola <argument index="3" name="accel" type="int" default="0"> </argument> <description> - Add a new item with text "label" and icon "texture". An id can optonally be provided, as well as an accelerator. If no id is provided, one will be created from the index. + Add a new item with text "label" and icon "texture". An id can optionally be provided, as well as an accelerator. If no id is provided, one will be created from the index. </description> </method> <method name="add_item"> @@ -25966,7 +26006,7 @@ This method controls whether the position between two cached points is interpola <argument index="2" name="accel" type="int" default="0"> </argument> <description> - Add a new item with text "label". An id can optonally be provided, as well as an accelerator. If no id is provided, one will be created from the index. + Add a new item with text "label". An id can optionally be provided, as well as an accelerator. If no id is provided, one will be created from the index. </description> </method> <method name="add_icon_check_item"> @@ -25979,7 +26019,7 @@ This method controls whether the position between two cached points is interpola <argument index="3" name="accel" type="int" default="0"> </argument> <description> - Add a new checkable item with text "label" and icon "texture". An id can optonally be provided, as well as an accelerator. If no id is provided, one will be created from the index. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. + Add a new check able item with text "label" and icon "texture". An id can optionally be provided, as well as an accelerator. If no id is provided, one will be created from the index. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. </description> </method> <method name="add_check_item"> @@ -25990,7 +26030,7 @@ This method controls whether the position between two cached points is interpola <argument index="2" name="accel" type="int" default="0"> </argument> <description> - Add a new checkable item with text "label". An id can optonally be provided, as well as an accelerator. If no id is provided, one will be created from the index. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. + Add a new checkable item with text "label". An id can optionally be provided, as well as an accelerator. If no id is provided, one will be created from the index. Note that checkable items just display a checkmark, but don't have any built-in checking behavior and must be checked/unchecked manually. </description> </method> <method name="add_submenu_item"> @@ -26287,14 +26327,14 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="enable" type="bool"> </argument> <description> - Enable the portal (it is enabled by defaul though), disabling it will cause the parent [RoomInstance] to not be visible any longer when looking through the portal. + Enable the portal (it is enabled by default though), disabling it will cause the parent [RoomInstance] to not be visible any longer when looking through the portal. </description> </method> <method name="is_enabled" qualifiers="const"> <return type="bool"> </return> <description> - Return wether the portal is active. When disabled it causes the parent [RoomInstance] to not be visible any longer when looking through the portal. + Return whether the portal is active. When disabled it causes the parent [RoomInstance] to not be visible any longer when looking through the portal. </description> </method> <method name="set_disable_distance"> @@ -26550,7 +26590,7 @@ This method controls whether the position between two cached points is interpola <return type="Quat"> </return> <description> - Returns the inverse of the quaternion (applies to the inverse rotatio too). + Returns the inverse of the quaternion (applies to the inverse rotation too). </description> </method> <method name="length"> @@ -26835,14 +26875,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. </description> <methods> - <method name="get"> - <return type="int"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <description> - </description> - </method> <method name="get_string_from_ascii"> <return type="String"> </return> @@ -27028,7 +27060,7 @@ This method controls whether the position between two cached points is interpola <return type="Object"> </return> <description> - Return the closest object the ray is pointing to. Note that this does not consider the length of the vector, so you must also use [is_colliding] to check if the object returned is actually colliding with the ray. + Return the closest object the ray is pointing to. Note that this does not consider the length of the vector, so you must also use [method is_colliding] to check if the object returned is actually colliding with the ray. </description> </method> <method name="get_collider_shape" qualifiers="const"> @@ -27132,7 +27164,7 @@ This method controls whether the position between two cached points is interpola Ray 2D shape resource for physics. </brief_description> <description> - Ray 2D shape resource for physics. A ray is not really a collision body, isntead it tries to separate itself from whatever is touching its far endpoint. It's often useful for characters. + Ray 2D shape resource for physics. A ray is not really a collision body, instead it tries to separate itself from whatever is touching its far endpoint. It's often useful for characters. </description> <methods> <method name="set_length"> @@ -27161,14 +27193,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. </description> <methods> - <method name="get"> - <return type="float"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <description> - </description> - </method> <method name="push_back"> <argument index="0" name="value" type="float"> </argument> @@ -27335,7 +27359,7 @@ This method controls whether the position between two cached points is interpola Rectangle Shape for 2D Physics. </brief_description> <description> - Rectangle Shape for 2D Physics. This shape is useful for modelling box-like 2D objects. + Rectangle Shape for 2D Physics. This shape is useful for modeling box-like 2D objects. </description> <methods> <method name="set_extents"> @@ -27413,12 +27437,12 @@ This method controls whether the position between two cached points is interpola Currently supported features: Capturing [code]()[/code] and non-capturing [code](?:)[/code] groups Any character [code].[/code] - Shorthand caracter classes [code]\w \W \s \S \d \D[/code] + Shorthand character classes [code]\w \W \s \S \d \D[/code] User-defined character classes such as [code][A-Za-z][/code] Simple quantifiers [code]?[/code], [code]*[/code] and [code]+[/code] Range quantifiers [code]{x,y}[/code] Lazy (non-greedy) quantifiers [code]*?[/code] - Begining [code]^[/code] and end [code]$[/code] anchors + Beginning [code]^[/code] and end [code]$[/code] anchors Alternation [code]|[/code] Backreferences [code]\1[/code] and [code]\g{1}[/code] POSIX character classes [code][[:alnum:]][/code] @@ -27527,7 +27551,7 @@ This method controls whether the position between two cached points is interpola Base class for all resources. </brief_description> <description> - Resource is the base class for all resource types. Resources are primarily data containers. They are reference counted and freed when no longer in use. They are also loaded only once from disk, and further attempts to load the resource will return the same reference (all this in contrast to a [Node], which is not reference counted and can be instanced from disk as many times as desred). Resources can be saved externally on disk or bundled into another object, such as a [Node] or another resource. + Resource is the base class for all resource types. Resources are primarily data containers. They are reference counted and freed when no longer in use. They are also loaded only once from disk, and further attempts to load the resource will return the same reference (all this in contrast to a [Node], which is not reference counted and can be instanced from disk as many times as desired). Resources can be saved externally on disk or bundled into another object, such as a [Node] or another resource. </description> <methods> <method name="set_path"> @@ -27698,7 +27722,7 @@ This method controls whether the position between two cached points is interpola <return type="int"> </return> <description> - Poll the load. If OK is returned, this means poll will have to be called again. If ERR_EOF is returned, them the load has finished and the resource can be obtained by calling [get_resource]. + Poll the load. If OK is returned, this means poll will have to be called again. If ERR_EOF is returned, them the load has finished and the resource can be obtained by calling [method get_resource]. </description> </method> <method name="wait"> @@ -27711,14 +27735,14 @@ This method controls whether the position between two cached points is interpola <return type="int"> </return> <description> - Return the load stage. The total amount of stages can be queried with [get_stage_count] + Return the load stage. The total amount of stages can be queried with [method get_stage_count] </description> </method> <method name="get_stage_count" qualifiers="const"> <return type="int"> </return> <description> - Return the total amount of stages (calls to [poll] ) needed to completely load this resource. + Return the total amount of stages (calls to [method poll]) needed to completely load this resource. </description> </method> </methods> @@ -27797,7 +27821,7 @@ This method controls whether the position between two cached points is interpola Resource Preloader Node. </brief_description> <description> - Resource Preloader Node. This node is used to preload sub-resources inside a scene, so when the scene is loaded all the resourcs are ready to use and be retrieved from here. + Resource Preloader Node. This node is used to preload sub-resources inside a scene, so when the scene is loaded all the resources are ready to use and be retrieved from here. </description> <methods> <method name="add_resource"> @@ -28589,7 +28613,7 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="linear_damp" type="float"> </argument> <description> - Set the linear damp for this body. If this value is different from -1, any linear damp derived from the world or areas will be overriden. + Set the linear damp for this body. If this value is different from -1, any linear damp derived from the world or areas will be overridden. </description> </method> <method name="get_linear_damp" qualifiers="const"> @@ -28603,7 +28627,7 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="angular_damp" type="float"> </argument> <description> - Set the angular damp for this body. If this value is different from -1, any angular damp derived from the world or areas will be overriden. + Set the angular damp for this body. If this value is different from -1, any angular damp derived from the world or areas will be overridden. </description> </method> <method name="get_angular_damp" qualifiers="const"> @@ -28617,7 +28641,7 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="linear_velocity" type="Vector2"> </argument> <description> - Set the body linear velocity. Can be used sporadically, but[b] DONT SET THIS IN EVERY FRAME [/b], because physics may be running in another thread and definitely runs at a different granularity. Use [_integrate_forces] as your process loop if you want to have precise control of the body state. + Set the body linear velocity. Can be used sporadically, but [b]DON'T SET THIS IN EVERY FRAME[/b], because physics may be running in another thread and definitely runs at a different granularity. Use [method _integrate_forces] as your process loop if you want to have precise control of the body state. </description> </method> <method name="get_linear_velocity" qualifiers="const"> @@ -28631,7 +28655,7 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="angular_velocity" type="float"> </argument> <description> - Set the body angular velocity. Can be used sporadically, but[b] DONT SET THIS IN EVERY FRAME [/b], because physics may be running in another thread and definitely runs at a different granularity. Use [_integrate_forces] as your process loop if you want to have precise control of the body state. + Set the body angular velocity. Can be used sporadically, but [b]DON'T SET THIS IN EVERY FRAME[/b], because physics may be running in another thread and definitely runs at a different granularity. Use [method _integrate_forces] as your process loop if you want to have precise control of the body state. </description> </method> <method name="get_angular_velocity" qualifiers="const"> @@ -28688,7 +28712,7 @@ This method controls whether the position between two cached points is interpola </argument> <description> Set the continuous collision detection mode from the enum CCD_MODE_*. - Coninuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. The first is more precise, and misses less impacts by small, fast-moving objects. The second is faster to compute, but can miss small, fat-moving objects. + Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. The first is more precise, and misses less impacts by small, fast-moving objects. The second is faster to compute, but can miss small, fat-moving objects. </description> </method> <method name="get_continuous_collision_detection_mode" qualifiers="const"> @@ -28732,7 +28756,7 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="sleeping" type="bool"> </argument> <description> - Set whether a body is isleeping or not. Sleeping bodies are not affected by forces until a collision or an [method apply_impulse]/[method set_applied_force] wakes them up. Until then, they behave like a static body. + Set whether a body is sleeping or not. Sleeping bodies are not affected by forces until a collision or an [method apply_impulse] / [method set_applied_force] wakes them up. Until then, they behave like a static body. </description> </method> <method name="is_sleeping" qualifiers="const"> @@ -28747,7 +28771,7 @@ This method controls whether the position between two cached points is interpola </argument> <description> Set the body ability to fall asleep when not moving. This saves an enormous amount of processor time when there are plenty of rigid bodies (non static) in a scene. - Sleeping bodies are not affected by forces until a collision or an [method apply_impulse]/[method set_applied_force] wakes them up. Until then, they behave like a static body. + Sleeping bodies are not affected by forces until a collision or an [method apply_impulse] / [method set_applied_force] wakes them up. Until then, they behave like a static body. </description> </method> <method name="is_able_to_sleep" qualifiers="const"> @@ -28824,25 +28848,25 @@ This method controls whether the position between two cached points is interpola </signals> <constants> <constant name="MODE_STATIC" value="1"> - 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. </constant> <constant name="MODE_KINEMATIC" value="3"> - 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. </constant> <constant name="MODE_RIGID" value="0"> - 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. </constant> <constant name="MODE_CHARACTER" value="2"> - Character body. This behaves like a rigid body, but can not rotate. + Character body. This behaves like a rigid body, but can not rotate. </constant> <constant name="CCD_MODE_DISABLED" value="0"> - 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. </constant> <constant name="CCD_MODE_CAST_RAY" value="1"> - 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. </constant> <constant name="CCD_MODE_CAST_SHAPE" value="2"> - 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. </constant> </constants> </class> @@ -29070,7 +29094,7 @@ This method controls whether the position between two cached points is interpola Library that contains a collection of samples. </brief_description> <description> - Library that contains a collection of [Sample]s, each identified by a text ID. This is used as a data container for the majority of the SamplePlayer classes and derivatives. + Library that contains a collection of [Sample], each identified by a text ID. This is used as a data container for the majority of the SamplePlayer classes and derivatives. </description> <methods> <method name="add_sample"> @@ -29755,6 +29779,152 @@ This method controls whether the position between two cached points is interpola </constant> </constants> </class> +<class name="SceneState" inherits="Reference" category="Core"> + <brief_description> + </brief_description> + <description> + </description> + <methods> + <method name="get_node_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_node_type" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_node_name" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_node_path" qualifiers="const"> + <return type="NodePath"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="for_parent" type="bool" default="false"> + </argument> + <description> + </description> + </method> + <method name="get_node_owner_path" qualifiers="const"> + <return type="NodePath"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_node_instance" qualifiers="const"> + <return type="PackedScene"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_node_groups" qualifiers="const"> + <return type="StringArray"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_node_property_count" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_node_property_name" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="prop_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_node_property_value" qualifiers="const"> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="prop_idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_connection_count" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_connection_source" qualifiers="const"> + <return type="NodePath"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_connection_signal" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_connection_target" qualifiers="const"> + <return type="NodePath"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_connection_method" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_connection_flags" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_connection_binds" qualifiers="const"> + <return type="Array"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> <class name="SceneTree" inherits="MainLoop" category="Core"> <brief_description> </brief_description> @@ -30093,7 +30263,7 @@ This method controls whether the position between two cached points is interpola </class> <class name="ScrollContainer" inherits="Container" category="Core"> <brief_description> - A helper node for displaying scollable elements (e.g. lists). + A helper node for displaying scrollable elements (e.g. lists). </brief_description> <description> 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. @@ -30218,7 +30388,7 @@ This method controls whether the position between two cached points is interpola Base class for separators. </brief_description> <description> - Separator is a [Control] used for sepataring other controls. It's purely a visual decoration. Horizontal ([HSeparator]) and Vertical ([VSeparator]) versions are available. + Separator is a [Control] used for separating other controls. It's purely a visual decoration. Horizontal ([HSeparator]) and Vertical ([VSeparator]) versions are available. </description> <methods> </methods> @@ -31274,8 +31444,8 @@ This method controls whether the position between two cached points is interpola <argument index="4" name="shape_motion" type="Vector2"> </argument> <description> - Return whether this shape would collide with another, if a given movemen was applied. - This method needs the transformation matrix for this shape ([code]local_xform[/code]), the movement to test on this shape ([code]local_motion[/code]), the shape to check collisions with ([code]with_shape[/code]), the transformation matrix of that shape ([code]shape_xform[/code]), and the movement to test ont the other object ([code]shape_motion[/code]). + Return whether this shape would collide with another, if a given movement was applied. + This method needs the transformation matrix for this shape ([code]local_xform[/code]), the movement to test on this shape ([code]local_motion[/code]), the shape to check collisions with ([code]with_shape[/code]), the transformation matrix of that shape ([code]shape_xform[/code]), and the movement to test onto the other object ([code]shape_motion[/code]). </description> </method> <method name="collide_and_get_contacts"> @@ -31307,7 +31477,7 @@ This method controls whether the position between two cached points is interpola </argument> <description> Return a list of the points where this shape would touch another, if a given movement was applied. If there are no collisions, the list is empty. - This method needs the transformation matrix for this shape ([code]local_xform[/code]), the movement to test on this shape ([code]local_motion[/code]), the shape to check collisions with ([code]with_shape[/code]), the transformation matrix of that shape ([code]shape_xform[/code]), and the movement to test ont the other object ([code]shape_motion[/code]). + This method needs the transformation matrix for this shape ([code]local_xform[/code]), the movement to test on this shape ([code]local_motion[/code]), the shape to check collisions with ([code]with_shape[/code]), the transformation matrix of that shape ([code]shape_xform[/code]), and the movement to test onto the other object ([code]shape_motion[/code]). </description> </method> </methods> @@ -31319,7 +31489,7 @@ This method controls whether the position between two cached points is interpola Skeleton for characters and animated objects. </brief_description> <description> - Skeleton provides a hierachial interface for managing bones, including pose, rest and animation (see [Animation]). Skeleton will support rag doll dynamics in the future. + Skeleton provides a hierarchical interface for managing bones, including pose, rest and animation (see [Animation]). Skeleton will support rag doll dynamics in the future. </description> <methods> <method name="add_bone"> @@ -31948,7 +32118,7 @@ This method controls whether the position between two cached points is interpola </signals> <constants> <constant name="NOTIFICATION_TRANSFORM_CHANGED" value="29"> - Spatial nodes receive this notifacation with their global transform changes. This means that either the current or a parent node changed its transform. + Spatial nodes receive this notification with their global transform changes. This means that either the current or a parent node changed its transform. </constant> <constant name="NOTIFICATION_ENTER_WORLD" value="41"> </constant> @@ -32397,14 +32567,14 @@ This method controls whether the position between two cached points is interpola Return if the split is collapsed. </description> </method> - <method name="set_dragger_visible"> - <argument index="0" name="visible" type="bool"> + <method name="set_dragger_visibility"> + <argument index="0" name="mode" type="int"> </argument> <description> </description> </method> - <method name="is_dragger_visible" qualifiers="const"> - <return type="bool"> + <method name="get_dragger_visibility" qualifiers="const"> + <return type="int"> </return> <description> </description> @@ -32419,6 +32589,12 @@ This method controls whether the position between two cached points is interpola </signal> </signals> <constants> + <constant name="DRAGGER_VISIBLE" value="0"> + </constant> + <constant name="DRAGGER_HIDDEN" value="1"> + </constant> + <constant name="DRAGGER_HIDDEN_COLLAPSED" value="2"> + </constant> </constants> </class> <class name="SpotLight" inherits="Light" category="Core"> @@ -32487,7 +32663,7 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="flip_h" type="bool"> </argument> <description> - Set true to flip the sprite horizontaly. + Set true to flip the sprite horizontally. </description> </method> <method name="is_flipped_h" qualifiers="const"> @@ -32564,7 +32740,7 @@ This method controls whether the position between two cached points is interpola <return type="int"> </return> <description> - Return the amount of vertical frames. See [set_vframes]. + Return the amount of vertical frames. See [method set_vframes]. </description> </method> <method name="set_hframes"> @@ -32578,7 +32754,7 @@ This method controls whether the position between two cached points is interpola <return type="int"> </return> <description> - Return the amount of horizontal frames. See [set_hframes]. + Return the amount of horizontal frames. See [method set_hframes]. </description> </method> <method name="set_modulate"> @@ -33037,7 +33213,7 @@ This method controls whether the position between two cached points is interpola Abstraction and base class for stream-based protocols. </brief_description> <description> - StreamPeer is an abstration and base class for stream-based protocols (such as TCP or Unix Sockets). It provides an API for sending and receiving data through streams as raw data or strings. + StreamPeer is an abstraction and base class for stream-based protocols (such as TCP or Unix Sockets). It provides an API for sending and receiving data through streams as raw data or strings. </description> <methods> <method name="put_data"> @@ -33046,7 +33222,7 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="data" type="RawArray"> </argument> <description> - Send a chunk of data through the connection, blocking if necesary until the data is done sending. This function returns an [Error] code. + Send a chunk of data through the connection, blocking if necessary until the data is done sending. This function returns an Error code. </description> </method> <method name="put_partial_data"> @@ -33055,7 +33231,7 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="data" type="RawArray"> </argument> <description> - Send a chunk of data through the connection, if all the data could not be sent at once, only part of it will. This function returns two values, an [Error] code and an integer, describing how much data was actually sent. + Send a chunk of data through the connection, if all the data could not be sent at once, only part of it will. This function returns two values, an Error code and an integer, describing how much data was actually sent. </description> </method> <method name="get_data"> @@ -33064,7 +33240,7 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="bytes" type="int"> </argument> <description> - Return a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will block until the desired amount is received. This function returns two values, an [Error] code and a data array. + Return a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will block until the desired amount is received. This function returns two values, an Error code and a data array. </description> </method> <method name="get_partial_data"> @@ -33073,7 +33249,7 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="bytes" type="int"> </argument> <description> - Return a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will return how many were actually received. This function returns two values, an [Error] code, and a data array. + Return a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will return how many were actually received. This function returns two values, an Error code, and a data array. </description> </method> <method name="get_available_bytes" qualifiers="const"> @@ -33445,7 +33621,7 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="db" type="float"> </argument> <description> - Set the playback volume for this player, in decibels. This is a float between -80.0 (silent) and 0.0 (full volume). Values under -79.0 get truncated to -80, but values over 0.0 do not, so the warnings for overamplifying (see [set_volume]) still apply. + Set the playback volume for this player, in decibels. This is a float between -80.0 (silent) and 0.0 (full volume). Values under -79.0 get truncated to -80, but values over 0.0 do not, so the warnings for overamplifying (see [method set_volume]) still apply. </description> </method> <method name="get_volume_db" qualifiers="const"> @@ -33549,7 +33725,7 @@ This method controls whether the position between two cached points is interpola Built-in string class. </brief_description> <description> - This is the built-in string class (and the one used by GDScript). It supports Unicode and provides all necesary means for string handling. Strings are reference counted and use a copy-on-write approach, so passing them around is cheap in resources. + This is the built-in string class (and the one used by GDScript). It supports Unicode and provides all necessary means for string handling. Strings are reference counted and use a copy-on-write approach, so passing them around is cheap in resources. </description> <methods> <method name="basename"> @@ -33568,6 +33744,18 @@ This method controls whether the position between two cached points is interpola Return true if the strings begins with the given string. </description> </method> + <method name="c_escape"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="c_unescape"> + <return type="String"> + </return> + <description> + </description> + </method> <method name="capitalize"> <return type="String"> </return> @@ -33581,7 +33769,7 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="to" type="String"> </argument> <description> - Perform a case-sensitive comparison to antoher string, return -1 if less, 0 if equal and +1 if greater. + Perform a case-sensitive comparison to another string, return -1 if less, 0 if equal and +1 if greater. </description> </method> <method name="empty"> @@ -33606,7 +33794,7 @@ This method controls whether the position between two cached points is interpola <argument index="1" name="from" type="int" default="0"> </argument> <description> - Find the first occurence of a substring, return the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. + Find the first occurrence of a substring, return the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. </description> </method> <method name="find_last"> @@ -33615,7 +33803,7 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="what" type="String"> </argument> <description> - Find the last occurence of a substring, return the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. + Find the last occurrence of a substring, return the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. </description> </method> <method name="findn"> @@ -33626,7 +33814,7 @@ This method controls whether the position between two cached points is interpola <argument index="1" name="from" type="int" default="0"> </argument> <description> - Find the first occurence of a substring but search as case-insensitive, return the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. + Find the first occurrence of a substring but search as case-insensitive, return the starting position of the substring or -1 if not found. Optionally, the initial search index can be passed. </description> </method> <method name="get_base_dir"> @@ -33716,6 +33904,12 @@ This method controls whether the position between two cached points is interpola Check whether the string contains a valid IP address. </description> </method> + <method name="json_escape"> + <return type="String"> + </return> + <description> + </description> + </method> <method name="left"> <return type="String"> </return> @@ -33768,7 +33962,7 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="to" type="String"> </argument> <description> - Perform a case-insensitive comparison to antoher string, return -1 if less, 0 if equal and +1 if greater. + Perform a case-insensitive comparison to another string, return -1 if less, 0 if equal and +1 if greater. </description> </method> <method name="ord_at"> @@ -33846,7 +34040,7 @@ This method controls whether the position between two cached points is interpola <argument index="1" name="from" type="int" default="-1"> </argument> <description> - Perform a search for a substring, but start from the end of the string instead of the begining. + Perform a search for a substring, but start from the end of the string instead of the beginning. </description> </method> <method name="rfindn"> @@ -33857,7 +34051,7 @@ This method controls whether the position between two cached points is interpola <argument index="1" name="from" type="int" default="-1"> </argument> <description> - Perform a search for a substring, but start from the end of the string instead of the begining. Also search case-insensitive. + Perform a search for a substring, but start from the end of the string instead of the beginning. Also search case-insensitive. </description> </method> <method name="right"> @@ -33877,7 +34071,7 @@ This method controls whether the position between two cached points is interpola <argument index="1" name="allow_empty" type="bool" default="True"> </argument> <description> - Split the string by a divisor string, return an array of the substrings. Example "One,Two,Three" will return ["One","Two","Three"] if split by ",". + Split the string by a divisor string, return an array of the substrings. Example "One,Two,Three" will return \["One","Two","Three"\] if split by ",". </description> </method> <method name="split_floats"> @@ -33888,14 +34082,14 @@ This method controls whether the position between two cached points is interpola <argument index="1" name="allow_empty" type="bool" default="True"> </argument> <description> - Split the string in floats by using a divisor string, return an array of the substrings. Example "1,2.5,3" will return [1,2.5,3] if split by ",". + Split the string in floats by using a divisor string, return an array of the substrings. Example "1,2.5,3" will return \[1,2.5,3\] if split by ",". </description> </method> <method name="strip_edges"> <return type="String"> </return> <description> - Return a copy of the string stripped of any non-printable character at the begining and the end. + Return a copy of the string stripped of any non-printable character at the beginning and the end. </description> </method> <method name="substr"> @@ -33977,14 +34171,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. </description> <methods> - <method name="get"> - <return type="String"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <description> - </description> - </method> <method name="push_back"> <argument index="0" name="string" type="String"> </argument> @@ -34039,7 +34225,7 @@ This method controls whether the position between two cached points is interpola <argument index="1" name="rect" type="Rect2"> </argument> <description> - Test a position in a rectangle, return wether it pases the mask test. + Test a position in a rectangle, return whether it passes the mask test. </description> </method> <method name="set_default_margin"> @@ -34202,7 +34388,7 @@ This method controls whether the position between two cached points is interpola Image mask based StyleBox, for mask test. </brief_description> <description> - This StyleBox is similar to [StyleBoxTexture], but only meant to be used for mask testing. It takes an image and applies stretch rules to determine if the poit clicked is masked or not. + This StyleBox is similar to [StyleBoxTexture], but only meant to be used for mask testing. It takes an image and applies stretch rules to determine if the point clicked is masked or not. </description> <methods> <method name="set_image"> @@ -34216,7 +34402,7 @@ This method controls whether the position between two cached points is interpola <return type="Image"> </return> <description> - Return the image used for mask testing. (see [method set_imag]). + Return the image used for mask testing. (see [method set_image]). </description> </method> <method name="set_expand"> @@ -34230,7 +34416,7 @@ This method controls whether the position between two cached points is interpola <return type="bool"> </return> <description> - Return wether the expand property is set(default). When expanding, the image will use the same rules as [StyleBoxTexture] for expand. If not expanding, the image will always be tested at its original size. + Return whether the expand property is set(default). When expanding, the image will use the same rules as [StyleBoxTexture] for expand. If not expanding, the image will always be tested at its original size. </description> </method> <method name="set_expand_margin_size"> @@ -34545,7 +34731,7 @@ This method controls whether the position between two cached points is interpola <argument index="1" name="title" type="String"> </argument> <description> - Set a title for the tab. Tab titles are by default the children node name, but this can be overriden. + Set a title for the tab. Tab titles are by default the children node name, but this can be overridden. </description> </method> <method name="get_tab_title" qualifiers="const"> @@ -34554,7 +34740,7 @@ This method controls whether the position between two cached points is interpola <argument index="0" name="tab_idx" type="int"> </argument> <description> - Return the title for the tab. Tab titles are by default the children node name, but this can be overriden. + Return the title for the tab. Tab titles are by default the children node name, but this can be overridden. </description> </method> <method name="set_tab_icon"> @@ -34723,6 +34909,12 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> + <method name="ensure_tab_visible"> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> </methods> <signals> <signal name="tab_close"> @@ -34751,13 +34943,11 @@ This method controls whether the position between two cached points is interpola </constant> <constant name="ALIGN_RIGHT" value="2"> </constant> - <constant name="SHOW_ACTIVE_ONLY" value="1"> - </constant> - <constant name="SHOW_ALWAYS" value="0"> + <constant name="CLOSE_BUTTON_SHOW_ACTIVE_ONLY" value="1"> </constant> - <constant name="SHOW_HOVER" value="2"> + <constant name="CLOSE_BUTTON_SHOW_ALWAYS" value="2"> </constant> - <constant name="SHOW_NEVER" value="3"> + <constant name="CLOSE_BUTTON_SHOW_NEVER" value="0"> </constant> </constants> <theme_items> @@ -34779,6 +34969,8 @@ This method controls whether the position between two cached points is interpola </theme_item> <theme_item name="increment" type="Texture"> </theme_item> + <theme_item name="close" type="Texture"> + </theme_item> <theme_item name="decrement" type="Texture"> </theme_item> <theme_item name="font" type="Font"> @@ -35092,7 +35284,7 @@ This method controls whether the position between two cached points is interpola Match whole words when searching. </constant> <constant name="SEARCH_BACKWARDS" value="4"> - Search from end to begining. + Search from end to beginning. </constant> </constants> <theme_items> @@ -35145,7 +35337,7 @@ This method controls whether the position between two cached points is interpola Texture for 2D and 3D. </brief_description> <description> - A texture works by registering an image in the video hardware, which then can be used in 3D models or 2D [Sprite] or GUI [Control]s. + A texture works by registering an image in the video hardware, which then can be used in 3D models or 2D [Sprite] or GUI [Control]. </description> <methods> <method name="get_width" qualifiers="const"> @@ -35831,14 +36023,6 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> - <method name="set_name"> - <return type="Error"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <description> - </description> - </method> </methods> <constants> <constant name="PRIORITY_LOW" value="0"> @@ -36134,6 +36318,15 @@ This method controls whether the position between two cached points is interpola Return the tile index of the referenced cell. </description> </method> + <method name="get_cellv" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="pos" type="Vector2"> + </argument> + <description> + Return the tile index of the cell referenced by a Vector2. + </description> + </method> <method name="is_cell_x_flipped" qualifiers="const"> <return type="bool"> </return> @@ -37586,7 +37779,9 @@ This method controls whether the position between two cached points is interpola </argument> <argument index="1" name="button" type="Texture"> </argument> - <argument index="2" name="button_idx" type="int"> + <argument index="2" name="button_idx" type="int" default="-1"> + </argument> + <argument index="3" name="disabled" type="bool" default="false"> </argument> <description> </description> @@ -37617,6 +37812,16 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> + <method name="is_button_disabled" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <argument index="1" name="button_idx" type="int"> + </argument> + <description> + </description> + </method> <method name="set_tooltip"> <argument index="0" name="column" type="int"> </argument> @@ -38503,15 +38708,6 @@ This method controls whether the position between two cached points is interpola An Array specifically designed to hold Vector2. </description> <methods> - <method name="get"> - <return type="Vector2"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <description> - Returns the Vector2 at the given index. - </description> - </method> <method name="push_back"> <argument index="0" name="vector2" type="Vector2"> </argument> @@ -38768,15 +38964,6 @@ This method controls whether the position between two cached points is interpola An Array specifically designed to hold Vector3. </description> <methods> - <method name="get"> - <return type="Vector3"> - </return> - <argument index="0" name="idx" type="int"> - </argument> - <description> - Returns the Vector3 at the given index. - </description> - </method> <method name="push_back"> <argument index="0" name="vector3" type="Vector3"> </argument> @@ -39263,7 +39450,7 @@ This method controls whether the position between two cached points is interpola <return type="Rect2"> </return> <description> - Return the final, visuble rect in global screen coordinates. + Return the final, visible rect in global screen coordinates. </description> </method> <method name="set_transparent_background"> @@ -39277,7 +39464,7 @@ This method controls whether the position between two cached points is interpola <return type="bool"> </return> <description> - Reurn whether the viewport lets whatever is behind it to show. + Return whether the viewport lets whatever is behind it to show. </description> </method> <method name="set_size_override"> @@ -39501,6 +39688,24 @@ This method controls whether the position between two cached points is interpola <description> </description> </method> + <method name="gui_has_modal_stack" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_disable_input"> + <argument index="0" name="disable" type="bool"> + </argument> + <description> + </description> + </method> + <method name="is_input_disabled" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> </methods> <signals> <signal name="size_changed"> diff --git a/doc/tools/makerst.py b/doc/tools/makerst.py new file mode 100644 index 0000000000..1e2d276fb3 --- /dev/null +++ b/doc/tools/makerst.py @@ -0,0 +1,475 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- + +import sys +import xml.etree.ElementTree as ET + +input_list = [] + +for arg in sys.argv[1:]: + input_list.append(arg) + +if len(input_list) < 1: + print 'usage: makerst.py <classes.xml>' + sys.exit(0) + + +def validate_tag(elem, tag): + if elem.tag != tag: + print "Tag mismatch, expected '" + tag + "', got " + elem.tag + sys.exit(255) + + +class_names = [] +classes = {} + +def ul_string(str,ul): + str+="\n" + for i in range(len(str)-1): + str+=ul + str+="\n" + return str + +def make_class_list(class_list, columns): + + f = open('class_list.rst', 'wb') + prev = 0 + col_max = len(class_list) / columns + 1 + print ('col max is ', col_max) + col_count = 0 + row_count = 0 + last_initial = '' + fit_columns = [] + + for n in range(0, columns): + fit_columns += [[]] + + indexers = [] + last_initial = '' + + idx = 0 + for n in class_list: + col = idx / col_max + if col >= columns: + col = columns - 1 + fit_columns[col] += [n] + idx += 1 + if n[:1] != last_initial: + indexers += [n] + last_initial = n[:1] + + row_max = 0 + f.write("\n") + + for n in range(0, columns): + if len(fit_columns[n]) > row_max: + row_max = len(fit_columns[n]) + + f.write("| ") + for n in range(0, columns): + f.write(" | |") + + f.write("\n") + f.write("+") + for n in range(0, columns): + f.write("--+-------+") + f.write("\n") + + for r in range(0, row_max): + s = '+ ' + for c in range(0, columns): + if r >= len(fit_columns[c]): + continue + + classname = fit_columns[c][r] + initial = classname[0] + if classname in indexers: + s += '**' + initial + '** | ' + else: + s += ' | ' + + s += '[' + classname + '](class_'+ classname.lower()+') | ' + + s += '\n' + f.write(s) + + for n in range(0, columns): + f.write("--+-------+") + f.write("\n") + + +def rstize_text(text,cclass): + + # Linebreak + tabs in the XML should become two line breaks + pos = 0 + while True: + pos = text.find('\n', pos) + if pos == -1: + break + + pre_text = text[:pos] + while text[pos+1] == '\t': + pos += 1 + post_text = text[pos+1:] + + text = pre_text + "\n\n" + post_text + pos += 2 + + # Escape * character to avoid interpreting it as emphasis + pos = 0 + while True: + pos = text.find('*', pos) + if pos == -1: + break + text = text[:pos] + "\*" + text[pos + 1:] + pos += 2 + + # Escape _ character at the end of a word to avoid interpreting it as an inline hyperlink + pos = 0 + while True: + pos = text.find('_', pos) + if pos == -1: + break + if not text[pos + 1].isalnum(): # don't escape within a snake_case word + text = text[:pos] + "\_" + text[pos + 1:] + pos += 2 + else: + pos += 1 + + # Handle [tags] + pos = 0 + while True: + pos = text.find('[', pos) + if pos == -1: + break + + endq_pos = text.find(']', pos + 1) + if endq_pos == -1: + break + + pre_text = text[:pos] + post_text = text[endq_pos + 1:] + tag_text = text[pos + 1:endq_pos] + + if tag_text in class_names: + tag_text = make_type(tag_text) + else: # command + cmd = tag_text + space_pos = tag_text.find(' ') + if cmd.find('html') == 0: + cmd = tag_text[:space_pos] + param = tag_text[space_pos + 1:] + tag_text = param + elif cmd.find('method') == 0: + cmd = tag_text[:space_pos] + param = tag_text[space_pos + 1:] + + if param.find('.') != -1: + (class_param, method_param) = param.split('.') + tag_text = ':ref:`'+class_param+'.'+method_param+'<class_' + class_param + '_' + method_param + '>`' + else: + tag_text = ':ref:`' + param + '<class_' + cclass +"_"+ param + '>`' + elif cmd.find('image=') == 0: + tag_text = "" #'' + elif cmd.find('url=') == 0: + tag_text = ':ref:`' + cmd[4:] + '<'+cmd[4:]+">`" + elif cmd == '/url': + tag_text = ')' + elif cmd == 'center': + tag_text = '' + elif cmd == '/center': + tag_text = '' + elif cmd == 'br': + # Make a new paragraph instead of a linebreak, rst is not so linebreak friendly + tag_text = '\n\n' + # Strip potential leading spaces + while post_text[0] == ' ': + post_text = post_text[1:] + elif cmd == 'i' or cmd == '/i': + tag_text = '*' + elif cmd == 'b' or cmd == '/b': + tag_text = '**' + elif cmd == 'u' or cmd == '/u': + tag_text = '' + elif cmd == 'code' or cmd == '/code': + tag_text = '``' + else: + tag_text = ':ref:`' + tag_text + '<class_'+tag_text.lower()+'>`' + + text = pre_text + tag_text + post_text + pos = len(pre_text) + len(tag_text) + + # tnode = ET.SubElement(parent,"div") + # tnode.text=text + + return text + + +def make_type(t): + global class_names + if t in class_names: + return ':ref:`'+t+'<class_' + t.lower()+'>`' + return t + + +def make_method( + f, + name, + m, + declare, + cname, + event=False, + pp=None + ): + + if (declare or pp==None): + t = '- ' + else: + t = "" + + ret_type = 'void' + args = list(m) + mdata = {} + mdata['argidx'] = [] + for a in args: + if a.tag == 'return': + idx = -1 + elif a.tag == 'argument': + idx = int(a.attrib['index']) + else: + continue + + mdata['argidx'].append(idx) + mdata[idx] = a + + if not event: + if -1 in mdata['argidx']: + t += make_type(mdata[-1].attrib['type']) + else: + t += 'void' + t += ' ' + + if declare or pp==None: + + # span.attrib["class"]="funcdecl" + # a=ET.SubElement(span,"a") + # a.attrib["name"]=name+"_"+m.attrib["name"] + # a.text=name+"::"+m.attrib["name"] + + s = ' **'+m.attrib['name']+'** ' + else: + s = ':ref:`'+ m.attrib['name']+'<class_' + cname+"_"+m.attrib['name'] + '>` ' + + s += ' **(**' + argfound = False + for a in mdata['argidx']: + arg = mdata[a] + if a < 0: + continue + if a > 0: + s += ', ' + else: + s += ' ' + + s += make_type(arg.attrib['type']) + if 'name' in arg.attrib: + s += ' ' + arg.attrib['name'] + else: + s += ' arg' + str(a) + + if 'default' in arg.attrib: + s += '=' + arg.attrib['default'] + + argfound = True + + if argfound: + s += ' ' + s += ' **)**' + + if 'qualifiers' in m.attrib: + s += ' ' + m.attrib['qualifiers'] + +# f.write(s) + if (not declare): + if (pp!=None): + pp.append( (t,s) ) + else: + f.write("- "+t+" "+s+"\n") + else: + f.write(t+s+"\n") + + +def make_heading(title, underline): + return title + '\n' + underline*len(title) + "\n\n" + + + +def make_rst_class(node): + + name = node.attrib['name'] + + f = open("class_"+name.lower() + '.rst', 'wb') + + f.write(".. _class_"+name+":\n\n") + f.write(make_heading(name, '=')) + + if 'inherits' in node.attrib: + inh = node.attrib['inherits'].strip() +# whle inh in classes[cn] + f.write('**Inherits:** ') + first=True + while(inh in classes): + if (not first): + f.write(" **<** ") + else: + first=False + + f.write(make_type(inh)) + inode = classes[inh] + if ('inherits' in inode.attrib): + inh=inode.attrib['inherits'].strip() + else: + inh=None + + + f.write("\n\n") + + inherited=[] + for cn in classes: + c=classes[cn] + if 'inherits' in c.attrib: + if (c.attrib['inherits'].strip()==name): + inherited.append(c.attrib['name']) + + if (len(inherited)): + f.write('**Inherited By:** ') + for i in range(len(inherited)): + if (i>0): + f.write(", ") + f.write(make_type(inherited[i])) + f.write("\n\n") + if 'category' in node.attrib: + f.write('**Category:** ' + node.attrib['category'].strip() + "\n\n") + + f.write(make_heading('Brief Description', '-')) + briefd = node.find('brief_description') + if briefd != None: + f.write(rstize_text(briefd.text.strip(),name) + "\n\n") + + methods = node.find('methods') + + if methods != None and len(list(methods)) > 0: + f.write(make_heading('Member Functions', '-')) + ml=[] + for m in list(methods): + make_method(f, node.attrib['name'], m, False,name,False,ml) + longest_t = 0 + longest_s = 0 + for s in ml: + sl = len(s[0]) + if (sl>longest_s): + longest_s=sl + tl = len(s[1]) + if (tl>longest_t): + longest_t=tl + + sep="+" + for i in range(longest_s+2): + sep+="-" + sep+="+" + for i in range(longest_t+2): + sep+="-" + sep+="+\n" + f.write(sep) + for s in ml: + rt = s[0] + while( len(rt) < longest_s ): + rt+=" " + st = s[1] + while( len(st) < longest_t ): + st+=" " + f.write("| "+rt+" | "+st+" |\n") + f.write(sep) + f.write('\n') + + + events = node.find('signals') + if events != None and len(list(events)) > 0: + f.write(make_heading('Signals', '-')) + for m in list(events): + make_method(f, node.attrib['name'], m, True,name, True) + f.write('\n') + + members = node.find('members') + if members != None and len(list(members)) > 0: + f.write(make_heading('Member Variables', '-')) + + for c in list(members): + s = '- ' + s += make_type(c.attrib['type']) + ' ' + s += '**' + c.attrib['name'] + '**' + if c.text.strip() != '': + s += ' - ' + c.text.strip() + f.write(s + '\n') + f.write('\n') + + constants = node.find('constants') + if constants != None and len(list(constants)) > 0: + f.write(make_heading('Numeric Constants', '-')) + for c in list(constants): + s = '- ' + s += '**' + c.attrib['name'] + '**' + if 'value' in c.attrib: + s += ' = **' + c.attrib['value'] + '**' + if c.text.strip() != '': + s += ' --- ' + rstize_text(c.text.strip(),name) + f.write(s + '\n') + f.write('\n') + + descr = node.find('description') + if descr != None and descr.text.strip() != '': + f.write(make_heading('Description', '-')) + f.write(rstize_text(descr.text.strip(),name) + "\n\n") + + methods = node.find('methods') + if methods != None and len(list(methods)) > 0: + f.write(make_heading('Member Function Description', '-')) + for m in list(methods): + f.write(".. _class_"+name+"_"+m.attrib['name']+":\n\n") +# f.write(ul_string(m.attrib['name'],"^")) + #f.write('\n<a name="'+m.attrib['name']+'">' + m.attrib['name'] + '</a>\n------\n') + make_method(f, node.attrib['name'], m, True,name) + f.write('\n') + d = m.find('description') + if d == None or d.text.strip() == '': + continue + f.write(rstize_text(d.text.strip(),name)) + f.write("\n\n") + f.write('\n') + + +for file in input_list: + tree = ET.parse(file) + doc = tree.getroot() + + if 'version' not in doc.attrib: + print "Version missing from 'doc'" + sys.exit(255) + + version = doc.attrib['version'] + + for c in list(doc): + if c.attrib['name'] in class_names: + continue + class_names.append(c.attrib['name']) + classes[c.attrib['name']] = c + +class_names.sort() + +#Don't make class list for Sphinx, :toctree: handles it +#make_class_list(class_names, 2) + +for cn in class_names: + c = classes[cn] + make_rst_class(c) + |