diff options
Diffstat (limited to 'doc/classes')
62 files changed, 805 insertions, 470 deletions
diff --git a/doc/classes/ARVRInterface.xml b/doc/classes/ARVRInterface.xml index 1c2e761b57..9aed6c96ef 100644 --- a/doc/classes/ARVRInterface.xml +++ b/doc/classes/ARVRInterface.xml @@ -94,7 +94,7 @@ <argument index="0" name="initialized" type="bool"> </argument> <description> - Initialise/uninitilise this interface (same effect as calling intialize/uninitialize). + Initialize/uninitialize this interface (same effect as calling initialize/uninitialize). </description> </method> <method name="set_is_primary"> diff --git a/doc/classes/ARVRScriptInterface.xml b/doc/classes/ARVRScriptInterface.xml deleted file mode 100644 index 182147a015..0000000000 --- a/doc/classes/ARVRScriptInterface.xml +++ /dev/null @@ -1,118 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="ARVRScriptInterface" inherits="ARVRInterface" category="Core" version="3.0.alpha.custom_build"> - <brief_description> - Base class for GDNative based ARVR interfaces. - </brief_description> - <description> - This class is used as a base class/interface class for implementing GDNative based ARVR interfaces and as a result exposes more of the internals of the ARVR server. - </description> - <tutorials> - </tutorials> - <demos> - </demos> - <methods> - <method name="_get_projection_for_eye" qualifiers="virtual"> - <return type="void"> - </return> - <description> - Should return the projection 4x4 matrix for the requested eye. - </description> - </method> - <method name="commit_for_eye" qualifiers="virtual"> - <return type="void"> - </return> - <argument index="0" name="eye" type="int"> - </argument> - <argument index="1" name="render_target" type="RID"> - </argument> - <description> - Outputs a finished render buffer to the AR/VR device for the given eye. - </description> - </method> - <method name="get_anchor_detection_is_enabled" qualifiers="virtual"> - <return type="bool"> - </return> - <description> - Returns true if achor detection is enabled (AR only). - </description> - </method> - <method name="get_capabilities" qualifiers="virtual"> - <return type="int"> - </return> - <description> - Returns a combination of flags providing information about the capabilities of this interface. - </description> - </method> - <method name="get_recommended_render_targetsize" qualifiers="virtual"> - <return type="Vector2"> - </return> - <description> - Returns the size at which we should render our scene to get optimal quality on the output device. - </description> - </method> - <method name="get_tracking_status" qualifiers="virtual"> - <return type="int"> - </return> - <description> - If supported, returns the status of our tracking. This will allow you to provide feedback to the user whether there are issues with positional tracking. - </description> - </method> - <method name="get_transform_for_eye" qualifiers="virtual"> - <return type="Transform"> - </return> - <argument index="0" name="eye" type="int"> - </argument> - <argument index="1" name="cam_transform" type="Transform"> - </argument> - <description> - Get the location and orientation transform used when rendering a specific eye. - </description> - </method> - <method name="initialize" qualifiers="virtual"> - <return type="bool"> - </return> - <description> - Initialize this interface. - </description> - </method> - <method name="is_initialized" qualifiers="virtual"> - <return type="bool"> - </return> - <description> - Returns true if this interface has been initialized and is active. - </description> - </method> - <method name="is_stereo" qualifiers="virtual"> - <return type="bool"> - </return> - <description> - Returns true if we require stereoscopic rendering for this interface. - </description> - </method> - <method name="process" qualifiers="virtual"> - <return type="void"> - </return> - <description> - Gets called before rendering each frame so tracking data gets updated in time. - </description> - </method> - <method name="set_anchor_detection_is_enabled" qualifiers="virtual"> - <return type="void"> - </return> - <argument index="0" name="enabled" type="bool"> - </argument> - <description> - Enables anchor detection, this is used on AR interfaces and enables the extra logic that will detect planes, features, objects, etc. and adds/modifies anchor points. - </description> - </method> - <method name="uninitialize" qualifiers="virtual"> - <return type="void"> - </return> - <description> - Turn this interface off. - </description> - </method> - </methods> - <constants> - </constants> -</class> diff --git a/doc/classes/ARVRServer.xml b/doc/classes/ARVRServer.xml index 86bfe88ea9..5e1055d568 100644 --- a/doc/classes/ARVRServer.xml +++ b/doc/classes/ARVRServer.xml @@ -178,7 +178,7 @@ Used internally to filter trackers of any known type. </constant> <constant name="TRACKER_ANY" value="255"> - Used interally to select all trackers. + Used internally to select all trackers. </constant> </constants> </class> diff --git a/doc/classes/AudioEffectDistortion.xml b/doc/classes/AudioEffectDistortion.xml index 1a6aa1d2b6..8b970e675e 100644 --- a/doc/classes/AudioEffectDistortion.xml +++ b/doc/classes/AudioEffectDistortion.xml @@ -5,7 +5,7 @@ Modify the sound to make it dirty. </brief_description> <description> - Modify the sound and make it dirty. Differents types available : clip, tan, lofi (bit crushing), overdrive, or waveshape. + Modify the sound and make it dirty. Different types are available : clip, tan, lofi (bit crushing), overdrive, or waveshape. By distorting the waveform the frequency content change, which will often make the sound "crunchy" or "abrasive". For games, it can simulate sound coming from some saturated device or speaker very efficiently. </description> <tutorials> diff --git a/doc/classes/AudioStreamPlayer3D.xml b/doc/classes/AudioStreamPlayer3D.xml index 52914af9fc..84f6792ef0 100644 --- a/doc/classes/AudioStreamPlayer3D.xml +++ b/doc/classes/AudioStreamPlayer3D.xml @@ -310,7 +310,7 @@ Sets the absolute maximum of the soundlevel, in dB. </member> <member name="max_distance" type="float" setter="set_max_distance" getter="get_max_distance"> - Sets the distance from wich the 'out_of_range_mode' takes effect. Has no effect if set to 0. + Sets the distance from which the 'out_of_range_mode' takes effect. Has no effect if set to 0. </member> <member name="out_of_range_mode" type="int" setter="set_out_of_range_mode" getter="get_out_of_range_mode" enum="AudioStreamPlayer3D.OutOfRangeMode"> Decides if audio should pause when source is outside of 'max_distance' range. @@ -355,7 +355,7 @@ Disables doppler tracking. </constant> <constant name="DOPPLER_TRACKING_IDLE_STEP" value="1"> - Executes doppler trackin in idle step. + Executes doppler tracking in idle step. </constant> <constant name="DOPPLER_TRACKING_PHYSICS_STEP" value="2"> Executes doppler tracking in physics step. diff --git a/doc/classes/BitmapFont.xml b/doc/classes/BitmapFont.xml index e983c59782..07027c4b42 100644 --- a/doc/classes/BitmapFont.xml +++ b/doc/classes/BitmapFont.xml @@ -1,8 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="BitmapFont" inherits="Font" category="Core" version="3.0.alpha.custom_build"> <brief_description> + Renders text using [code]*.fnt[/code] fonts. </brief_description> <description> + Renders text using [code]*.fnt[/code] fonts containing texture atlases. Supports distance fields. For using vector font files like TTF directly, see [DynamicFont]. </description> <tutorials> </tutorials> @@ -23,7 +25,7 @@ <argument index="4" name="advance" type="float" default="-1"> </argument> <description> - Add a character to the font, where [i]character[/i] is the unicode value, [i]texture[/i] is the texture index, [i]rect[/i] is the region in the texture (in pixels!), [i]align[/i] is the (optional) alignment for the character and [i]advance[/i] is the (optional) advance. + Adds a character to the font, where [code]character[/code] is the unicode value, [code]texture[/code] is the texture index, [code]rect[/code] is the region in the texture (in pixels!), [code]align[/code] is the (optional) alignment for the character and [code]advance[/code] is the (optional) advance. </description> </method> <method name="add_kerning_pair"> @@ -36,7 +38,7 @@ <argument index="2" name="kerning" type="int"> </argument> <description> - Add a kerning pair to the [BitmapFont] as a difference. Kerning pairs are special cases where a typeface advance is determined by the next character. + Adds a kerning pair to the [BitmapFont] as a difference. Kerning pairs are special cases where a typeface advance is determined by the next character. </description> </method> <method name="add_texture"> @@ -45,14 +47,14 @@ <argument index="0" name="texture" type="Texture"> </argument> <description> - Add a texture to the [BitmapFont]. + Adds a texture to the [BitmapFont]. </description> </method> <method name="clear"> <return type="void"> </return> <description> - Clear all the font data. + Clears all the font data and settings. </description> </method> <method name="create_from_fnt"> @@ -61,6 +63,7 @@ <argument index="0" name="path" type="String"> </argument> <description> + Creates a BitmapFont from the [code]*.fnt[/code] file at [code]path[/code]. </description> </method> <method name="get_char_size" qualifiers="const"> @@ -71,13 +74,14 @@ <argument index="1" name="next" type="int" default="0"> </argument> <description> - Return the size of a character, optionally taking kerning into account if the next character is provided. + Returns the size of a character, optionally taking kerning into account if the next character is provided. </description> </method> <method name="get_fallback" qualifiers="const"> <return type="BitmapFont"> </return> <description> + Returns the fallback BitmapFont. </description> </method> <method name="get_kerning_pair" qualifiers="const"> @@ -88,7 +92,7 @@ <argument index="1" name="char_b" type="int"> </argument> <description> - Return a kerning pair as a difference. + Returns a kerning pair as a difference. </description> </method> <method name="get_texture" qualifiers="const"> @@ -97,12 +101,14 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Returns the font atlas texture at index [code]idx[/code]. </description> </method> <method name="get_texture_count" qualifiers="const"> <return type="int"> </return> <description> + Returns the number of textures in the BitmapFont atlas. </description> </method> <method name="set_ascent"> @@ -111,7 +117,7 @@ <argument index="0" name="px" type="float"> </argument> <description> - Set the font ascent (number of pixels above the baseline). + Sets the font ascent (number of pixels above the baseline). </description> </method> <method name="set_distance_field_hint"> @@ -120,6 +126,7 @@ <argument index="0" name="enable" type="bool"> </argument> <description> + If [code]true[/code] distance field hint is enabled. </description> </method> <method name="set_fallback"> @@ -128,6 +135,7 @@ <argument index="0" name="fallback" type="BitmapFont"> </argument> <description> + Sets the fallback BitmapFont. </description> </method> <method name="set_height"> @@ -136,24 +144,31 @@ <argument index="0" name="px" type="float"> </argument> <description> - Set the total font height (ascent plus descent) in pixels. + Sets the total font height (ascent plus descent) in pixels. </description> </method> </methods> <members> <member name="ascent" type="float" setter="set_ascent" getter="get_ascent"> + Ascent (number of pixels above the baseline). </member> <member name="chars" type="PoolIntArray" setter="_set_chars" getter="_get_chars"> + The characters in the BitmapFont. </member> <member name="distance_field" type="bool" setter="set_distance_field_hint" getter="is_distance_field_hint"> + If [code]true[/code] distance field hint is enabled. </member> <member name="fallback" type="BitmapFont" setter="set_fallback" getter="get_fallback"> + The fallback font. </member> <member name="height" type="float" setter="set_height" getter="get_height"> + Total font height (ascent plus descent) in pixels. </member> <member name="kernings" type="PoolIntArray" setter="_set_kernings" getter="_get_kernings"> + The font's kernings as [PoolIntArray]. </member> <member name="textures" type="Array" setter="_set_textures" getter="_get_textures"> + The font's [Texture]\ s. </member> </members> <constants> diff --git a/doc/classes/CheckBox.xml b/doc/classes/CheckBox.xml index 6258eb503f..50b431e00c 100644 --- a/doc/classes/CheckBox.xml +++ b/doc/classes/CheckBox.xml @@ -4,7 +4,7 @@ Binary choice user interface widget </brief_description> <description> - A checkbox allows the user to make a binary choice (choosing only one of two posible options), for example Answer 'yes' or 'no'. + A checkbox allows the user to make a binary choice (choosing only one of two possible options), for example Answer 'yes' or 'no'. </description> <tutorials> </tutorials> diff --git a/doc/classes/ConeTwistJoint.xml b/doc/classes/ConeTwistJoint.xml index 67c7cc4cfe..78655c496d 100644 --- a/doc/classes/ConeTwistJoint.xml +++ b/doc/classes/ConeTwistJoint.xml @@ -1,8 +1,12 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="ConeTwistJoint" inherits="Joint" category="Core" version="3.0.alpha.custom_build"> <brief_description> + A twist joint between two 3D bodies </brief_description> <description> + The joint can rotate the bodies across an axis defined by the local x-axes of the [Joint]. + The twist axis is initiated as the x-axis of the [Joint]. + Once the Bodies swing, the twist axis is calculated as the middle of the x-axes of the Joint in the local space of the two Bodies. </description> <tutorials> </tutorials> @@ -30,28 +34,49 @@ </methods> <members> <member name="bias" type="float" setter="set_param" getter="get_param"> + The speed with which the swing or twist will take place. + The higher, the faster. </member> <member name="relaxation" type="float" setter="set_param" getter="get_param"> + Defines, how fast the swing- and twist-speed-difference on both sides gets synced. </member> <member name="softness" type="float" setter="set_param" getter="get_param"> + The ease with which the joint starts to twist. If it's too low, it takes more force to start twisting the joint. </member> <member name="swing_span" type="float" setter="_set_swing_span" getter="_get_swing_span"> + Swing is rotation from side to side, around the axis perpendicular to the twist axis. + The swing span defines, how much rotation will not get corrected allong the swing axis. + Could be defined as looseness in the [ConeTwistJoint]. + If below 0.05, this behaviour is locked. Default value: [code]PI/4[/code]. </member> <member name="twist_span" type="float" setter="_set_twist_span" getter="_get_twist_span"> + Twist is the rotation around the twist axis, this value defined how far the joint can twist. + Twist is locked if below 0.05. </member> </members> <constants> <constant name="PARAM_SWING_SPAN" value="0"> + Swing is rotation from side to side, around the axis perpendicular to the twist axis. + The swing span defines, how much rotation will not get corrected allong the swing axis. + Could be defined as looseness in the [ConeTwistJoint]. + If below 0.05, this behaviour is locked. Default value: [code]PI/4[/code]. </constant> <constant name="PARAM_TWIST_SPAN" value="1"> + Twist is the rotation around the twist axis, this value defined how far the joint can twist. + Twist is locked if below 0.05. </constant> <constant name="PARAM_BIAS" value="2"> + The speed with which the swing or twist will take place. + The higher, the faster. </constant> <constant name="PARAM_SOFTNESS" value="3"> + The ease with which the joint starts to twist. If it's too low, it takes more force to start twisting the joint. </constant> <constant name="PARAM_RELAXATION" value="4"> + Defines, how fast the swing- and twist-speed-difference on both sides gets synced. </constant> <constant name="PARAM_MAX" value="5"> + End flag of PARAM_* constants, used internally. </constant> </constants> </class> diff --git a/doc/classes/ConfigFile.xml b/doc/classes/ConfigFile.xml index c2d1ec1355..846a100f3c 100644 --- a/doc/classes/ConfigFile.xml +++ b/doc/classes/ConfigFile.xml @@ -4,15 +4,22 @@ Helper class to handle INI-style files. </brief_description> <description> - This helper class can be used to store [Variant] values on the filesystem using an INI-style formatting. The stored values as referenced by a section and a key. The stored data can be saved to or parsed from a file, though ConfigFile objects can also be used directly with accessing the filesystem. - The following example shows how to parse a INI-style file from the system, read its contents and store new values in it: + This helper class can be used to store [Variant] values on the filesystem using INI-style formatting. The stored values are indentified by a section and a key: + [codeblock] + [section] + some_key=42 + string_example="Hello World!" + a_vector=Vector3( 1, 0, 2 ) + [/codeblock] + The stored data can be saved to or parsed from a file, though ConfigFile objects can also be used directly without accessing the filesystem. + The following example shows how to parse an INI-style file from the system, read its contents and store new values in it: [codeblock] var config = ConfigFile.new() var err = config.load("user://settings.cfg") if err == OK: # if not, something went wrong with the file loading # Look for the display/width pair, and default to 1024 if missing var screen_width = get_value("display", "width", 1024) - # Store a variable if and only it hasn't been defined yet + # Store a variable if and only if it hasn't been defined yet if not config.has_section_key("audio", "mute"): config.set_value("audio", "mute", false) # Save the changes by overwriting the previous file @@ -30,6 +37,7 @@ <argument index="0" name="section" type="String"> </argument> <description> + Deletes the specified section along with all the key-value pairs inside. </description> </method> <method name="get_section_keys" qualifiers="const"> @@ -38,14 +46,14 @@ <argument index="0" name="section" type="String"> </argument> <description> - Return an array of all defined key identifiers in the specified section. + Returns an array of all defined key identifiers in the specified section. </description> </method> <method name="get_sections" qualifiers="const"> <return type="PoolStringArray"> </return> <description> - Return an array of all defined section identifiers. + Returns an array of all defined section identifiers. </description> </method> <method name="get_value" qualifiers="const"> @@ -58,7 +66,7 @@ <argument index="2" name="default" type="Variant" default="null"> </argument> <description> - Return the current value for the specified section and key. If the section and/or the key do not exist, the method returns the value of the optional [i]default[/i] argument (and thus [code]NULL[/code] if not specified). + Returns the current value for the specified section and key. If the section and/or the key do not exist, the method returns the value of the optional [code]default[/code] argument, or [code]null[/code] if it is omitted. </description> </method> <method name="has_section" qualifiers="const"> @@ -67,7 +75,7 @@ <argument index="0" name="section" type="String"> </argument> <description> - Check if the specified section exists. + Returns [code]true[/code] if the specified section exists. </description> </method> <method name="has_section_key" qualifiers="const"> @@ -78,7 +86,7 @@ <argument index="1" name="key" type="String"> </argument> <description> - Check if the specified section-key pair exists. + Returns [code]true[/code] if the specified section-key pair exists. </description> </method> <method name="load"> @@ -87,7 +95,7 @@ <argument index="0" name="path" type="String"> </argument> <description> - Load the config file specified as a parameter. The file's contents are parsed and loaded in the ConfigFile object from which the method was called. The return value is one of the OK, FAILED or ERR_* constants listed in [@Global Scope] (if the load was successful, it returns OK). + Loads the config file specified as a parameter. The file's contents are parsed and loaded in the ConfigFile object which the method was called on. Returns one of the [code]OK[/code], [code]FAILED[/code] or [code]ERR_*[/code] constants listed in [@Global Scope]. If the load was successful, the return value is [code]OK[/code]. </description> </method> <method name="save"> @@ -96,8 +104,7 @@ <argument index="0" name="path" type="String"> </argument> <description> - Save the contents of the ConfigFile object to the file specified as a parameter. The output file uses an INI-style structure. - The return value is one of the OK, FAILED or ERR_* constants listed in [@Global Scope] (if the save was successful, it returns OK). + Saves the contents of the ConfigFile object to the file specified as a parameter. The output file uses an INI-style structure. Returns one of the [code]OK[/code], [code]FAILED[/code] or [code]ERR_*[/code] constants listed in [@Global Scope]. If the load was successful, the return value is [code]OK[/code]. </description> </method> <method name="set_value"> @@ -110,7 +117,7 @@ <argument index="2" name="value" type="Variant"> </argument> <description> - Assign a value to the specified key of the the specified section. If the section and/or the key do not exist, they are created. Passing a [code]NULL[/code] value deletes the specified key if it exists (and deletes the section if it ends up empty once the key has been removed). + Assigns a value to the specified key of the the specified section. If the section and/or the key do not exist, they are created. Passing a [code]null[/code] value deletes the specified key if it exists, and deletes the section if it ends up empty once the key has been removed. </description> </method> </methods> diff --git a/doc/classes/DynamicFont.xml b/doc/classes/DynamicFont.xml index e4ce2ff3f0..c130add523 100644 --- a/doc/classes/DynamicFont.xml +++ b/doc/classes/DynamicFont.xml @@ -1,8 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="DynamicFont" inherits="Font" category="Core" version="3.0.alpha.custom_build"> <brief_description> + DynamicFont renders vector font files at runtime. </brief_description> <description> + DynamicFont renders vector font files (such as TTF or OTF) dynamically at runtime instead of using a prerendered texture atlas like [BitmapFont]. This trades the faster loading time of [BitmapFont]\ s for the ability to change font parameters like size and spacing during runtime. [DynamicFontData] is used for referencing the font file paths. </description> <tutorials> </tutorials> @@ -15,6 +17,7 @@ <argument index="0" name="data" type="DynamicFontData"> </argument> <description> + Adds a fallback font. </description> </method> <method name="get_fallback" qualifiers="const"> @@ -23,12 +26,14 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Returns the fallback font at index [code]idx[/code]. </description> </method> <method name="get_fallback_count" qualifiers="const"> <return type="int"> </return> <description> + Returns the number of fallback fonts. </description> </method> <method name="get_font_data" qualifiers="const"> @@ -41,6 +46,7 @@ <return type="int"> </return> <description> + Returns the font size in pixels. </description> </method> <method name="get_spacing" qualifiers="const"> @@ -49,18 +55,21 @@ <argument index="0" name="type" type="int"> </argument> <description> + Returns the given type of spacing in pixels. See [code]SPACING_*[/code] constants. </description> </method> <method name="get_use_filter" qualifiers="const"> <return type="bool"> </return> <description> + Returns [code]true[/code] if filtering is used. </description> </method> <method name="get_use_mipmaps" qualifiers="const"> <return type="bool"> </return> <description> + Returns [code]true[/code] if mipmapping is used. </description> </method> <method name="remove_fallback"> @@ -69,6 +78,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Removes the fallback font at index [code]idx[/code]. </description> </method> <method name="set_fallback"> @@ -79,6 +89,7 @@ <argument index="1" name="data" type="DynamicFontData"> </argument> <description> + Sets the fallback font at index [code]idx[/code]. </description> </method> <method name="set_font_data"> @@ -87,6 +98,7 @@ <argument index="0" name="data" type="DynamicFontData"> </argument> <description> + Sets the [DynamicFontData]. </description> </method> <method name="set_size"> @@ -95,6 +107,7 @@ <argument index="0" name="data" type="int"> </argument> <description> + Sets the font size. </description> </method> <method name="set_spacing"> @@ -105,6 +118,7 @@ <argument index="1" name="value" type="int"> </argument> <description> + Sets the spacing of the given type. See [code]SPACING_*[/code] constants. </description> </method> <method name="set_use_filter"> @@ -113,6 +127,7 @@ <argument index="0" name="enable" type="bool"> </argument> <description> + Set to [code]true[/code] to use filtering. </description> </method> <method name="set_use_mipmaps"> @@ -121,35 +136,48 @@ <argument index="0" name="enable" type="bool"> </argument> <description> + Set to [code]true[/code] to use mipmapping. </description> </method> </methods> <members> <member name="extra_spacing_bottom" type="int" setter="set_spacing" getter="get_spacing"> + Extra spacing at the bottom in pixels. </member> <member name="extra_spacing_char" type="int" setter="set_spacing" getter="get_spacing"> + Extra character spacing in pixels. </member> <member name="extra_spacing_space" type="int" setter="set_spacing" getter="get_spacing"> + Extra space spacing in pixels. </member> <member name="extra_spacing_top" type="int" setter="set_spacing" getter="get_spacing"> + Extra spacing at the top in pixels. </member> <member name="font_data" type="DynamicFontData" setter="set_font_data" getter="get_font_data"> + The font data. </member> <member name="size" type="int" setter="set_size" getter="get_size"> + The font size. </member> <member name="use_filter" type="bool" setter="set_use_filter" getter="get_use_filter"> + If [code]true[/code] filtering is used. </member> <member name="use_mipmaps" type="bool" setter="set_use_mipmaps" getter="get_use_mipmaps"> + If [code]true[/code] mipmapping is used. </member> </members> <constants> <constant name="SPACING_TOP" value="0"> + Spacing at the top. </constant> <constant name="SPACING_BOTTOM" value="1"> + Spacing at the bottom. </constant> <constant name="SPACING_CHAR" value="2"> + Character spacing. </constant> <constant name="SPACING_SPACE" value="3"> + Space spacing. </constant> </constants> </class> diff --git a/doc/classes/DynamicFontData.xml b/doc/classes/DynamicFontData.xml index 51e4e0d231..9012b46e08 100644 --- a/doc/classes/DynamicFontData.xml +++ b/doc/classes/DynamicFontData.xml @@ -1,8 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="DynamicFontData" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> <brief_description> + Used with [DynamicFont] to describe the location of a font file. </brief_description> <description> + Used with [DynamicFont] to describe the location of a vector font file for dynamic rendering at runtime. </description> <tutorials> </tutorials> @@ -13,6 +15,7 @@ <return type="String"> </return> <description> + Returns the font path. </description> </method> <method name="set_font_path"> @@ -21,11 +24,13 @@ <argument index="0" name="path" type="String"> </argument> <description> + Sets the font path. </description> </method> </methods> <members> <member name="font_path" type="String" setter="set_font_path" getter="get_font_path"> + The path to the vector font file. </member> </members> <constants> diff --git a/doc/classes/EditorImportPlugin.xml b/doc/classes/EditorImportPlugin.xml index 05319e926c..da8f0f235b 100644 --- a/doc/classes/EditorImportPlugin.xml +++ b/doc/classes/EditorImportPlugin.xml @@ -35,7 +35,7 @@ func get_preset_name(i): return "Default" - func get_import_optons(i): + func get_import_options(i): return [{"name": "my_option", "default_value": false}] func load(src, dst, opts, r_platform_variants, r_gen_files): diff --git a/doc/classes/EditorResourcePreview.xml b/doc/classes/EditorResourcePreview.xml index acf36b6a08..5174d9243b 100644 --- a/doc/classes/EditorResourcePreview.xml +++ b/doc/classes/EditorResourcePreview.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="EditorResourcePreview" inherits="Node" category="Core" version="3.0.alpha.custom_build"> <brief_description> - Helper to generate previews of reources or files. + Helper to generate previews of resources or files. </brief_description> <description> This object is used to generate previews for resources of files. diff --git a/doc/classes/EditorSelection.xml b/doc/classes/EditorSelection.xml index 8d9bdd2c05..a6dc60ee7b 100644 --- a/doc/classes/EditorSelection.xml +++ b/doc/classes/EditorSelection.xml @@ -31,7 +31,7 @@ <return type="Array"> </return> <description> - Get the list of selectes nodes. + Get the list of selected nodes. </description> </method> <method name="get_transformable_selected_nodes"> diff --git a/doc/classes/EditorSpatialGizmo.xml b/doc/classes/EditorSpatialGizmo.xml index baab995fab..545eadeed2 100644 --- a/doc/classes/EditorSpatialGizmo.xml +++ b/doc/classes/EditorSpatialGizmo.xml @@ -96,7 +96,7 @@ <argument index="2" name="cancel" type="bool" default="false"> </argument> <description> - Commit a handle being edited (handles must have been prevously added by [method add_handles]). + Commit a handle being edited (handles must have been previously added by [method add_handles]). If the cancel parameter is true, an option to restore the edited value to the original is provided. </description> </method> diff --git a/doc/classes/FileDialog.xml b/doc/classes/FileDialog.xml index d7a08368a5..b3d131ca40 100644 --- a/doc/classes/FileDialog.xml +++ b/doc/classes/FileDialog.xml @@ -86,7 +86,7 @@ <return type="bool"> </return> <description> - Return true if the diaog allows show hidden files. + Return true if the dialog allows show hidden files. </description> </method> <method name="set_access"> @@ -205,10 +205,10 @@ The dialog allows the selection of file and directory. </constant> <constant name="ACCESS_USERDATA" value="1"> - The dialog allows ascess files under [Resource] path(res://) . + The dialog allows access files under [Resource] path(res://) . </constant> <constant name="ACCESS_FILESYSTEM" value="2"> - The dialog allows ascess files in whole file system. + The dialog allows access files in whole file system. </constant> </constants> <theme_items> diff --git a/doc/classes/GDNative.xml b/doc/classes/GDNative.xml deleted file mode 100644 index ba813c4564..0000000000 --- a/doc/classes/GDNative.xml +++ /dev/null @@ -1,57 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="GDNative" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> - <brief_description> - </brief_description> - <description> - </description> - <tutorials> - </tutorials> - <demos> - </demos> - <methods> - <method name="call_native"> - <return type="Variant"> - </return> - <argument index="0" name="procedure_name" type="String"> - </argument> - <argument index="1" name="arguments" type="String"> - </argument> - <argument index="2" name="arg2" type="Array"> - </argument> - <description> - </description> - </method> - <method name="get_library"> - <return type="GDNativeLibrary"> - </return> - <description> - </description> - </method> - <method name="initialize"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_library"> - <return type="void"> - </return> - <argument index="0" name="library" type="GDNativeLibrary"> - </argument> - <description> - </description> - </method> - <method name="terminate"> - <return type="bool"> - </return> - <description> - </description> - </method> - </methods> - <members> - <member name="library" type="GDNativeLibrary" setter="set_library" getter="get_library"> - </member> - </members> - <constants> - </constants> -</class> diff --git a/doc/classes/GDNativeLibrary.xml b/doc/classes/GDNativeLibrary.xml deleted file mode 100644 index 361c89e6b3..0000000000 --- a/doc/classes/GDNativeLibrary.xml +++ /dev/null @@ -1,57 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="GDNativeLibrary" inherits="Resource" category="Core" version="3.0.alpha.custom_build"> - <brief_description> - </brief_description> - <description> - </description> - <tutorials> - </tutorials> - <demos> - </demos> - <methods> - <method name="get_active_library_path" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="get_library_path" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="platform" type="String"> - </argument> - <description> - </description> - </method> - <method name="is_singleton_gdnative" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> - <method name="set_library_path"> - <return type="void"> - </return> - <argument index="0" name="platform" type="String"> - </argument> - <argument index="1" name="path" type="String"> - </argument> - <description> - </description> - </method> - <method name="set_singleton_gdnative"> - <return type="void"> - </return> - <argument index="0" name="singleton" type="bool"> - </argument> - <description> - </description> - </method> - </methods> - <members> - <member name="singleton_gdnative" type="bool" setter="set_singleton_gdnative" getter="is_singleton_gdnative"> - </member> - </members> - <constants> - </constants> -</class> diff --git a/doc/classes/Generic6DOFJoint.xml b/doc/classes/Generic6DOFJoint.xml index 4b782e994a..89ec1fd836 100644 --- a/doc/classes/Generic6DOFJoint.xml +++ b/doc/classes/Generic6DOFJoint.xml @@ -1,8 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="Generic6DOFJoint" inherits="Joint" category="Core" version="3.0.alpha.custom_build"> <brief_description> + The generic 6 degrees of freedom joint can implement a variety of joint-types by locking certain axes' rotation or translation. </brief_description> <description> + The first 3 dof axes are linear axes, which represent translation of Bodies, and the latter 3 dof axes represent the angular motion. Each axis can be either locked, or limited. </description> <tutorials> </tutorials> @@ -120,146 +122,217 @@ </methods> <members> <member name="angular_limit_x/damping" type="float" setter="set_param_x" getter="get_param_x"> + The amount of rotational damping across the x-axis. + The lower, the longer an impulse from one side takes to travel to the other side. </member> <member name="angular_limit_x/enabled" type="bool" setter="set_flag_x" getter="get_flag_x"> + If [code]true[/code] rotation across the x-axis is enabled. </member> <member name="angular_limit_x/erp" type="float" setter="set_param_x" getter="get_param_x"> + When rotating across x-axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. </member> <member name="angular_limit_x/force_limit" type="float" setter="set_param_x" getter="get_param_x"> + The maximum amount of force that can occur, when rotating arround x-axis. </member> <member name="angular_limit_x/lower_angle" type="float" setter="_set_angular_lo_limit_x" getter="_get_angular_lo_limit_x"> + The minimum rotation in negative direction to break loose and rotate arround the x-axis. </member> <member name="angular_limit_x/restitution" type="float" setter="set_param_x" getter="get_param_x"> + The amount of rotational restitution across the x-axis. The lower, the more restitution occurs. </member> <member name="angular_limit_x/softness" type="float" setter="set_param_x" getter="get_param_x"> + The speed of all rotations across the x-axis. </member> <member name="angular_limit_x/upper_angle" type="float" setter="_set_angular_hi_limit_x" getter="_get_angular_hi_limit_x"> + The minimum rotation in positive direction to break loose and rotate arround the x-axis. </member> <member name="angular_limit_y/damping" type="float" setter="set_param_y" getter="get_param_y"> + The amount of rotational damping across the y-axis. The lower, the more dampening occurs. </member> <member name="angular_limit_y/enabled" type="bool" setter="set_flag_y" getter="get_flag_y"> + If [code]true[/code] rotation across the y-axis is enabled. </member> <member name="angular_limit_y/erp" type="float" setter="set_param_y" getter="get_param_y"> + When rotating across y-axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. </member> <member name="angular_limit_y/force_limit" type="float" setter="set_param_y" getter="get_param_y"> + The maximum amount of force that can occur, when rotating arround y-axis. </member> <member name="angular_limit_y/lower_angle" type="float" setter="_set_angular_lo_limit_y" getter="_get_angular_lo_limit_y"> + The minimum rotation in negative direction to break loose and rotate arround the y-axis. </member> <member name="angular_limit_y/restitution" type="float" setter="set_param_y" getter="get_param_y"> + The amount of rotational restitution across the y-axis. The lower, the more restitution occurs. </member> <member name="angular_limit_y/softness" type="float" setter="set_param_y" getter="get_param_y"> + The speed of all rotations across the y-axis. </member> <member name="angular_limit_y/upper_angle" type="float" setter="_set_angular_hi_limit_y" getter="_get_angular_hi_limit_y"> + The minimum rotation in positive direction to break loose and rotate arround the y-axis. </member> <member name="angular_limit_z/damping" type="float" setter="set_param_z" getter="get_param_z"> + The amount of rotational damping across the z-axis. The lower, the more dampening occurs. </member> <member name="angular_limit_z/enabled" type="bool" setter="set_flag_z" getter="get_flag_z"> + If [code]true[/code] rotation across the z-axis is enabled. </member> <member name="angular_limit_z/erp" type="float" setter="set_param_z" getter="get_param_z"> + When rotating across z-axis, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. </member> <member name="angular_limit_z/force_limit" type="float" setter="set_param_z" getter="get_param_z"> + The maximum amount of force that can occur, when rotating arround z-axis. </member> <member name="angular_limit_z/lower_angle" type="float" setter="_set_angular_lo_limit_z" getter="_get_angular_lo_limit_z"> + The minimum rotation in negative direction to break loose and rotate arround the z-axis. </member> <member name="angular_limit_z/restitution" type="float" setter="set_param_z" getter="get_param_z"> + The amount of rotational restitution across the z-axis. The lower, the more restitution occurs. </member> <member name="angular_limit_z/softness" type="float" setter="set_param_z" getter="get_param_z"> + The speed of all rotations across the z-axis. </member> <member name="angular_limit_z/upper_angle" type="float" setter="_set_angular_hi_limit_z" getter="_get_angular_hi_limit_z"> + The minimum rotation in positive direction to break loose and rotate arround the z-axis. </member> <member name="angular_motor_x/enabled" type="bool" setter="set_flag_x" getter="get_flag_x"> + If [code]true[/code] a rotating motor at the x-axis is enabled. </member> <member name="angular_motor_x/force_limit" type="float" setter="set_param_x" getter="get_param_x"> + Maximum acceleration for the motor at the x-axis. </member> <member name="angular_motor_x/target_velocity" type="float" setter="set_param_x" getter="get_param_x"> + Target speed for the motor at the x-axis. </member> <member name="angular_motor_y/enabled" type="bool" setter="set_flag_y" getter="get_flag_y"> + If [code]true[/code] a rotating motor at the y-axis is enabled. </member> <member name="angular_motor_y/force_limit" type="float" setter="set_param_y" getter="get_param_y"> + Maximum acceleration for the motor at the y-axis. </member> <member name="angular_motor_y/target_velocity" type="float" setter="set_param_y" getter="get_param_y"> + Target speed for the motor at the y-axis. </member> <member name="angular_motor_z/enabled" type="bool" setter="set_flag_z" getter="get_flag_z"> + If [code]true[/code] a rotating motor at the z-axis is enabled. </member> <member name="angular_motor_z/force_limit" type="float" setter="set_param_z" getter="get_param_z"> + Maximum acceleration for the motor at the z-axis. </member> <member name="angular_motor_z/target_velocity" type="float" setter="set_param_z" getter="get_param_z"> + Target speed for the motor at the z-axis. </member> <member name="linear_limit_x/damping" type="float" setter="set_param_x" getter="get_param_x"> + The amount of damping that happens at the x-motion. </member> <member name="linear_limit_x/enabled" type="bool" setter="set_flag_x" getter="get_flag_x"> + If [code]true[/code] the linear motion across the x-axis is enabled. </member> <member name="linear_limit_x/lower_distance" type="float" setter="set_param_x" getter="get_param_x"> + The minimum difference between the pivot points' x-axis. </member> <member name="linear_limit_x/restitution" type="float" setter="set_param_x" getter="get_param_x"> + The amount of restitution on the x-axis movement The lower, the more momentum gets lost. </member> <member name="linear_limit_x/softness" type="float" setter="set_param_x" getter="get_param_x"> + A factor applied to the movement across the x-axis The lower, the slower the movement. </member> <member name="linear_limit_x/upper_distance" type="float" setter="set_param_x" getter="get_param_x"> + The maximum difference between the pivot points' x-axis. </member> <member name="linear_limit_y/damping" type="float" setter="set_param_y" getter="get_param_y"> + The amount of damping that happens at the y-motion. </member> <member name="linear_limit_y/enabled" type="bool" setter="set_flag_y" getter="get_flag_y"> + If [code]true[/code] the linear motion across the y-axis is enabled. </member> <member name="linear_limit_y/lower_distance" type="float" setter="set_param_y" getter="get_param_y"> + The minimum difference between the pivot points' y-axis. </member> <member name="linear_limit_y/restitution" type="float" setter="set_param_y" getter="get_param_y"> + The amount of restitution on the y-axis movement The lower, the more momentum gets lost. </member> <member name="linear_limit_y/softness" type="float" setter="set_param_y" getter="get_param_y"> + A factor applied to the movement across the y-axis The lower, the slower the movement. </member> <member name="linear_limit_y/upper_distance" type="float" setter="set_param_y" getter="get_param_y"> + The maximum difference between the pivot points' y-axis. </member> <member name="linear_limit_z/damping" type="float" setter="set_param_z" getter="get_param_z"> + The amount of damping that happens at the z-motion. </member> <member name="linear_limit_z/enabled" type="bool" setter="set_flag_z" getter="get_flag_z"> + If [code]true[/code] the linear motion across the z-axis is enabled. </member> <member name="linear_limit_z/lower_distance" type="float" setter="set_param_z" getter="get_param_z"> + The minimum difference between the pivot points' z-axis. </member> <member name="linear_limit_z/restitution" type="float" setter="set_param_z" getter="get_param_z"> + The amount of restitution on the z-axis movement The lower, the more momentum gets lost. </member> <member name="linear_limit_z/softness" type="float" setter="set_param_z" getter="get_param_z"> + A factor applied to the movement across the z-axis The lower, the slower the movement. </member> <member name="linear_limit_z/upper_distance" type="float" setter="set_param_z" getter="get_param_z"> + The maximum difference between the pivot points' z-axis. </member> </members> <constants> <constant name="PARAM_LINEAR_LOWER_LIMIT" value="0"> + The minimum difference between the pivot points' axes. </constant> <constant name="PARAM_LINEAR_UPPER_LIMIT" value="1"> + The maximum difference between the pivot points' axes. </constant> <constant name="PARAM_LINEAR_LIMIT_SOFTNESS" value="2"> + A factor applied to the movement across the axes The lower, the slower the movement. </constant> <constant name="PARAM_LINEAR_RESTITUTION" value="3"> + The amount of restitution on the axes movement The lower, the more momentum gets lost. </constant> <constant name="PARAM_LINEAR_DAMPING" value="4"> + The amount of damping that happens at the linear motion across the axes. </constant> <constant name="PARAM_ANGULAR_LOWER_LIMIT" value="5"> + The minimum rotation in negative direction to break loose and rotate arround the axes. </constant> <constant name="PARAM_ANGULAR_UPPER_LIMIT" value="6"> + The minimum rotation in positive direction to break loose and rotate arround the axes. </constant> <constant name="PARAM_ANGULAR_LIMIT_SOFTNESS" value="7"> + The speed of all rotations across the axes. </constant> <constant name="PARAM_ANGULAR_DAMPING" value="8"> + The amount of rotational damping across the axes. The lower, the more dampening occurs. </constant> <constant name="PARAM_ANGULAR_RESTITUTION" value="9"> + The amount of rotational restitution across the axes. The lower, the more restitution occurs. </constant> <constant name="PARAM_ANGULAR_FORCE_LIMIT" value="10"> + The maximum amount of force that can occur, when rotating arround the axes. </constant> <constant name="PARAM_ANGULAR_ERP" value="11"> + When rotating across the axes, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. </constant> <constant name="PARAM_ANGULAR_MOTOR_TARGET_VELOCITY" value="12"> + Target speed for the motor at the axes. </constant> <constant name="PARAM_ANGULAR_MOTOR_FORCE_LIMIT" value="13"> + Maximum acceleration for the motor at the axes. </constant> <constant name="PARAM_MAX" value="14"> + End flag of PARAM_* constants, used internally. </constant> <constant name="FLAG_ENABLE_LINEAR_LIMIT" value="0"> + If [code]set[/code] there is linear motion possible within the given limits. </constant> <constant name="FLAG_ENABLE_ANGULAR_LIMIT" value="1"> + If [code]set[/code] there is rotational motion possible. </constant> <constant name="FLAG_ENABLE_MOTOR" value="2"> + If [code]set[/code] there is a rotational motor across these axes. </constant> <constant name="FLAG_MAX" value="3"> + End flag of FLAG_* constants, used internally. </constant> </constants> </class> diff --git a/doc/classes/HTTPRequest.xml b/doc/classes/HTTPRequest.xml index c2839890cf..b780d29d0e 100644 --- a/doc/classes/HTTPRequest.xml +++ b/doc/classes/HTTPRequest.xml @@ -166,7 +166,7 @@ Request does not have a response(yet). </constant> <constant name="RESULT_BODY_SIZE_LIMIT_EXCEEDED" value="7"> - Request exceded its maximum size limit, see [method set_body_size_limit]. + Request exceeded its maximum size limit, see [method set_body_size_limit]. </constant> <constant name="RESULT_REQUEST_FAILED" value="8"> Request failed. (unused) diff --git a/doc/classes/HingeJoint.xml b/doc/classes/HingeJoint.xml index ae3693c3a4..d18e63f8a3 100644 --- a/doc/classes/HingeJoint.xml +++ b/doc/classes/HingeJoint.xml @@ -1,8 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="HingeJoint" inherits="Joint" category="Core" version="3.0.alpha.custom_build"> <brief_description> + A hinge between two 3D bodies. </brief_description> <description> + Normaly uses the z-axis of body A as the hinge axis, another axis can be specified when adding it manually though. </description> <tutorials> </tutorials> @@ -48,50 +50,70 @@ </methods> <members> <member name="angular_limit/bias" type="float" setter="set_param" getter="get_param"> + The speed with which the rotation across the axis perpendicular to the hinge gets corrected. </member> <member name="angular_limit/enable" type="bool" setter="set_flag" getter="get_flag"> + If [code]true[/code] the hinges maximum and minimum rotation, defined by [member angular_limit/lower] and [member angular_limit/upper] has effects. </member> <member name="angular_limit/lower" type="float" setter="_set_lower_limit" getter="_get_lower_limit"> + The minimum rotation. only active if [member angular_limit/enable] is [code]true[/code]. </member> <member name="angular_limit/relaxation" type="float" setter="set_param" getter="get_param"> + The lower this value, the more the rotation gets slowed down. </member> <member name="angular_limit/softness" type="float" setter="set_param" getter="get_param"> </member> <member name="angular_limit/upper" type="float" setter="_set_upper_limit" getter="_get_upper_limit"> + The maximum rotation. only active if [member angular_limit/enable] is [code]true[/code]. </member> <member name="motor/enable" type="bool" setter="set_flag" getter="get_flag"> + When activated, a motor turns the hinge. </member> <member name="motor/max_impulse" type="float" setter="set_param" getter="get_param"> + Maximum acceleration for the motor. </member> <member name="motor/target_velocity" type="float" setter="set_param" getter="get_param"> + Target speed for the motor. </member> <member name="params/bias" type="float" setter="set_param" getter="get_param"> + The speed with wich the two bodies get pulled together when they move in different directions. </member> </members> <constants> <constant name="PARAM_BIAS" value="0"> + The speed with wich the two bodies get pulled together when they move in different directions. </constant> <constant name="PARAM_LIMIT_UPPER" value="1"> + The maximum rotation. only active if [member angular_limit/enable] is [code]true[/code]. </constant> <constant name="PARAM_LIMIT_LOWER" value="2"> + The minimum rotation. only active if [member angular_limit/enable] is [code]true[/code]. </constant> <constant name="PARAM_LIMIT_BIAS" value="3"> + The speed with which the rotation across the axis perpendicular to the hinge gets corrected. </constant> <constant name="PARAM_LIMIT_SOFTNESS" value="4"> </constant> <constant name="PARAM_LIMIT_RELAXATION" value="5"> + The lower this value, the more the rotation gets slowed down. </constant> <constant name="PARAM_MOTOR_TARGET_VELOCITY" value="6"> + Target speed for the motor. </constant> <constant name="PARAM_MOTOR_MAX_IMPULSE" value="7"> + Maximum acceleration for the motor. </constant> <constant name="PARAM_MAX" value="8"> + End flag of PARAM_* constants, used internally. </constant> <constant name="FLAG_USE_LIMIT" value="0"> + If [code]true[/code] the hinges maximum and minimum rotation, defined by [member angular_limit/lower] and [member angular_limit/upper] has effects. </constant> <constant name="FLAG_ENABLE_MOTOR" value="1"> + When activated, a motor turns the hinge. </constant> <constant name="FLAG_MAX" value="2"> + End flag of FLAG_* constants, used internally. </constant> </constants> </class> diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml index e56200f63d..d2d01dacb4 100644 --- a/doc/classes/Input.xml +++ b/doc/classes/Input.xml @@ -4,7 +4,7 @@ A Singleton that deals with inputs. </brief_description> <description> - A Singleton that deals with inputs. This includes key presses, mouse buttons and movement, joypads, and input actions. + A Singleton that deals with inputs. This includes key presses, mouse buttons and movement, joypads, and input actions. Actions and their events can be set in the Project Settings / Input Map tab. Or be set with [InputMap]. </description> <tutorials> </tutorials> @@ -75,7 +75,7 @@ <argument index="1" name="axis" type="int"> </argument> <description> - Returns the current value of the joypad axis at given index (see JOY_* constants in [@Global Scope]) + Returns the current value of the joypad axis at given index (see [code]JOY_*[/code] constants in [@Global Scope]) </description> </method> <method name="get_joy_axis_index_from_string"> @@ -180,6 +180,7 @@ <argument index="0" name="action" type="String"> </argument> <description> + Returns [code]true[/code] when you start pressing the action event. </description> </method> <method name="is_action_just_released" qualifiers="const"> @@ -188,6 +189,7 @@ <argument index="0" name="action" type="String"> </argument> <description> + Returns [code]true[/code] when you stop pressing the action event. </description> </method> <method name="is_action_pressed" qualifiers="const"> @@ -196,7 +198,7 @@ <argument index="0" name="action" type="String"> </argument> <description> - Returns true or false depending on whether the action event is pressed. Actions and their events can be set in the Project Settings / Input Map tab. Or be set with [InputMap]. + Returns [code]true[/code] if you are pressing the action event. </description> </method> <method name="is_joy_button_pressed" qualifiers="const"> @@ -207,7 +209,7 @@ <argument index="1" name="button" type="int"> </argument> <description> - Returns if the joypad button at the given index is currently pressed. (see JOY_* constants in [@Global Scope]) + Returns [code]true[/code] if you are pressing the joypad button. (see [code]JOY_*[/code] constants in [@Global Scope]) </description> </method> <method name="is_joy_known"> @@ -216,7 +218,7 @@ <argument index="0" name="device" type="int"> </argument> <description> - 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 joypads are not expected to match these constants, but you can still retrieve events from them. + Returns [code]true[/code] if the system knows the specified device. This means that it sets all button and axis indices exactly as defined in the [code]JOY_*[/code] constants (see [@Global Scope]). Unknown joypads are not expected to match these constants, but you can still retrieve events from them. </description> </method> <method name="is_key_pressed" qualifiers="const"> @@ -225,7 +227,7 @@ <argument index="0" name="scancode" type="int"> </argument> <description> - Returns true or false depending on whether the key is pressed or not. You can pass KEY_*, which are pre-defined constants listed in [@Global Scope]. + Returns [code]true[/code] if you are pressing the key. You can pass [code]KEY_*[/code], which are pre-defined constants listed in [@Global Scope]. </description> </method> <method name="is_mouse_button_pressed" qualifiers="const"> @@ -234,7 +236,7 @@ <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]. + Returns [code]true[/code] if you are pressing the mouse button. You can pass [code]BUTTON_*[/code], which are pre-defined constants listed in [@Global Scope]. </description> </method> <method name="joy_connection_changed"> diff --git a/doc/classes/ItemList.xml b/doc/classes/ItemList.xml index a8d879888f..37c1db51f5 100644 --- a/doc/classes/ItemList.xml +++ b/doc/classes/ItemList.xml @@ -217,7 +217,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Returns whether the tooptip is enabled for specified item index. + Returns whether the tooltip is enabled for specified item index. </description> </method> <method name="is_same_column_width" qualifiers="const"> @@ -511,7 +511,7 @@ <argument index="1" name="selected" type="bool"> </argument> <description> - Fired when a multiple selection is altered on a list allowing mutliple selection. + Fired when a multiple selection is altered on a list allowing multiple selection. </description> </signal> </signals> diff --git a/doc/classes/JSONParseResult.xml b/doc/classes/JSONParseResult.xml index 86edaaf1e6..db9a681896 100644 --- a/doc/classes/JSONParseResult.xml +++ b/doc/classes/JSONParseResult.xml @@ -79,7 +79,7 @@ The error message if JSON source was not successfully parsed. See [@Global Scope]ERR_* constants. </member> <member name="result" type="Variant" setter="set_result" getter="get_result"> - A [Variant] containing the parsed JSON. Use typeof() to check if it is what you expect. For exemple, if JSON source starts with braces [code]{}[/code] a [Dictionary] will be returned, if JSON source starts with array braces [code][][/code] an [Array] will be returned. + A [Variant] containing the parsed JSON. Use typeof() to check if it is what you expect. For example, if JSON source starts with braces [code]{}[/code] a [Dictionary] will be returned, if JSON source starts with array braces [code][][/code] an [Array] will be returned. [i]Be aware that the JSON specification does not define integer or float types, but only a number type. Therefore, parsing a JSON text will convert all numerical values to float types.[/i] [codeblock] p = JSON.parse('["hello", "world", "!"]') diff --git a/doc/classes/Joint.xml b/doc/classes/Joint.xml index 2e7d24aac1..901f84fe5e 100644 --- a/doc/classes/Joint.xml +++ b/doc/classes/Joint.xml @@ -1,8 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="Joint" inherits="Spatial" category="Core" version="3.0.alpha.custom_build"> <brief_description> + Base class for all 3D joints </brief_description> <description> + All 3D joints link two nodes, has a priority, and can decide if the two bodies of the nodes should be able to collide with each other </description> <tutorials> </tutorials> @@ -68,12 +70,16 @@ </methods> <members> <member name="collision/exclude_nodes" type="bool" setter="set_exclude_nodes_from_collision" getter="get_exclude_nodes_from_collision"> + If [code]true[/code] the two bodies of the nodes are not able to collide with each other. </member> <member name="nodes/node_a" type="NodePath" setter="set_node_a" getter="get_node_a"> + The [Node], the first side of the Joint attaches to. </member> <member name="nodes/node_b" type="NodePath" setter="set_node_b" getter="get_node_b"> + The [Node], the second side of the Joint attaches to. </member> <member name="solver/priority" type="int" setter="set_solver_priority" getter="get_solver_priority"> + The order in wich the solver is executed compared to the other [Joints], the lower, the earlier. </member> </members> <constants> diff --git a/doc/classes/NativeScript.xml b/doc/classes/NativeScript.xml deleted file mode 100644 index b040cfd966..0000000000 --- a/doc/classes/NativeScript.xml +++ /dev/null @@ -1,55 +0,0 @@ -<?xml version="1.0" encoding="UTF-8" ?> -<class name="NativeScript" inherits="Script" category="Core" version="3.0.alpha.custom_build"> - <brief_description> - </brief_description> - <description> - </description> - <tutorials> - </tutorials> - <demos> - </demos> - <methods> - <method name="get_class_name" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="get_library" qualifiers="const"> - <return type="GDNativeLibrary"> - </return> - <description> - </description> - </method> - <method name="new" qualifiers="vararg"> - <return type="Object"> - </return> - <description> - </description> - </method> - <method name="set_class_name"> - <return type="void"> - </return> - <argument index="0" name="class_name" type="String"> - </argument> - <description> - </description> - </method> - <method name="set_library"> - <return type="void"> - </return> - <argument index="0" name="library" type="GDNativeLibrary"> - </argument> - <description> - </description> - </method> - </methods> - <members> - <member name="class_name" type="String" setter="set_class_name" getter="get_class_name"> - </member> - <member name="library" type="GDNativeLibrary" setter="set_library" getter="get_library"> - </member> - </members> - <constants> - </constants> -</class> diff --git a/doc/classes/NinePatchRect.xml b/doc/classes/NinePatchRect.xml index 6829b36e14..c74f3c5a68 100644 --- a/doc/classes/NinePatchRect.xml +++ b/doc/classes/NinePatchRect.xml @@ -111,7 +111,7 @@ If [code]true[/code], draw the panel's center. Else, only draw the 9-slice's borders. Default value: [code]true[/code] </member> <member name="patch_margin_bottom" type="int" setter="set_patch_margin" getter="get_patch_margin"> - The height of the 9-slice's bottom row. A margin of 16 means the 9-slice's bottom corners and side will have a height of 16 pixels. You can set all 4 margin values indivually to create panels with non-uniform borders. + The height of the 9-slice's bottom row. A margin of 16 means the 9-slice's bottom corners and side will have a height of 16 pixels. You can set all 4 margin values individually to create panels with non-uniform borders. </member> <member name="patch_margin_left" type="int" setter="set_patch_margin" getter="get_patch_margin"> The height of the 9-slice's left column. diff --git a/doc/classes/Object.xml b/doc/classes/Object.xml index 67421487f1..d30ebfaef8 100644 --- a/doc/classes/Object.xml +++ b/doc/classes/Object.xml @@ -6,7 +6,7 @@ <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 keeps a reference count and deletes itself automatically when no longer referenced) and [Node], which deletes the children tree when deleted. + Some derivatives 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 simpler 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> @@ -165,7 +165,7 @@ <return type="Array"> </return> <description> - Returns an [Array] of dictionaries with informations about signals that are connected to this object. + Returns an [Array] of dictionaries with information about signals that are connected to this object. Inside each [Dictionary] there are 3 fields: - "source" is a reference to signal emitter. - "signal_name" is name of connected signal. diff --git a/doc/classes/Physics2DServer.xml b/doc/classes/Physics2DServer.xml index 37e1567891..edc46a53d0 100644 --- a/doc/classes/Physics2DServer.xml +++ b/doc/classes/Physics2DServer.xml @@ -21,7 +21,7 @@ <argument index="2" name="transform" type="Transform2D" default="Transform2D( 1, 0, 0, 1, 0, 0 )"> </argument> <description> - Add a shape to the area, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. + Adds a shape to the area, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. </description> </method> <method name="area_attach_object_instance_id"> @@ -32,7 +32,7 @@ <argument index="1" name="id" type="int"> </argument> <description> - Assign the area to a descendant of [Object], so it can exist in the node tree. + Assigns the area to a descendant of [Object], so it can exist in the node tree. </description> </method> <method name="area_clear_shapes"> @@ -41,14 +41,14 @@ <argument index="0" name="area" type="RID"> </argument> <description> - Remove all shapes from an area. It does not delete the shapes, so they can be reassigned later. + Removes all shapes from an area. It does not delete the shapes, so they can be reassigned later. </description> </method> <method name="area_create"> <return type="RID"> </return> <description> - Create an [Area2D]. + Creates an [Area2D]. </description> </method> <method name="area_get_object_instance_id" qualifiers="const"> @@ -57,7 +57,7 @@ <argument index="0" name="area" type="RID"> </argument> <description> - Get the instance ID of the object the area is assigned to. + Gets the instance ID of the object the area is assigned to. </description> </method> <method name="area_get_param" qualifiers="const"> @@ -68,7 +68,7 @@ <argument index="1" name="param" type="int" enum="Physics2DServer.AreaParameter"> </argument> <description> - Return an area parameter value. + Returns an area parameter value. A list of available parameters is on the AREA_PARAM_* constants. </description> </method> <method name="area_get_shape" qualifiers="const"> @@ -79,7 +79,7 @@ <argument index="1" name="shape_idx" type="int"> </argument> <description> - Return the [RID] of the nth shape of an area. + Returns the [RID] of the nth shape of an area. </description> </method> <method name="area_get_shape_count" qualifiers="const"> @@ -88,7 +88,7 @@ <argument index="0" name="area" type="RID"> </argument> <description> - Return the number of shapes assigned to an area. + Returns the number of shapes assigned to an area. </description> </method> <method name="area_get_shape_transform" qualifiers="const"> @@ -99,7 +99,7 @@ <argument index="1" name="shape_idx" type="int"> </argument> <description> - Return the transform matrix of a shape within an area. + Returns the transform matrix of a shape within an area. </description> </method> <method name="area_get_space" qualifiers="const"> @@ -108,7 +108,7 @@ <argument index="0" name="area" type="RID"> </argument> <description> - Return the space assigned to the area. + Returns the space assigned to the area. </description> </method> <method name="area_get_space_override_mode" qualifiers="const"> @@ -117,7 +117,7 @@ <argument index="0" name="area" type="RID"> </argument> <description> - Return the space override mode for the area. + Returns the space override mode for the area. </description> </method> <method name="area_get_transform" qualifiers="const"> @@ -126,7 +126,7 @@ <argument index="0" name="area" type="RID"> </argument> <description> - Return the transform matrix for an area. + Returns the transform matrix for an area. </description> </method> <method name="area_remove_shape"> @@ -137,7 +137,7 @@ <argument index="1" name="shape_idx" type="int"> </argument> <description> - Remove a shape from an area. It does not delete the shape, so it can be reassigned later. + Removes a shape from an area. It does not delete the shape, so it can be reassigned later. </description> </method> <method name="area_set_collision_layer"> @@ -148,7 +148,7 @@ <argument index="1" name="layer" type="int"> </argument> <description> - Assign the area to one or many physics layers. + Assigns the area to one or many physics layers. </description> </method> <method name="area_set_collision_mask"> @@ -159,7 +159,7 @@ <argument index="1" name="mask" type="int"> </argument> <description> - Set which physics layers the area will monitor. + Sets which physics layers the area will monitor. </description> </method> <method name="area_set_monitor_callback"> @@ -172,7 +172,7 @@ <argument index="2" name="method" type="String"> </argument> <description> - Set the function to call when any body/area enters or exits the area. This callback will be called for any object interacting with the area, and takes five parameters: + Sets the function to call when any body/area enters or exits the area. This callback will be called for any object interacting with the area, and takes five parameters: 1: AREA_BODY_ADDED or AREA_BODY_REMOVED, depending on whether the object entered or exited the area. 2: [RID] of the object that entered/exited the area. 3: Instance ID of the object that entered/exited the area. @@ -190,7 +190,7 @@ <argument index="2" name="value" type="Variant"> </argument> <description> - Set the value for an area parameter. A list of available parameters is on the AREA_PARAM_* constants. + Sets the value for an area parameter. A list of available parameters is on the AREA_PARAM_* constants. </description> </method> <method name="area_set_shape"> @@ -203,7 +203,7 @@ <argument index="2" name="shape" type="RID"> </argument> <description> - Substitute a given area shape by another. The old shape is selected by its index, the new one by its [RID]. + Substitutes a given area shape by another. The old shape is selected by its index, the new one by its [RID]. </description> </method> <method name="area_set_shape_disabled"> @@ -216,6 +216,7 @@ <argument index="2" name="disable" type="bool"> </argument> <description> + Disables a given shape in this area if [code]disable is true[/code] </description> </method> <method name="area_set_shape_transform"> @@ -228,7 +229,7 @@ <argument index="2" name="transform" type="Transform2D"> </argument> <description> - Set the transform matrix for an area shape. + Sets the transform matrix for an area shape. </description> </method> <method name="area_set_space"> @@ -239,7 +240,7 @@ <argument index="1" name="space" type="RID"> </argument> <description> - Assign a space to the area. + Assigns a space to the area. </description> </method> <method name="area_set_space_override_mode"> @@ -250,7 +251,7 @@ <argument index="1" name="mode" type="int" enum="Physics2DServer.AreaSpaceOverrideMode"> </argument> <description> - Set the space override mode for the area. The modes are described in the constants AREA_SPACE_OVERRIDE_*. + Sets the space override mode for the area. The modes are described in the constants AREA_SPACE_OVERRIDE_*. </description> </method> <method name="area_set_transform"> @@ -261,7 +262,7 @@ <argument index="1" name="transform" type="Transform2D"> </argument> <description> - Set the transform matrix for an area. + Sets the transform matrix for an area. </description> </method> <method name="body_add_collision_exception"> @@ -272,7 +273,7 @@ <argument index="1" name="excepted_body" type="RID"> </argument> <description> - Add a body to the list of bodies exempt from collisions. + Adds a body to the list of bodies exempt from collisions. </description> </method> <method name="body_add_force"> @@ -285,7 +286,7 @@ <argument index="2" name="force" type="Vector2"> </argument> <description> - Add a positioned force to the applied force and torque. As with [method body_apply_impulse], both the force and the offset from the body origin are in global coordinates. A force differs from an impulse in that, while the two are forces, the impulse clears itself after being applied. + Adds a positioned force to the applied force and torque. As with [method body_apply_impulse], both the force and the offset from the body origin are in global coordinates. A force differs from an impulse in that, while the two are forces, the impulse clears itself after being applied. </description> </method> <method name="body_add_shape"> @@ -298,7 +299,7 @@ <argument index="2" name="transform" type="Transform2D" default="Transform2D( 1, 0, 0, 1, 0, 0 )"> </argument> <description> - Add a shape to the body, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. + Adds a shape to the body, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. </description> </method> <method name="body_apply_impulse"> @@ -311,7 +312,7 @@ <argument index="2" name="impulse" type="Vector2"> </argument> <description> - Add a positioned impulse to the applied force and torque. Both the force and the offset from the body origin are in global coordinates. + Adds a positioned impulse to the applied force and torque. Both the force and the offset from the body origin are in global coordinates. </description> </method> <method name="body_attach_object_instance_id"> @@ -322,7 +323,7 @@ <argument index="1" name="id" type="int"> </argument> <description> - Assign the area to a descendant of [Object], so it can exist in the node tree. + Assigns the area to a descendant of [Object], so it can exist in the node tree. </description> </method> <method name="body_clear_shapes"> @@ -331,7 +332,7 @@ <argument index="0" name="body" type="RID"> </argument> <description> - Remove all shapes from a body. + Removes all shapes from a body. </description> </method> <method name="body_create"> @@ -342,7 +343,7 @@ <argument index="1" name="init_sleeping" type="bool" default="false"> </argument> <description> - Create a physics body. The first parameter can be any value from constants BODY_MODE*, for the type of body created. Additionally, the body can be created in sleeping state to save processing time. + Creates a physics body. The first parameter can be any value from constants BODY_MODE*, for the type of body created. Additionally, the body can be created in sleeping state to save processing time. </description> </method> <method name="body_get_collision_layer" qualifiers="const"> @@ -351,7 +352,7 @@ <argument index="0" name="body" type="RID"> </argument> <description> - Return the physics layer or layers a body belongs to. + Returns the physics layer or layers a body belongs to. </description> </method> <method name="body_get_collision_mask" qualifiers="const"> @@ -360,7 +361,7 @@ <argument index="0" name="body" type="RID"> </argument> <description> - Return the physics layer or layers a body can collide with. + Returns the physics layer or layers a body can collide with. </description> </method> <method name="body_get_continuous_collision_detection_mode" qualifiers="const"> @@ -369,7 +370,7 @@ <argument index="0" name="body" type="RID"> </argument> <description> - Return the continuous collision detection mode. + Returns the continuous collision detection mode. </description> </method> <method name="body_get_direct_state"> @@ -378,6 +379,7 @@ <argument index="0" name="body" type="RID"> </argument> <description> + Returns the [Physics2DDirectBodyState] of the body. </description> </method> <method name="body_get_max_contacts_reported" qualifiers="const"> @@ -386,7 +388,7 @@ <argument index="0" name="body" type="RID"> </argument> <description> - Return the maximum contacts that can be reported. See [method body_set_max_contacts_reported]. + Returns the maximum contacts that can be reported. See [method body_set_max_contacts_reported]. </description> </method> <method name="body_get_mode" qualifiers="const"> @@ -395,7 +397,7 @@ <argument index="0" name="body" type="RID"> </argument> <description> - Return the body mode. + Returns the body mode. </description> </method> <method name="body_get_object_instance_id" qualifiers="const"> @@ -404,7 +406,7 @@ <argument index="0" name="body" type="RID"> </argument> <description> - Get the instance ID of the object the area is assigned to. + Gets the instance ID of the object the area is assigned to. </description> </method> <method name="body_get_param" qualifiers="const"> @@ -415,7 +417,7 @@ <argument index="1" name="param" type="int" enum="Physics2DServer.BodyParameter"> </argument> <description> - Return the value of a body parameter. + Returns the value of a body parameter. A list of available parameters is on the BODY_PARAM_* constants. </description> </method> <method name="body_get_shape" qualifiers="const"> @@ -426,7 +428,7 @@ <argument index="1" name="shape_idx" type="int"> </argument> <description> - Return the [RID] of the nth shape of a body. + Returns the [RID] of the nth shape of a body. </description> </method> <method name="body_get_shape_count" qualifiers="const"> @@ -435,7 +437,7 @@ <argument index="0" name="body" type="RID"> </argument> <description> - Return the number of shapes assigned to a body. + Returns the number of shapes assigned to a body. </description> </method> <method name="body_get_shape_metadata" qualifiers="const"> @@ -446,7 +448,7 @@ <argument index="1" name="shape_idx" type="int"> </argument> <description> - Return the metadata of a shape of a body. + Returns the metadata of a shape of a body. </description> </method> <method name="body_get_shape_transform" qualifiers="const"> @@ -457,7 +459,7 @@ <argument index="1" name="shape_idx" type="int"> </argument> <description> - Return the transform matrix of a body shape. + Returns the transform matrix of a body shape. </description> </method> <method name="body_get_space" qualifiers="const"> @@ -466,7 +468,7 @@ <argument index="0" name="body" type="RID"> </argument> <description> - Return the [RID] of the space assigned to a body. + Returns the [RID] of the space assigned to a body. </description> </method> <method name="body_get_state" qualifiers="const"> @@ -477,7 +479,7 @@ <argument index="1" name="state" type="int" enum="Physics2DServer.BodyState"> </argument> <description> - Return a body state. + Returns a body state. </description> </method> <method name="body_is_omitting_force_integration" qualifiers="const"> @@ -486,7 +488,7 @@ <argument index="0" name="body" type="RID"> </argument> <description> - Return whether a body uses a callback function to calculate its own physics (see [method body_set_force_integration_callback]). + Returns whether a body uses a callback function to calculate its own physics (see [method body_set_force_integration_callback]). </description> </method> <method name="body_remove_collision_exception"> @@ -497,7 +499,7 @@ <argument index="1" name="excepted_body" type="RID"> </argument> <description> - Remove a body from the list of bodies exempt from collisions. + Removes a body from the list of bodies exempt from collisions. </description> </method> <method name="body_remove_shape"> @@ -508,7 +510,7 @@ <argument index="1" name="shape_idx" type="int"> </argument> <description> - Remove a shape from a body. The shape is not deleted, so it can be reused afterwards. + Removes a shape from a body. The shape is not deleted, so it can be reused afterwards. </description> </method> <method name="body_set_axis_velocity"> @@ -519,7 +521,7 @@ <argument index="1" name="axis_velocity" type="Vector2"> </argument> <description> - Set an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. + Sets an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. </description> </method> <method name="body_set_collision_layer"> @@ -530,7 +532,7 @@ <argument index="1" name="layer" type="int"> </argument> <description> - Set the physics layer or layers a body belongs to. + Sets the physics layer or layers a body belongs to. </description> </method> <method name="body_set_collision_mask"> @@ -541,7 +543,7 @@ <argument index="1" name="mask" type="int"> </argument> <description> - Set the physics layer or layers a body can collide with. + Sets the physics layer or layers a body can collide with. </description> </method> <method name="body_set_continuous_collision_detection_mode"> @@ -552,7 +554,7 @@ <argument index="1" name="mode" type="int" enum="Physics2DServer.CCDMode"> </argument> <description> - Set the continuous collision detection mode from any of the CCD_MODE_* constants. + Sets the continuous collision detection mode from any of the CCD_MODE_* constants. Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. </description> </method> @@ -568,7 +570,7 @@ <argument index="3" name="userdata" type="Variant" default="null"> </argument> <description> - Set the function used to calculate physics for an object, if that object allows it (see [method body_set_omit_force integration]). + Sets the function used to calculate physics for an object, if that object allows it (see [method body_set_omit_force integration]). </description> </method> <method name="body_set_max_contacts_reported"> @@ -579,7 +581,7 @@ <argument index="1" name="amount" type="int"> </argument> <description> - Set the maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0. + Sets the maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0. </description> </method> <method name="body_set_mode"> @@ -590,7 +592,7 @@ <argument index="1" name="mode" type="int" enum="Physics2DServer.BodyMode"> </argument> <description> - Set the body mode, from one of the constants BODY_MODE*. + Sets the body mode, from one of the constants BODY_MODE*. </description> </method> <method name="body_set_omit_force_integration"> @@ -601,7 +603,7 @@ <argument index="1" name="enable" type="bool"> </argument> <description> - Set whether a body uses a callback function to calculate its own physics (see [method body_set_force_integration_callback]). + Sets whether a body uses a callback function to calculate its own physics (see [method body_set_force_integration_callback]). </description> </method> <method name="body_set_param"> @@ -614,7 +616,7 @@ <argument index="2" name="value" type="float"> </argument> <description> - Set a body parameter (see BODY_PARAM* constants). + Sets a body parameter. A list of available parameters is on the BODY_PARAM_* constants. </description> </method> <method name="body_set_shape"> @@ -627,7 +629,7 @@ <argument index="2" name="shape" type="RID"> </argument> <description> - Substitute a given body shape by another. The old shape is selected by its index, the new one by its [RID]. + Substitutes a given body shape by another. The old shape is selected by its index, the new one by its [RID]. </description> </method> <method name="body_set_shape_as_one_way_collision"> @@ -640,6 +642,7 @@ <argument index="2" name="enable" type="bool"> </argument> <description> + Enables one way collision on body if [code]enable is true[/code]. </description> </method> <method name="body_set_shape_disabled"> @@ -652,6 +655,7 @@ <argument index="2" name="disable" type="bool"> </argument> <description> + Disables shape in body if [code]disable is true[/code]. </description> </method> <method name="body_set_shape_metadata"> @@ -664,7 +668,7 @@ <argument index="2" name="metadata" type="Variant"> </argument> <description> - Set metadata of a shape within a body. This metadata is different from [method Object.set_meta], and can be retrieved on shape queries. + Sets metadata of a shape within a body. This metadata is different from [method Object.set_meta], and can be retrieved on shape queries. </description> </method> <method name="body_set_shape_transform"> @@ -677,7 +681,7 @@ <argument index="2" name="transform" type="Transform2D"> </argument> <description> - Set the transform matrix for a body shape. + Sets the transform matrix for a body shape. </description> </method> <method name="body_set_space"> @@ -688,7 +692,7 @@ <argument index="1" name="space" type="RID"> </argument> <description> - Assign a space to the body (see [method create_space]). + Assigns a space to the body (see [method create_space]). </description> </method> <method name="body_set_state"> @@ -701,7 +705,7 @@ <argument index="2" name="value" type="Variant"> </argument> <description> - Set a body state (see BODY_STATE* constants). + Sets a body state (see BODY_STATE* constants). </description> </method> <method name="body_test_motion"> @@ -718,7 +722,7 @@ <argument index="4" name="result" type="Physics2DTestMotionResult" default="null"> </argument> <description> - Return whether a body can move from a given point in a given direction. Apart from the boolean return value, a [Physics2DTestMotionResult] can be passed to return additional information in. + Returns whether a body can move from a given point in a given direction. Apart from the boolean return value, a [Physics2DTestMotionResult] can be passed to return additional information in. </description> </method> <method name="damped_spring_joint_create"> @@ -733,7 +737,7 @@ <argument index="3" name="body_b" type="RID"> </argument> <description> - Create a damped spring joint between two bodies. If not specified, the second body is assumed to be the joint itself. + Creates a damped spring joint between two bodies. If not specified, the second body is assumed to be the joint itself. </description> </method> <method name="damped_string_joint_get_param" qualifiers="const"> @@ -744,7 +748,7 @@ <argument index="1" name="param" type="int" enum="Physics2DServer.DampedStringParam"> </argument> <description> - Return the value of a damped spring joint parameter. + Returns the value of a damped spring joint parameter. </description> </method> <method name="damped_string_joint_set_param"> @@ -757,7 +761,7 @@ <argument index="2" name="value" type="float"> </argument> <description> - Set a damped spring joint parameter. Parameters are explained in the DAMPED_STRING* constants. + Sets a damped spring joint parameter. Parameters are explained in the DAMPED_STRING* constants. </description> </method> <method name="free_rid"> @@ -766,7 +770,7 @@ <argument index="0" name="rid" type="RID"> </argument> <description> - Destroy any of the objects created by Physics2DServer. If the [RID] passed is not one of the objects that can be created by Physics2DServer, an error will be sent to the console. + Destroys any of the objects created by Physics2DServer. If the [RID] passed is not one of the objects that can be created by Physics2DServer, an error will be sent to the console. </description> </method> <method name="get_process_info"> @@ -775,7 +779,7 @@ <argument index="0" name="process_info" type="int" enum="Physics2DServer.ProcessInfo"> </argument> <description> - Return information about the current state of the 2D physics engine. The states are listed under the INFO_* constants. + Returns information about the current state of the 2D physics engine. The states are listed under the INFO_* constants. </description> </method> <method name="groove_joint_create"> @@ -792,7 +796,7 @@ <argument index="4" name="body_b" type="RID"> </argument> <description> - Create a groove joint between two bodies. If not specified, the bodyies are assumed to be the joint itself. + Creates a groove joint between two bodies. If not specified, the bodyies are assumed to be the joint itself. </description> </method> <method name="joint_get_param" qualifiers="const"> @@ -803,7 +807,7 @@ <argument index="1" name="param" type="int" enum="Physics2DServer.JointParam"> </argument> <description> - Return the value of a joint parameter. + Returns the value of a joint parameter. </description> </method> <method name="joint_get_type" qualifiers="const"> @@ -812,7 +816,7 @@ <argument index="0" name="joint" type="RID"> </argument> <description> - Return the type of a joint (see JOINT_* constants). + Returns the type of a joint (see JOINT_* constants). </description> </method> <method name="joint_set_param"> @@ -825,7 +829,7 @@ <argument index="2" name="value" type="float"> </argument> <description> - Set a joint parameter. Parameters are explained in the JOINT_PARAM* constants. + Sets a joint parameter. Parameters are explained in the JOINT_PARAM* constants. </description> </method> <method name="pin_joint_create"> @@ -838,7 +842,7 @@ <argument index="2" name="body_b" type="RID"> </argument> <description> - Create a pin joint between two bodies. If not specified, the second body is assumed to be the joint itself. + Creates a pin joint between two bodies. If not specified, the second body is assumed to be the joint itself. </description> </method> <method name="set_active"> @@ -847,7 +851,7 @@ <argument index="0" name="active" type="bool"> </argument> <description> - Activate or deactivate the 2D physics engine. + Activates or deactivates the 2D physics engine. </description> </method> <method name="shape_create"> @@ -856,7 +860,7 @@ <argument index="0" name="type" type="int" enum="Physics2DServer.ShapeType"> </argument> <description> - Create a shape of type SHAPE_*. Does not assign it to a body or an area. To do so, you must use [method area_set_shape] or [method body_set_shape]. + Creates a shape of type SHAPE_*. Does not assign it to a body or an area. To do so, you must use [method area_set_shape] or [method body_set_shape]. </description> </method> <method name="shape_get_data" qualifiers="const"> @@ -865,7 +869,7 @@ <argument index="0" name="shape" type="RID"> </argument> <description> - Return the shape data. + Returns the shape data. </description> </method> <method name="shape_get_type" qualifiers="const"> @@ -874,7 +878,7 @@ <argument index="0" name="shape" type="RID"> </argument> <description> - Return the type of shape (see SHAPE_* constants). + Returns the type of shape (see SHAPE_* constants). </description> </method> <method name="shape_set_data"> @@ -885,14 +889,14 @@ <argument index="1" name="data" type="Variant"> </argument> <description> - Set the shape data that defines its shape and size. The data to be passed depends on the kind of shape created [method shape_get_type]. + Sets the shape data that defines its shape and size. The data to be passed depends on the kind of shape created [method shape_get_type]. </description> </method> <method name="space_create"> <return type="RID"> </return> <description> - Create a space. A space is a collection of parameters for the physics engine that can be assigned to an area or a body. It can be assigned to an area with [method area_set_space], or to a body with [method body_set_space]. + Creates a space. A space is a collection of parameters for the physics engine that can be assigned to an area or a body. It can be assigned to an area with [method area_set_space], or to a body with [method body_set_space]. </description> </method> <method name="space_get_direct_state"> @@ -901,7 +905,7 @@ <argument index="0" name="space" type="RID"> </argument> <description> - Return the state of a space, a [Physics2DDirectSpaceState]. This object can be used to make collision/intersection queries. + Returns the state of a space, a [Physics2DDirectSpaceState]. This object can be used to make collision/intersection queries. </description> </method> <method name="space_get_param" qualifiers="const"> @@ -912,7 +916,7 @@ <argument index="1" name="param" type="int" enum="Physics2DServer.SpaceParameter"> </argument> <description> - Return the value of a space parameter. + Returns the value of a space parameter. </description> </method> <method name="space_is_active" qualifiers="const"> @@ -921,7 +925,7 @@ <argument index="0" name="space" type="RID"> </argument> <description> - Return whether the space is active. + Returns whether the space is active. </description> </method> <method name="space_set_active"> @@ -932,7 +936,7 @@ <argument index="1" name="active" type="bool"> </argument> <description> - Mark a space as active. It will not have an effect, unless it is assigned to an area or body. + Marks a space as active. It will not have an effect, unless it is assigned to an area or body. </description> </method> <method name="space_set_param"> @@ -945,7 +949,7 @@ <argument index="2" name="value" type="float"> </argument> <description> - Set the value for a space parameter. A list of available parameters is on the SPACE_PARAM_* constants. + Sets the value for a space parameter. A list of available parameters is on the SPACE_PARAM_* constants. </description> </method> </methods> @@ -960,8 +964,10 @@ Constant to set/get the maximum distance a shape can penetrate another shape before it is considered a collision. </constant> <constant name="SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD" value="3"> + Constant to set/get the threshold linear velocity of activity. A body marked as potentially inactive for both linear and angular velocity will be put to sleep after the time given. </constant> <constant name="SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD" value="4"> + Constant to set/get the threshold angular velocity of activity. A body marked as potentially inactive for both linear and angular velocity will be put to sleep after the time given. </constant> <constant name="SPACE_PARAM_BODY_TIME_TO_SLEEP" value="5"> Constant to set/get the maximum time of activity. A body marked as potentially inactive for both linear and angular velocity will be put to sleep after this time. @@ -985,7 +991,7 @@ This is the constant for creating capsule shapes. A capsule shape is defined by a radius and a length. It can be used for intersections and inside/outside checks. </constant> <constant name="SHAPE_CONVEX_POLYGON" value="6"> - This is the constant for creating convex polygon shapes. A polygon is defined by a list of points. It can be used for intersections and inside/outside checks. Unlike the method [method CollisionPolygon2D.set_polygon], polygons modified with [method shape_set_data] do not verify that the points supplied form, in fact, a convex polygon. + This is the constant for creating convex polygon shapes. A polygon is defined by a list of points. It can be used for intersections and inside/outside checks. Unlike the method [method CollisionPolygon2D.set_polygon], polygons modified with [method shape_set_data] do not verify that the points supplied form is a convex polygon. </constant> <constant name="SHAPE_CONCAVE_POLYGON" value="7"> This is the constant for creating concave polygon shapes. A polygon is defined by a list of points. It can be used for intersections checks, but not for inside/outside checks. diff --git a/doc/classes/Physics2DServerSW.xml b/doc/classes/Physics2DServerSW.xml index a8645c0b96..67fd7a21d8 100644 --- a/doc/classes/Physics2DServerSW.xml +++ b/doc/classes/Physics2DServerSW.xml @@ -4,7 +4,7 @@ Software implementation of [Physics2DServer]. </brief_description> <description> - Software implementation of [Physics2DServer]. This class exposes no new methods or properties and should not be used, as [Physics2DServer] automatically selects the best implementation available. + This class exposes no new methods or properties and should not be used, as [Physics2DServer] automatically selects the best implementation available. </description> <tutorials> </tutorials> diff --git a/doc/classes/Physics2DShapeQueryParameters.xml b/doc/classes/Physics2DShapeQueryParameters.xml index 78d12e0b73..d838ff2317 100644 --- a/doc/classes/Physics2DShapeQueryParameters.xml +++ b/doc/classes/Physics2DShapeQueryParameters.xml @@ -129,7 +129,7 @@ <argument index="0" name="transform" type="Transform2D"> </argument> <description> - Set the transormation matrix of the shape. This is necessary to set its position/rotation/scale. + Set the transformation matrix of the shape. This is necessary to set its position/rotation/scale. </description> </method> </methods> diff --git a/doc/classes/PhysicsServer.xml b/doc/classes/PhysicsServer.xml index e6c81825ad..12c1abccc6 100644 --- a/doc/classes/PhysicsServer.xml +++ b/doc/classes/PhysicsServer.xml @@ -1,8 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="PhysicsServer" inherits="Object" category="Core" version="3.0.alpha.custom_build"> <brief_description> + Server interface for low level physics access. </brief_description> <description> + Everything related to physics in 3D. </description> <tutorials> </tutorials> @@ -19,6 +21,7 @@ <argument index="2" name="transform" type="Transform" default="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )"> </argument> <description> + Adds a shape to the area, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. </description> </method> <method name="area_attach_object_instance_id"> @@ -29,6 +32,7 @@ <argument index="1" name="id" type="int"> </argument> <description> + Assigns the area to a descendant of [Object], so it can exist in the node tree. </description> </method> <method name="area_clear_shapes"> @@ -37,12 +41,14 @@ <argument index="0" name="area" type="RID"> </argument> <description> + Removes all shapes from an area. It does not delete the shapes, so they can be reassigned later. </description> </method> <method name="area_create"> <return type="RID"> </return> <description> + Creates an [Area]. </description> </method> <method name="area_get_object_instance_id" qualifiers="const"> @@ -51,6 +57,7 @@ <argument index="0" name="area" type="RID"> </argument> <description> + Gets the instance ID of the object the area is assigned to. </description> </method> <method name="area_get_param" qualifiers="const"> @@ -61,6 +68,7 @@ <argument index="1" name="param" type="int" enum="PhysicsServer.AreaParameter"> </argument> <description> + Returns an area parameter value. A list of available parameters is on the AREA_PARAM_* constants. </description> </method> <method name="area_get_shape" qualifiers="const"> @@ -71,6 +79,7 @@ <argument index="1" name="shape_idx" type="int"> </argument> <description> + Returns the [RID] of the nth shape of an area. </description> </method> <method name="area_get_shape_count" qualifiers="const"> @@ -79,6 +88,7 @@ <argument index="0" name="area" type="RID"> </argument> <description> + Returns the number of shapes assigned to an area. </description> </method> <method name="area_get_shape_transform" qualifiers="const"> @@ -89,6 +99,7 @@ <argument index="1" name="shape_idx" type="int"> </argument> <description> + Returns the transform matrix of a shape within an area. </description> </method> <method name="area_get_space" qualifiers="const"> @@ -97,6 +108,7 @@ <argument index="0" name="area" type="RID"> </argument> <description> + Returns the space assigned to the area. </description> </method> <method name="area_get_space_override_mode" qualifiers="const"> @@ -105,6 +117,7 @@ <argument index="0" name="area" type="RID"> </argument> <description> + Returns the space override mode for the area. </description> </method> <method name="area_get_transform" qualifiers="const"> @@ -113,6 +126,7 @@ <argument index="0" name="area" type="RID"> </argument> <description> + Returns the transform matrix for an area. </description> </method> <method name="area_is_ray_pickable" qualifiers="const"> @@ -121,6 +135,7 @@ <argument index="0" name="area" type="RID"> </argument> <description> + If [code]true[/code] area collides with rays. </description> </method> <method name="area_remove_shape"> @@ -131,6 +146,7 @@ <argument index="1" name="shape_idx" type="int"> </argument> <description> + Removes a shape from an area. It does not delete the shape, so it can be reassigned later. </description> </method> <method name="area_set_collision_layer"> @@ -141,6 +157,7 @@ <argument index="1" name="layer" type="int"> </argument> <description> + Assigns the area to one or many physics layers. </description> </method> <method name="area_set_collision_mask"> @@ -151,6 +168,7 @@ <argument index="1" name="mask" type="int"> </argument> <description> + Sets which physics layers the area will monitor. </description> </method> <method name="area_set_monitor_callback"> @@ -163,6 +181,12 @@ <argument index="2" name="method" type="String"> </argument> <description> + Sets the function to call when any body/area enters or exits the area. This callback will be called for any object interacting with the area, and takes five parameters: + 1: AREA_BODY_ADDED or AREA_BODY_REMOVED, depending on whether the object entered or exited the area. + 2: [RID] of the object that entered/exited the area. + 3: Instance ID of the object that entered/exited the area. + 4: The shape index of the object that entered/exited the area. + 5: The shape index of the area where the object entered/exited. </description> </method> <method name="area_set_param"> @@ -175,6 +199,7 @@ <argument index="2" name="value" type="Variant"> </argument> <description> + Sets the value for an area parameter. A list of available parameters is on the AREA_PARAM_* constants. </description> </method> <method name="area_set_ray_pickable"> @@ -185,6 +210,7 @@ <argument index="1" name="enable" type="bool"> </argument> <description> + Sets object pickable with rays. </description> </method> <method name="area_set_shape"> @@ -197,6 +223,7 @@ <argument index="2" name="shape" type="RID"> </argument> <description> + Substitutes a given area shape by another. The old shape is selected by its index, the new one by its [RID]. </description> </method> <method name="area_set_shape_transform"> @@ -209,6 +236,7 @@ <argument index="2" name="transform" type="Transform"> </argument> <description> + Sets the transform matrix for an area shape. </description> </method> <method name="area_set_space"> @@ -219,6 +247,7 @@ <argument index="1" name="space" type="RID"> </argument> <description> + Assigns a space to the area. </description> </method> <method name="area_set_space_override_mode"> @@ -229,6 +258,7 @@ <argument index="1" name="mode" type="int" enum="PhysicsServer.AreaSpaceOverrideMode"> </argument> <description> + Sets the space override mode for the area. The modes are described in the constants AREA_SPACE_OVERRIDE_*. </description> </method> <method name="area_set_transform"> @@ -239,6 +269,7 @@ <argument index="1" name="transform" type="Transform"> </argument> <description> + Sets the transform matrix for an area. </description> </method> <method name="body_add_collision_exception"> @@ -249,6 +280,7 @@ <argument index="1" name="excepted_body" type="RID"> </argument> <description> + Adds a body to the list of bodies exempt from collisions. </description> </method> <method name="body_add_shape"> @@ -261,6 +293,7 @@ <argument index="2" name="transform" type="Transform" default="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )"> </argument> <description> + Adds a shape to the body, along with a transform matrix. Shapes are usually referenced by their index, so you should track which shape has a given index. </description> </method> <method name="body_apply_impulse"> @@ -273,6 +306,7 @@ <argument index="2" name="impulse" type="Vector3"> </argument> <description> + Gives the body a push at a [code]position[/code] in the direction of the [code]impulse[/code]. </description> </method> <method name="body_apply_torque_impulse"> @@ -283,6 +317,7 @@ <argument index="1" name="impulse" type="Vector3"> </argument> <description> + Gives the body a push to rotate it. </description> </method> <method name="body_attach_object_instance_id"> @@ -293,6 +328,7 @@ <argument index="1" name="id" type="int"> </argument> <description> + Assigns the area to a descendant of [Object], so it can exist in the node tree. </description> </method> <method name="body_clear_shapes"> @@ -301,6 +337,7 @@ <argument index="0" name="body" type="RID"> </argument> <description> + Removes all shapes from a body. </description> </method> <method name="body_create"> @@ -311,6 +348,7 @@ <argument index="1" name="init_sleeping" type="bool" default="false"> </argument> <description> + Creates a physics body. The first parameter can be any value from constants BODY_MODE*, for the type of body created. Additionally, the body can be created in sleeping state to save processing time. </description> </method> <method name="body_get_axis_lock" qualifiers="const"> @@ -319,6 +357,7 @@ <argument index="0" name="body" type="RID"> </argument> <description> + Gets the information, which Axis is locked if any. The can be any calue from the constants BODY_AXIS_LOCK* </description> </method> <method name="body_get_collision_layer" qualifiers="const"> @@ -327,6 +366,7 @@ <argument index="0" name="body" type="RID"> </argument> <description> + Returns the physics layer or layers a body belongs to. </description> </method> <method name="body_get_collision_mask" qualifiers="const"> @@ -335,14 +375,16 @@ <argument index="0" name="body" type="RID"> </argument> <description> - </description> - </method> - <method name="body_get_direct_state"> - <return type="PhysicsDirectBodyState"> - </return> - <argument index="0" name="body" type="RID"> - </argument> - <description> + Returns the physics layer or layers a body can collide with. +- </description> +- </method> +- <method name="body_get_direct_state"> +- <return type="PhysicsDirectBodyState"> +- </return> +- <argument index="0" name="body" type="RID"> +- </argument> +- <description> + Returns the [PhysicsDirectBodyState] of the body. </description> </method> <method name="body_get_max_contacts_reported" qualifiers="const"> @@ -351,6 +393,7 @@ <argument index="0" name="body" type="RID"> </argument> <description> + Returns the maximum contacts that can be reported. See [method body_set_max_contacts_reported]. </description> </method> <method name="body_get_mode" qualifiers="const"> @@ -359,6 +402,7 @@ <argument index="0" name="body" type="RID"> </argument> <description> + Returns the body mode. </description> </method> <method name="body_get_object_instance_id" qualifiers="const"> @@ -367,6 +411,7 @@ <argument index="0" name="body" type="RID"> </argument> <description> + Gets the instance ID of the object the area is assigned to. </description> </method> <method name="body_get_param" qualifiers="const"> @@ -377,6 +422,7 @@ <argument index="1" name="param" type="int" enum="PhysicsServer.BodyParameter"> </argument> <description> + Returns the value of a body parameter. A list of available parameters is on the BODY_PARAM_* constants. </description> </method> <method name="body_get_shape" qualifiers="const"> @@ -387,6 +433,7 @@ <argument index="1" name="shape_idx" type="int"> </argument> <description> + Returns the [RID] of the nth shape of a body. </description> </method> <method name="body_get_shape_count" qualifiers="const"> @@ -395,6 +442,7 @@ <argument index="0" name="body" type="RID"> </argument> <description> + Returns the number of shapes assigned to a body. </description> </method> <method name="body_get_shape_transform" qualifiers="const"> @@ -405,6 +453,7 @@ <argument index="1" name="shape_idx" type="int"> </argument> <description> + Returns the transform matrix of a body shape. </description> </method> <method name="body_get_space" qualifiers="const"> @@ -413,6 +462,7 @@ <argument index="0" name="body" type="RID"> </argument> <description> + Returns the [RID] of the space assigned to a body. </description> </method> <method name="body_get_state" qualifiers="const"> @@ -423,6 +473,7 @@ <argument index="1" name="state" type="int" enum="PhysicsServer.BodyState"> </argument> <description> + Returns a body state. </description> </method> <method name="body_is_continuous_collision_detection_enabled" qualifiers="const"> @@ -431,6 +482,7 @@ <argument index="0" name="body" type="RID"> </argument> <description> + If [code]true[/code] the continuous collision detection mode is enabled. </description> </method> <method name="body_is_omitting_force_integration" qualifiers="const"> @@ -439,6 +491,7 @@ <argument index="0" name="body" type="RID"> </argument> <description> + Returns whether a body uses a callback function to calculate its own physics (see [method body_set_force_integration_callback]). </description> </method> <method name="body_is_ray_pickable" qualifiers="const"> @@ -447,6 +500,7 @@ <argument index="0" name="body" type="RID"> </argument> <description> + If [code]true[/code] the body can be detected by rays </description> </method> <method name="body_remove_collision_exception"> @@ -457,6 +511,8 @@ <argument index="1" name="excepted_body" type="RID"> </argument> <description> + Removes a body from the list of bodies exempt from collisions. + Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. </description> </method> <method name="body_remove_shape"> @@ -467,6 +523,7 @@ <argument index="1" name="shape_idx" type="int"> </argument> <description> + Removes a shape from a body. The shape is not deleted, so it can be reused afterwards. </description> </method> <method name="body_set_axis_lock"> @@ -477,6 +534,7 @@ <argument index="1" name="axis" type="int" enum="PhysicsServer.BodyAxisLock"> </argument> <description> + Locks velocity along one axis to 0 and only allows rotation along this axis, can also be set to disabled which disables this functionality. </description> </method> <method name="body_set_axis_velocity"> @@ -487,6 +545,7 @@ <argument index="1" name="axis_velocity" type="Vector3"> </argument> <description> + Sets an axis velocity. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior. </description> </method> <method name="body_set_collision_layer"> @@ -497,6 +556,7 @@ <argument index="1" name="layer" type="int"> </argument> <description> + Sets the physics layer or layers a body belongs to. </description> </method> <method name="body_set_collision_mask"> @@ -507,6 +567,7 @@ <argument index="1" name="mask" type="int"> </argument> <description> + Sets the physics layer or layers a body can collide with. </description> </method> <method name="body_set_enable_continuous_collision_detection"> @@ -517,6 +578,8 @@ <argument index="1" name="enable" type="bool"> </argument> <description> + If [code]true[/code] the continuous collision detection mode is enabled. + Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. </description> </method> <method name="body_set_force_integration_callback"> @@ -531,6 +594,7 @@ <argument index="3" name="userdata" type="Variant" default="null"> </argument> <description> + Sets the function used to calculate physics for an object, if that object allows it (see [method body_set_omit_force integration]). </description> </method> <method name="body_set_max_contacts_reported"> @@ -541,6 +605,7 @@ <argument index="1" name="amount" type="int"> </argument> <description> + Sets the maximum contacts to report. Bodies can keep a log of the contacts with other bodies, this is enabled by setting the maximum amount of contacts reported to a number greater than 0. </description> </method> <method name="body_set_mode"> @@ -551,6 +616,7 @@ <argument index="1" name="mode" type="int" enum="PhysicsServer.BodyMode"> </argument> <description> + Sets the body mode, from one of the constants BODY_MODE*. </description> </method> <method name="body_set_omit_force_integration"> @@ -561,6 +627,7 @@ <argument index="1" name="enable" type="bool"> </argument> <description> + Sets whether a body uses a callback function to calculate its own physics (see [method body_set_force_integration_callback]). </description> </method> <method name="body_set_param"> @@ -573,6 +640,7 @@ <argument index="2" name="value" type="float"> </argument> <description> + Sets a body parameter. A list of available parameters is on the BODY_PARAM_* constants. </description> </method> <method name="body_set_ray_pickable"> @@ -583,6 +651,7 @@ <argument index="1" name="enable" type="bool"> </argument> <description> + Sets the body pickable with rays if [code]enabled[/code] is set. </description> </method> <method name="body_set_shape"> @@ -595,6 +664,7 @@ <argument index="2" name="shape" type="RID"> </argument> <description> + Substitutes a given body shape by another. The old shape is selected by its index, the new one by its [RID]. </description> </method> <method name="body_set_shape_transform"> @@ -607,6 +677,7 @@ <argument index="2" name="transform" type="Transform"> </argument> <description> + Sets the transform matrix for a body shape. </description> </method> <method name="body_set_space"> @@ -617,6 +688,7 @@ <argument index="1" name="space" type="RID"> </argument> <description> + Assigns a space to the body (see [method create_space]). </description> </method> <method name="body_set_state"> @@ -629,6 +701,7 @@ <argument index="2" name="value" type="Variant"> </argument> <description> + Sets a body state (see BODY_STATE* constants). </description> </method> <method name="cone_twist_joint_get_param" qualifiers="const"> @@ -639,6 +712,7 @@ <argument index="1" name="param" type="int" enum="PhysicsServer.ConeTwistJointParam"> </argument> <description> + Gets a cone_twist_joint parameter (see CONE_TWIST_JOINT* constants). </description> </method> <method name="cone_twist_joint_set_param"> @@ -651,6 +725,7 @@ <argument index="2" name="value" type="float"> </argument> <description> + Sets a cone_twist_joint parameter (see CONE_TWIST_JOINT* constants). </description> </method> <method name="free_rid"> @@ -659,6 +734,7 @@ <argument index="0" name="rid" type="RID"> </argument> <description> + Destroys any of the objects created by PhysicsServer. If the [RID] passed is not one of the objects that can be created by PhysicsServer, an error will be sent to the console. </description> </method> <method name="generic_6dof_joint_get_flag"> @@ -670,7 +746,8 @@ </argument> <argument index="2" name="flag" type="int" enum="PhysicsServer.G6DOFJointAxisFlag"> </argument> - <description> + <description> + Gets a generic_6_DOF_joint flag (see G6DOF_JOINT_FLAG* constants). </description> </method> <method name="generic_6dof_joint_get_param"> @@ -683,6 +760,7 @@ <argument index="2" name="param" type="int" enum="PhysicsServer.G6DOFJointAxisParam"> </argument> <description> + Gets a generic_6_DOF_joint parameter (see G6DOF_JOINT* constants without the G6DOF_JOINT_FLAG*). </description> </method> <method name="generic_6dof_joint_set_flag"> @@ -697,6 +775,7 @@ <argument index="3" name="enable" type="bool"> </argument> <description> + Sets a generic_6_DOF_joint flag (see G6DOF_JOINT_FLAG* constants). </description> </method> <method name="generic_6dof_joint_set_param"> @@ -711,6 +790,7 @@ <argument index="3" name="value" type="float"> </argument> <description> + Sets a generic_6_DOF_joint parameter (see G6DOF_JOINT* constants without the G6DOF_JOINT_FLAG*). </description> </method> <method name="get_process_info"> @@ -719,6 +799,7 @@ <argument index="0" name="process_info" type="int" enum="PhysicsServer.ProcessInfo"> </argument> <description> + Returns an Info defined by the [ProcessInfo] input given. </description> </method> <method name="hinge_joint_get_flag" qualifiers="const"> @@ -729,6 +810,7 @@ <argument index="1" name="flag" type="int" enum="PhysicsServer.HingeJointFlag"> </argument> <description> + Gets a hinge_joint flag (see HINGE_JOINT_FLAG* constants). </description> </method> <method name="hinge_joint_get_param" qualifiers="const"> @@ -739,6 +821,7 @@ <argument index="1" name="param" type="int" enum="PhysicsServer.HingeJointParam"> </argument> <description> + Gets a hinge_joint parameter (see HINGE_JOINT* constants without the HINGE_JOINT_FLAG*). </description> </method> <method name="hinge_joint_set_flag"> @@ -751,6 +834,7 @@ <argument index="2" name="enabled" type="bool"> </argument> <description> + Sets a hinge_joint flag (see HINGE_JOINT_FLAG* constants). </description> </method> <method name="hinge_joint_set_param"> @@ -763,6 +847,7 @@ <argument index="2" name="value" type="float"> </argument> <description> + Sets a hinge_joint parameter (see HINGE_JOINT* constants without the HINGE_JOINT_FLAG*). </description> </method> <method name="joint_create_cone_twist"> @@ -777,6 +862,7 @@ <argument index="3" name="local_ref_B" type="Transform"> </argument> <description> + Creates a [ConeTwistJoint]. </description> </method> <method name="joint_create_generic_6dof"> @@ -791,6 +877,7 @@ <argument index="3" name="local_ref_B" type="Transform"> </argument> <description> + Creates a [Generic6DOFJoint]. </description> </method> <method name="joint_create_hinge"> @@ -805,6 +892,7 @@ <argument index="3" name="hinge_B" type="Transform"> </argument> <description> + Creates a [HingeJoint]. </description> </method> <method name="joint_create_pin"> @@ -819,6 +907,7 @@ <argument index="3" name="local_B" type="Vector3"> </argument> <description> + Creates a [PinJoint]. </description> </method> <method name="joint_create_slider"> @@ -833,6 +922,7 @@ <argument index="3" name="local_ref_B" type="Transform"> </argument> <description> + Creates a [SliderJoint]. </description> </method> <method name="joint_get_solver_priority" qualifiers="const"> @@ -841,6 +931,7 @@ <argument index="0" name="joint" type="RID"> </argument> <description> + Gets the priority value of the Joint. </description> </method> <method name="joint_get_type" qualifiers="const"> @@ -849,6 +940,7 @@ <argument index="0" name="joint" type="RID"> </argument> <description> + Returns the type of the Joint. </description> </method> <method name="joint_set_solver_priority"> @@ -859,6 +951,7 @@ <argument index="1" name="priority" type="int"> </argument> <description> + Sets the priority value of the Joint. </description> </method> <method name="pin_joint_get_local_a" qualifiers="const"> @@ -867,6 +960,7 @@ <argument index="0" name="joint" type="RID"> </argument> <description> + Returns position of the joint in the local space of body a of the joint. </description> </method> <method name="pin_joint_get_local_b" qualifiers="const"> @@ -875,6 +969,7 @@ <argument index="0" name="joint" type="RID"> </argument> <description> + Returns position of the joint in the local space of body b of the joint. </description> </method> <method name="pin_joint_get_param" qualifiers="const"> @@ -885,6 +980,7 @@ <argument index="1" name="param" type="int" enum="PhysicsServer.PinJointParam"> </argument> <description> + Gets a pin_joint parameter (see PIN_JOINT* constants). </description> </method> <method name="pin_joint_set_local_a"> @@ -895,6 +991,7 @@ <argument index="1" name="local_A" type="Vector3"> </argument> <description> + Sets position of the joint in the local space of body a of the joint. </description> </method> <method name="pin_joint_set_local_b"> @@ -905,6 +1002,7 @@ <argument index="1" name="local_B" type="Vector3"> </argument> <description> + Sets position of the joint in the local space of body b of the joint. </description> </method> <method name="pin_joint_set_param"> @@ -917,6 +1015,7 @@ <argument index="2" name="value" type="float"> </argument> <description> + Sets a pin_joint parameter (see PIN_JOINT* constants). </description> </method> <method name="set_active"> @@ -925,6 +1024,7 @@ <argument index="0" name="active" type="bool"> </argument> <description> + Activates or deactivates the 3D physics engine. </description> </method> <method name="shape_create"> @@ -933,6 +1033,7 @@ <argument index="0" name="type" type="int" enum="PhysicsServer.ShapeType"> </argument> <description> + Creates a shape of type SHAPE_*. Does not assign it to a body or an area. To do so, you must use [method area_set_shape] or [method body_set_shape]. </description> </method> <method name="shape_get_data" qualifiers="const"> @@ -941,6 +1042,7 @@ <argument index="0" name="shape" type="RID"> </argument> <description> + Returns the shape data. </description> </method> <method name="shape_get_type" qualifiers="const"> @@ -949,6 +1051,7 @@ <argument index="0" name="shape" type="RID"> </argument> <description> + Returns the type of shape (see SHAPE_* constants). </description> </method> <method name="shape_set_data"> @@ -959,6 +1062,7 @@ <argument index="1" name="data" type="Variant"> </argument> <description> + Sets the shape data that defines its shape and size. The data to be passed depends on the kind of shape created [method shape_get_type]. </description> </method> <method name="slider_joint_get_param" qualifiers="const"> @@ -969,6 +1073,7 @@ <argument index="1" name="param" type="int" enum="PhysicsServer.SliderJointParam"> </argument> <description> + Gets a slider_joint parameter (see SLIDER_JOINT* constants). </description> </method> <method name="slider_joint_set_param"> @@ -981,12 +1086,14 @@ <argument index="2" name="value" type="float"> </argument> <description> + Gets a slider_joint parameter (see SLIDER_JOINT* constants). </description> </method> <method name="space_create"> <return type="RID"> </return> <description> + Creates a space. A space is a collection of parameters for the physics engine that can be assigned to an area or a body. It can be assigned to an area with [method area_set_space], or to a body with [method body_set_space]. </description> </method> <method name="space_get_direct_state"> @@ -995,6 +1102,7 @@ <argument index="0" name="space" type="RID"> </argument> <description> + Returns the state of a space, a [PhysicsDirectSpaceState]. This object can be used to make collision/intersection queries. </description> </method> <method name="space_get_param" qualifiers="const"> @@ -1005,6 +1113,7 @@ <argument index="1" name="param" type="int" enum="PhysicsServer.SpaceParameter"> </argument> <description> + Returns the value of a space parameter. </description> </method> <method name="space_is_active" qualifiers="const"> @@ -1013,6 +1122,7 @@ <argument index="0" name="space" type="RID"> </argument> <description> + Returns whether the space is active. </description> </method> <method name="space_set_active"> @@ -1023,6 +1133,7 @@ <argument index="1" name="active" type="bool"> </argument> <description> + Marks a space as active. It will not have an effect, unless it is assigned to an area or body. </description> </method> <method name="space_set_param"> @@ -1035,169 +1146,256 @@ <argument index="2" name="value" type="float"> </argument> <description> + Sets the value for a space parameter. A list of available parameters is on the SPACE_PARAM_* constants. </description> </method> </methods> <constants> <constant name="JOINT_PIN" value="0"> + The [Joint] is a [PinJoint]. </constant> <constant name="JOINT_HINGE" value="1"> + The [Joint] is a [HingeJoint]. </constant> <constant name="JOINT_SLIDER" value="2"> + The [Joint] is a [SliderJoint]. </constant> <constant name="JOINT_CONE_TWIST" value="3"> + The [Joint] is a [ConeTwistJoint]. </constant> <constant name="JOINT_6DOF" value="4"> + The [Joint] is a [Generic6DOFJoint]. </constant> <constant name="PIN_JOINT_BIAS" value="0"> + The strength with which the pinned objects try to stay in positional relation to each other. + The higher, the stronger. </constant> <constant name="PIN_JOINT_DAMPING" value="1"> + The strength with which the pinned objects try to stay in velocity relation to each other. + The higher, the stronger. </constant> <constant name="PIN_JOINT_IMPULSE_CLAMP" value="2"> + If above 0, this value is the maximum value for an impulse that this Joint puts on it's ends. </constant> <constant name="HINGE_JOINT_BIAS" value="0"> + The speed with wich the two bodies get pulled together when they move in different directions. </constant> <constant name="HINGE_JOINT_LIMIT_UPPER" value="1"> + The maximum rotation across the Hinge. </constant> <constant name="HINGE_JOINT_LIMIT_LOWER" value="2"> + The minimum rotation across the Hinge. </constant> <constant name="HINGE_JOINT_LIMIT_BIAS" value="3"> + The speed with which the rotation across the axis perpendicular to the hinge gets corrected. </constant> <constant name="HINGE_JOINT_LIMIT_SOFTNESS" value="4"> </constant> <constant name="HINGE_JOINT_LIMIT_RELAXATION" value="5"> + The lower this value, the more the rotation gets slowed down. </constant> <constant name="HINGE_JOINT_MOTOR_TARGET_VELOCITY" value="6"> + Target speed for the motor. </constant> <constant name="HINGE_JOINT_MOTOR_MAX_IMPULSE" value="7"> + Maximum acceleration for the motor. </constant> <constant name="HINGE_JOINT_FLAG_USE_LIMIT" value="0"> + If [code]true[/code] the Hinge has a maximum and a minimum rotation. </constant> <constant name="HINGE_JOINT_FLAG_ENABLE_MOTOR" value="1"> + If [code]true[/code] a motor turns the Hinge </constant> <constant name="SLIDER_JOINT_LINEAR_LIMIT_UPPER" value="0"> + The maximum difference between the pivot points on their x-axis before damping happens. </constant> <constant name="SLIDER_JOINT_LINEAR_LIMIT_LOWER" value="1"> + The minimum difference between the pivot points on their x-axis before damping happens. </constant> <constant name="SLIDER_JOINT_LINEAR_LIMIT_SOFTNESS" value="2"> + A factor applied to the movement accross the slider axis once the limits get surpassed. The lower, the slower the movement. </constant> <constant name="SLIDER_JOINT_LINEAR_LIMIT_RESTITUTION" value="3"> + The amount of restitution once the limits are surpassed. The lower, the more velocityenergy gets lost. </constant> <constant name="SLIDER_JOINT_LINEAR_LIMIT_DAMPING" value="4"> + The amount of damping once the slider limits are surpassed. </constant> <constant name="SLIDER_JOINT_LINEAR_MOTION_SOFTNESS" value="5"> + A factor applied to the movement accross the slider axis as long as the slider is in the limits. The lower, the slower the movement. </constant> <constant name="SLIDER_JOINT_LINEAR_MOTION_RESTITUTION" value="6"> + The amount of restitution inside the slider limits. </constant> <constant name="SLIDER_JOINT_LINEAR_MOTION_DAMPING" value="7"> + The amount of damping inside the slider limits. </constant> <constant name="SLIDER_JOINT_LINEAR_ORTHOGONAL_SOFTNESS" value="8"> + A factor applied to the movement accross axes orthogonal to the slider. </constant> <constant name="SLIDER_JOINT_LINEAR_ORTHOGONAL_RESTITUTION" value="9"> + The amount of restitution when movement is accross axes orthogonal to the slider. </constant> <constant name="SLIDER_JOINT_LINEAR_ORTHOGONAL_DAMPING" value="10"> + The amount of damping when movement is accross axes orthogonal to the slider. </constant> <constant name="SLIDER_JOINT_ANGULAR_LIMIT_UPPER" value="11"> + The upper limit of rotation in the slider. </constant> <constant name="SLIDER_JOINT_ANGULAR_LIMIT_LOWER" value="12"> + The lower limit of rotation in the slider. </constant> <constant name="SLIDER_JOINT_ANGULAR_LIMIT_SOFTNESS" value="13"> + A factor applied to the all rotation once the limit is surpassed. </constant> <constant name="SLIDER_JOINT_ANGULAR_LIMIT_RESTITUTION" value="14"> + The amount of restitution of the rotation when the limit is surpassed. </constant> <constant name="SLIDER_JOINT_ANGULAR_LIMIT_DAMPING" value="15"> + The amount of damping of the rotation when the limit is surpassed. </constant> <constant name="SLIDER_JOINT_ANGULAR_MOTION_SOFTNESS" value="16"> + A factor that gets applied to the all rotation in the limits. </constant> <constant name="SLIDER_JOINT_ANGULAR_MOTION_RESTITUTION" value="17"> + The amount of restitution of the rotation in the limits. </constant> <constant name="SLIDER_JOINT_ANGULAR_MOTION_DAMPING" value="18"> + The amount of damping of the rotation in the limits. </constant> <constant name="SLIDER_JOINT_ANGULAR_ORTHOGONAL_SOFTNESS" value="19"> + A factor that gets applied to the all rotation across axes orthogonal to the slider. </constant> <constant name="SLIDER_JOINT_ANGULAR_ORTHOGONAL_RESTITUTION" value="20"> + The amount of restitution of the rotation across axes orthogonal to the slider. </constant> <constant name="SLIDER_JOINT_ANGULAR_ORTHOGONAL_DAMPING" value="21"> + The amount of damping of the rotation across axes orthogonal to the slider. </constant> <constant name="SLIDER_JOINT_MAX" value="22"> + End flag of SLIDER_JOINT_* constants, used internally. </constant> <constant name="CONE_TWIST_JOINT_SWING_SPAN" value="0"> + Swing is rotation from side to side, around the axis perpendicular to the twist axis. + The swing span defines, how much rotation will not get corrected allong the swing axis. + Could be defined as looseness in the [ConeTwistJoint]. + If below 0.05, this behaviour is locked. Default value: [code]PI/4[/code]. </constant> <constant name="CONE_TWIST_JOINT_TWIST_SPAN" value="1"> + Twist is the rotation around the twist axis, this value defined how far the joint can twist. + Twist is locked if below 0.05. </constant> <constant name="CONE_TWIST_JOINT_BIAS" value="2"> + The speed with which the swing or twist will take place. + The higher, the faster. </constant> <constant name="CONE_TWIST_JOINT_SOFTNESS" value="3"> + The ease with which the Joint twists, if it's too low, it takes more force to twist the joint. </constant> <constant name="CONE_TWIST_JOINT_RELAXATION" value="4"> + Defines, how fast the swing- and twist-speed-difference on both sides gets synced. </constant> <constant name="G6DOF_JOINT_LINEAR_LOWER_LIMIT" value="0"> + The minimum difference between the pivot points' axes. </constant> <constant name="G6DOF_JOINT_LINEAR_UPPER_LIMIT" value="1"> + The maximum difference between the pivot points' axes. </constant> <constant name="G6DOF_JOINT_LINEAR_LIMIT_SOFTNESS" value="2"> + A factor that gets applied to the movement accross the axes. The lower, the slower the movement. </constant> <constant name="G6DOF_JOINT_LINEAR_RESTITUTION" value="3"> + The amount of restitution on the axes movement. The lower, the more velocity-energy gets lost. </constant> <constant name="G6DOF_JOINT_LINEAR_DAMPING" value="4"> + The amount of damping that happens at the linear motion across the axes. </constant> <constant name="G6DOF_JOINT_ANGULAR_LOWER_LIMIT" value="5"> + The minimum rotation in negative direction to break loose and rotate arround the axes. </constant> <constant name="G6DOF_JOINT_ANGULAR_UPPER_LIMIT" value="6"> + The minimum rotation in positive direction to break loose and rotate arround the axes. </constant> <constant name="G6DOF_JOINT_ANGULAR_LIMIT_SOFTNESS" value="7"> + A factor that gets multiplied onto all rotations accross the axes. </constant> <constant name="G6DOF_JOINT_ANGULAR_DAMPING" value="8"> + The amount of rotational damping accross the axes. The lower, the more dampening occurs. </constant> <constant name="G6DOF_JOINT_ANGULAR_RESTITUTION" value="9"> + The amount of rotational restitution accross the axes. The lower, the more restitution occurs. </constant> <constant name="G6DOF_JOINT_ANGULAR_FORCE_LIMIT" value="10"> + The maximum amount of force that can occur, when rotating arround the axes. </constant> <constant name="G6DOF_JOINT_ANGULAR_ERP" value="11"> + When correcting the crossing of limits in rotation accross the axes, this error tolerance factor defines how much the correction gets slowed down. The lower, the slower. </constant> <constant name="G6DOF_JOINT_ANGULAR_MOTOR_TARGET_VELOCITY" value="12"> + Target speed for the motor at the axes. </constant> <constant name="G6DOF_JOINT_ANGULAR_MOTOR_FORCE_LIMIT" value="13"> + Maximum acceleration for the motor at the axes. </constant> <constant name="G6DOF_JOINT_FLAG_ENABLE_LINEAR_LIMIT" value="0"> + If [code]set[/code] there is linear motion possible within the given limits. </constant> <constant name="G6DOF_JOINT_FLAG_ENABLE_ANGULAR_LIMIT" value="1"> + If [code]set[/code] there is rotational motion possible. </constant> <constant name="G6DOF_JOINT_FLAG_ENABLE_MOTOR" value="2"> + If [code]set[/code] there is a rotational motor across these axes. </constant> <constant name="SHAPE_PLANE" value="0"> + The [Shape] is a [PlaneShape]. </constant> <constant name="SHAPE_RAY" value="1"> + The [Shape] is a [RayShape]. </constant> <constant name="SHAPE_SPHERE" value="2"> + The [Shape] is a [SphereShape]. </constant> <constant name="SHAPE_BOX" value="3"> + The [Shape] is a [BoxShape]. </constant> <constant name="SHAPE_CAPSULE" value="4"> + The [Shape] is a [CapsuleShape]. </constant> <constant name="SHAPE_CONVEX_POLYGON" value="5"> + The [Shape] is a [ConvexPolygonShape]. </constant> <constant name="SHAPE_CONCAVE_POLYGON" value="6"> + The [Shape] is a [ConcavePolygonShape]. </constant> <constant name="SHAPE_HEIGHTMAP" value="7"> + The [Shape] is a [HeightMapShape]. </constant> <constant name="SHAPE_CUSTOM" value="8"> + This constant is used internally by the engine. Any attempt to create this kind of shape results in an error. </constant> <constant name="AREA_PARAM_GRAVITY" value="0"> + Constant to set/get gravity strength in an area. </constant> <constant name="AREA_PARAM_GRAVITY_VECTOR" value="1"> + Constant to set/get gravity vector/center in an area. </constant> <constant name="AREA_PARAM_GRAVITY_IS_POINT" value="2"> + Constant to set/get whether the gravity vector of an area is a direction, or a center point. </constant> <constant name="AREA_PARAM_GRAVITY_DISTANCE_SCALE" value="3"> + Constant to set/get the falloff factor for point gravity of an area. The greater this value is, the faster the strength of gravity decreases with the square of distance. </constant> <constant name="AREA_PARAM_GRAVITY_POINT_ATTENUATION" value="4"> + This constant was used to set/get the falloff factor for point gravity. It has been superseded by AREA_PARAM_GRAVITY_DISTANCE_SCALE. </constant> <constant name="AREA_PARAM_LINEAR_DAMP" value="5"> + Constant to set/get the linear dampening factor of an area. </constant> <constant name="AREA_PARAM_ANGULAR_DAMP" value="6"> + Constant to set/get the angular dampening factor of an area. </constant> <constant name="AREA_PARAM_PRIORITY" value="7"> + Constant to set/get the priority (order of processing) of an area. </constant> <constant name="AREA_SPACE_OVERRIDE_DISABLED" value="0"> This area does not affect gravity/damp. These are generally areas that exist only to detect collisions, and objects entering or exiting them. @@ -1215,70 +1413,102 @@ This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one. </constant> <constant name="BODY_MODE_STATIC" value="0"> + Constant for static bodies. </constant> <constant name="BODY_MODE_KINEMATIC" value="1"> + Constant for kinematic bodies. </constant> <constant name="BODY_MODE_RIGID" value="2"> + Constant for rigid bodies. </constant> <constant name="BODY_MODE_CHARACTER" value="3"> + Constant for rigid bodies in character mode. In this mode, a body can not rotate, and only its linear velocity is affected by physics. </constant> <constant name="BODY_PARAM_BOUNCE" value="0"> + Constant to set/get a body's bounce factor. </constant> <constant name="BODY_PARAM_FRICTION" value="1"> + Constant to set/get a body's friction. </constant> <constant name="BODY_PARAM_MASS" value="2"> + Constant to set/get a body's mass. </constant> <constant name="BODY_PARAM_GRAVITY_SCALE" value="3"> + Constant to set/get a body's gravity multiplier. </constant> <constant name="BODY_PARAM_ANGULAR_DAMP" value="5"> + Constant to set/get a body's angular dampening factor. </constant> <constant name="BODY_PARAM_LINEAR_DAMP" value="4"> + Constant to set/get a body's linear dampening factor. </constant> <constant name="BODY_PARAM_MAX" value="6"> + This is the last ID for body parameters. Any attempt to set this property is ignored. Any attempt to get it returns 0. </constant> <constant name="BODY_STATE_TRANSFORM" value="0"> + Constant to set/get the current transform matrix of the body. </constant> <constant name="BODY_STATE_LINEAR_VELOCITY" value="1"> + Constant to set/get the current linear velocity of the body. </constant> <constant name="BODY_STATE_ANGULAR_VELOCITY" value="2"> + Constant to set/get the current angular velocity of the body. </constant> <constant name="BODY_STATE_SLEEPING" value="3"> + Constant to sleep/wake up a body, or to get whether it is sleeping. </constant> <constant name="BODY_STATE_CAN_SLEEP" value="4"> + Constant to set/get whether the body can sleep. </constant> <constant name="AREA_BODY_ADDED" value="0"> + The value of the first parameter and area callback function receives, when an object enters one of its shapes. </constant> <constant name="AREA_BODY_REMOVED" value="1"> + The value of the first parameter and area callback function receives, when an object exits one of its shapes. </constant> <constant name="INFO_ACTIVE_OBJECTS" value="0"> + Constant to get the number of objects that are not sleeping. </constant> <constant name="INFO_COLLISION_PAIRS" value="1"> + Constant to get the number of possible collisions. </constant> <constant name="INFO_ISLAND_COUNT" value="2"> + Constant to get the number of space regions where a collision could occur. </constant> <constant name="SPACE_PARAM_CONTACT_RECYCLE_RADIUS" value="0"> + Constant to set/get the maximum distance a pair of bodies has to move before their collision status has to be recalculated. </constant> <constant name="SPACE_PARAM_CONTACT_MAX_SEPARATION" value="1"> + Constant to set/get the maximum distance a shape can be from another before they are considered separated. </constant> <constant name="SPACE_PARAM_BODY_MAX_ALLOWED_PENETRATION" value="2"> + Constant to set/get the maximum distance a shape can penetrate another shape before it is considered a collision. </constant> <constant name="SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD" value="3"> + Constant to set/get the threshold linear velocity of activity. A body marked as potentially inactive for both linear and angular velocity will be put to sleep after the time given. </constant> <constant name="SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD" value="4"> + Constant to set/get the threshold angular velocity of activity. A body marked as potentially inactive for both linear and angular velocity will be put to sleep after the time given. </constant> <constant name="SPACE_PARAM_BODY_TIME_TO_SLEEP" value="5"> + Constant to set/get the maximum time of activity. A body marked as potentially inactive for both linear and angular velocity will be put to sleep after this time. </constant> <constant name="SPACE_PARAM_BODY_ANGULAR_VELOCITY_DAMP_RATIO" value="6"> </constant> <constant name="SPACE_PARAM_CONSTRAINT_DEFAULT_BIAS" value="7"> + Constant to set/get the default solver bias for all physics constraints. A solver bias is a factor controlling how much two objects "rebound", after violating a constraint, to avoid leaving them in that state because of numerical imprecision. </constant> <constant name="BODY_AXIS_LOCK_DISABLED" value="0"> + The [Body] can rotate and move freely. </constant> <constant name="BODY_AXIS_LOCK_X" value="1"> + The [Body] cannot move across x axis can only rotate across x axis. </constant> <constant name="BODY_AXIS_LOCK_Y" value="2"> + The [Body] cannot move across y axis can only rotate across y axis. </constant> <constant name="BODY_AXIS_LOCK_Z" value="3"> + The [Body] cannot move across z axis can only rotate across z axis. </constant> </constants> </class> diff --git a/doc/classes/PhysicsServerSW.xml b/doc/classes/PhysicsServerSW.xml index 7bffc23258..53e1c0057e 100644 --- a/doc/classes/PhysicsServerSW.xml +++ b/doc/classes/PhysicsServerSW.xml @@ -1,8 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="PhysicsServerSW" inherits="PhysicsServer" category="Core" version="3.0.alpha.custom_build"> <brief_description> + Software implementation of [PhysicsServer]. </brief_description> <description> + This class exposes no new methods or properties and should not be used, as [PhysicsServer] automatically selects the best implementation available. </description> <tutorials> </tutorials> diff --git a/doc/classes/PinJoint.xml b/doc/classes/PinJoint.xml index 22aa35a0a4..1cc381b1b3 100644 --- a/doc/classes/PinJoint.xml +++ b/doc/classes/PinJoint.xml @@ -1,8 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="PinJoint" inherits="Joint" category="Core" version="3.0.alpha.custom_build"> <brief_description> + Pin Joint for 3D Shapes. </brief_description> <description> + Pin Joint for 3D Rigid Bodies. It pins 2 bodies (rigid or static) together. </description> <tutorials> </tutorials> @@ -30,18 +32,28 @@ </methods> <members> <member name="params/bias" type="float" setter="set_param" getter="get_param"> + The force with wich the pinned objects stay in positional relation to each other. + The higher, the stronger. </member> <member name="params/damping" type="float" setter="set_param" getter="get_param"> + The force with wich the pinned objects stay in velocity relation to each other. + The higher, the stronger. </member> <member name="params/impulse_clamp" type="float" setter="set_param" getter="get_param"> + If above 0, this value is the maximum value for an impulse that this Joint produces. </member> </members> <constants> <constant name="PARAM_BIAS" value="0"> + The force with wich the pinned objects stay in positional relation to each other. + The higher, the stronger. </constant> <constant name="PARAM_DAMPING" value="1"> + The force with wich the pinned objects stay in velocity relation to each other. + The higher, the stronger. </constant> <constant name="PARAM_IMPULSE_CLAMP" value="2"> + If above 0, this value is the maximum value for an impulse that this Joint produces. </constant> </constants> </class> diff --git a/doc/classes/PinJoint2D.xml b/doc/classes/PinJoint2D.xml index 826a1684a4..009b0ec2f2 100644 --- a/doc/classes/PinJoint2D.xml +++ b/doc/classes/PinJoint2D.xml @@ -28,6 +28,7 @@ </methods> <members> <member name="softness" type="float" setter="set_softness" getter="get_softness"> + The higher this value, the more the bond to the pinned partner can flex. </member> </members> <constants> diff --git a/doc/classes/RayCast.xml b/doc/classes/RayCast.xml index b75b72b218..3782a98e3e 100644 --- a/doc/classes/RayCast.xml +++ b/doc/classes/RayCast.xml @@ -180,7 +180,7 @@ The ray's destination point, relative to the RayCast's [code]position[/code]. </member> <member name="collision_layer" type="int" setter="set_collision_layer" getter="get_collision_layer"> - The RayCast's collison layer(s). Only bodies in the same collision layer(s) will be detected. + The RayCast's collision layer(s). Only bodies in the same collision layer(s) will be detected. </member> <member name="enabled" type="bool" setter="set_enabled" getter="is_enabled"> If [code]true[/code], collisions will be reported. Default value: [code]false[/code]. diff --git a/doc/classes/RayCast2D.xml b/doc/classes/RayCast2D.xml index a42d2ab587..74ee0a8911 100644 --- a/doc/classes/RayCast2D.xml +++ b/doc/classes/RayCast2D.xml @@ -195,7 +195,7 @@ The ray's destination point, relative to the RayCast's [code]position[/code]. </member> <member name="collision_layer" type="int" setter="set_collision_layer" getter="get_collision_layer"> - The RayCast2D's collison layer(s). Only bodies in the same collision layer(s) will be detected. + The RayCast2D's collision layer(s). Only bodies in the same collision layer(s) will be detected. </member> <member name="enabled" type="bool" setter="set_enabled" getter="is_enabled"> If [code]true[/code], collisions will be reported. Default value: [code]false[/code]. diff --git a/doc/classes/SliderJoint.xml b/doc/classes/SliderJoint.xml index 617390b6a4..adea8658d1 100644 --- a/doc/classes/SliderJoint.xml +++ b/doc/classes/SliderJoint.xml @@ -1,8 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="SliderJoint" inherits="Joint" category="Core" version="3.0.alpha.custom_build"> <brief_description> + Piston kind of slider between two bodies in 3D. </brief_description> <description> + Slides across the x-axis of the [Pivot] object. </description> <tutorials> </tutorials> @@ -30,96 +32,144 @@ </methods> <members> <member name="angular_limit/damping" type="float" setter="set_param" getter="get_param"> + The amount of damping of the rotation when the limit is surpassed. + A lower damping value allows a rotation initiated by body A to travel to body B slower. </member> <member name="angular_limit/lower_angle" type="float" setter="_set_lower_limit_angular" getter="_get_lower_limit_angular"> + The lower limit of rotation in the slider. </member> <member name="angular_limit/restitution" type="float" setter="set_param" getter="get_param"> + The amount of restitution of the rotation when the limit is surpassed. + Does not affect damping. </member> <member name="angular_limit/softness" type="float" setter="set_param" getter="get_param"> + A factor applied to the all rotation once the limit is surpassed. + Makes all rotation slower when between 0 and 1. </member> <member name="angular_limit/upper_angle" type="float" setter="_set_upper_limit_angular" getter="_get_upper_limit_angular"> + The upper limit of rotation in the slider. </member> <member name="angular_motion/damping" type="float" setter="set_param" getter="get_param"> + The amount of damping of the rotation in the limits. </member> <member name="angular_motion/restitution" type="float" setter="set_param" getter="get_param"> + The amount of restitution of the rotation in the limits. </member> <member name="angular_motion/softness" type="float" setter="set_param" getter="get_param"> + A factor applied to the all rotation in the limits. </member> <member name="angular_ortho/damping" type="float" setter="set_param" getter="get_param"> + The amount of damping of the rotation across axes orthogonal to the slider. </member> <member name="angular_ortho/restitution" type="float" setter="set_param" getter="get_param"> + The amount of restitution of the rotation across axes orthogonal to the slider. </member> <member name="angular_ortho/softness" type="float" setter="set_param" getter="get_param"> + A factor applied to the all rotation across axes orthogonal to the slider. </member> <member name="linear_limit/damping" type="float" setter="set_param" getter="get_param"> + The amount of damping that happens once the limit defined by [member linear_limit/lower_distance] and [member linear_limit/upper_distance] is surpassed. </member> <member name="linear_limit/lower_distance" type="float" setter="set_param" getter="get_param"> + The minimum difference between the pivot points on their x-axis before damping happens. </member> <member name="linear_limit/restitution" type="float" setter="set_param" getter="get_param"> + The amount of restitution once the limits are surpassed. The lower, the more velocity-energy gets lost. </member> <member name="linear_limit/softness" type="float" setter="set_param" getter="get_param"> + A factor applied to the movement accross the slider axis once the limits get surpassed. The lower, the slower the movement. </member> <member name="linear_limit/upper_distance" type="float" setter="set_param" getter="get_param"> + The maximum difference between the pivot points on their x-axis before damping happens. </member> <member name="linear_motion/damping" type="float" setter="set_param" getter="get_param"> + The amount of damping inside the slider limits. </member> <member name="linear_motion/restitution" type="float" setter="set_param" getter="get_param"> + The amount of restitution inside the slider limits. </member> <member name="linear_motion/softness" type="float" setter="set_param" getter="get_param"> + A factor applied to the movement accross the slider axis as long as the slider is in the limits. The lower, the slower the movement. </member> <member name="linear_ortho/damping" type="float" setter="set_param" getter="get_param"> + The amount of damping when movement is accross axes orthogonal to the slider. </member> <member name="linear_ortho/restitution" type="float" setter="set_param" getter="get_param"> + The amount of restitution when movement is accross axes orthogonal to the slider. </member> <member name="linear_ortho/softness" type="float" setter="set_param" getter="get_param"> + A factor applied to the movement accross axes orthogonal to the slider. </member> </members> <constants> <constant name="PARAM_LINEAR_LIMIT_UPPER" value="0"> + The maximum difference between the pivot points on their x-axis before damping happens. </constant> <constant name="PARAM_LINEAR_LIMIT_LOWER" value="1"> + The minimum difference between the pivot points on their x-axis before damping happens. </constant> <constant name="PARAM_LINEAR_LIMIT_SOFTNESS" value="2"> + A factor applied to the movement accross the slider axis once the limits get surpassed. The lower, the slower the movement. </constant> <constant name="PARAM_LINEAR_LIMIT_RESTITUTION" value="3"> + The amount of restitution once the limits are surpassed. The lower, the more velocityenergy gets lost. </constant> <constant name="PARAM_LINEAR_LIMIT_DAMPING" value="4"> + The amount of damping once the slider limits are surpassed. </constant> <constant name="PARAM_LINEAR_MOTION_SOFTNESS" value="5"> + A factor applied to the movement accross the slider axis as long as the slider is in the limits. The lower, the slower the movement. </constant> <constant name="PARAM_LINEAR_MOTION_RESTITUTION" value="6"> + The amount of restitution inside the slider limits. </constant> <constant name="PARAM_LINEAR_MOTION_DAMPING" value="7"> + The amount of damping inside the slider limits. </constant> <constant name="PARAM_LINEAR_ORTHOGONAL_SOFTNESS" value="8"> + A factor applied to the movement accross axes orthogonal to the slider. </constant> <constant name="PARAM_LINEAR_ORTHOGONAL_RESTITUTION" value="9"> + The amount of restitution when movement is accross axes orthogonal to the slider. </constant> <constant name="PARAM_LINEAR_ORTHOGONAL_DAMPING" value="10"> + The amount of damping when movement is accross axes orthogonal to the slider. </constant> <constant name="PARAM_ANGULAR_LIMIT_UPPER" value="11"> + The upper limit of rotation in the slider. </constant> <constant name="PARAM_ANGULAR_LIMIT_LOWER" value="12"> + The lower limit of rotation in the slider. </constant> <constant name="PARAM_ANGULAR_LIMIT_SOFTNESS" value="13"> + A factor applied to the all rotation once the limit is surpassed. </constant> <constant name="PARAM_ANGULAR_LIMIT_RESTITUTION" value="14"> + The amount of restitution of the rotation when the limit is surpassed. </constant> <constant name="PARAM_ANGULAR_LIMIT_DAMPING" value="15"> + The amount of damping of the rotation when the limit is surpassed. </constant> <constant name="PARAM_ANGULAR_MOTION_SOFTNESS" value="16"> + A factor applied to the all rotation in the limits. </constant> <constant name="PARAM_ANGULAR_MOTION_RESTITUTION" value="17"> + The amount of restitution of the rotation in the limits. </constant> <constant name="PARAM_ANGULAR_MOTION_DAMPING" value="18"> + The amount of damping of the rotation in the limits. </constant> <constant name="PARAM_ANGULAR_ORTHOGONAL_SOFTNESS" value="19"> + A factor applied to the all rotation across axes orthogonal to the slider. </constant> <constant name="PARAM_ANGULAR_ORTHOGONAL_RESTITUTION" value="20"> + The amount of restitution of the rotation across axes orthogonal to the slider. </constant> <constant name="PARAM_ANGULAR_ORTHOGONAL_DAMPING" value="21"> + The amount of damping of the rotation across axes orthogonal to the slider. </constant> <constant name="PARAM_MAX" value="22"> + End flag of PARAM_* constants, used internally. </constant> </constants> </class> diff --git a/doc/classes/Spatial.xml b/doc/classes/Spatial.xml index 54eb82fbff..abb0bfa246 100644 --- a/doc/classes/Spatial.xml +++ b/doc/classes/Spatial.xml @@ -209,7 +209,7 @@ <argument index="0" name="enable" type="bool"> </argument> <description> - Makes the node ignore its parents tranformations. Node tranformations are only in global space. + Makes the node ignore its parents transformations. Node transformations are only in global space. </description> </method> <method name="set_gizmo"> @@ -234,7 +234,7 @@ <return type="void"> </return> <description> - Reset all tranformations for this node. Set its [Transform3D] to identity matrix. + Reset all transformations for this node. Set its [Transform3D] to identity matrix. </description> </method> <method name="set_ignore_transform_notification"> @@ -329,7 +329,7 @@ <argument index="0" name="local_point" type="Vector3"> </argument> <description> - Tranforms [Vector3] "local_point" from this node's local space to world space. + Transforms [Vector3] "local_point" from this node's local space to world space. </description> </method> <method name="to_local" qualifiers="const"> @@ -338,7 +338,7 @@ <argument index="0" name="global_point" type="Vector3"> </argument> <description> - Tranforms [Vector3] "global_point" from world space to this node's local space. + Transforms [Vector3] "global_point" from world space to this node's local space. </description> </method> <method name="translate"> diff --git a/doc/classes/StyleBoxFlat.xml b/doc/classes/StyleBoxFlat.xml index b09b9f0679..756b7f9225 100644 --- a/doc/classes/StyleBoxFlat.xml +++ b/doc/classes/StyleBoxFlat.xml @@ -14,12 +14,12 @@ [codeblock] height = 30 corner_radius_top_left = 50 - corner_raidus_bottom_left = 100 + corner_radius_bottom_left = 100 [/codeblock] The relative system now would take the 1:2 ratio of the two left corners to calculate the actual corner width. Both corners added will [b]never[/b] be more than the height. Result: [codeblock] corner_radius_top_left: 10 - corner_raidus_bottom_left: 20 + corner_radius_bottom_left: 20 [/codeblock] </description> <tutorials> @@ -268,7 +268,7 @@ </methods> <members> <member name="anti_aliasing" type="bool" setter="set_anti_aliased" getter="is_anti_aliased"> - Anti Aliasing draws a small ring around edges. This ring fades to transparent. As a result edges look much smoother. This is only noticable when using rounded corners. + Anti Aliasing draws a small ring around edges. This ring fades to transparent. As a result edges look much smoother. This is only noticeable when using rounded corners. </member> <member name="anti_aliasing_size" type="int" setter="set_aa_size" getter="get_aa_size"> This changes the size of the faded ring. Higher values can be used to achieve a "blurry" effect. diff --git a/doc/classes/TabContainer.xml b/doc/classes/TabContainer.xml index ffe99eb82b..ad02064862 100644 --- a/doc/classes/TabContainer.xml +++ b/doc/classes/TabContainer.xml @@ -16,14 +16,14 @@ <return type="bool"> </return> <description> - Return whether the tabs should be visible or hidden. + Returns [code]true[/code] if the tabs are visible. </description> </method> <method name="get_current_tab" qualifiers="const"> <return type="int"> </return> <description> - Return the current tab index that is being shown. + Returns the current tab index that is being shown. </description> </method> <method name="get_current_tab_control" qualifiers="const"> @@ -42,14 +42,14 @@ <return type="int"> </return> <description> - Return the previous tab index that was being shown. + Returns the previous tab index that was being shown. </description> </method> <method name="get_tab_align" qualifiers="const"> <return type="int" enum="TabContainer.TabAlign"> </return> <description> - Return tab alignment, from the ALIGN_* enum. + Returns the tab alignment.See the ALIGN_* constants. </description> </method> <method name="get_tab_control" qualifiers="const"> @@ -58,14 +58,14 @@ <argument index="0" name="idx" type="int"> </argument> <description> - Return the current tab control that is being shown. + Returns the current tab control that is being shown. </description> </method> <method name="get_tab_count" qualifiers="const"> <return type="int"> </return> <description> - Return the amount of tabs. + Returns the amount of tabs. </description> </method> <method name="get_tab_disabled" qualifiers="const"> @@ -74,6 +74,7 @@ <argument index="0" name="tab_idx" type="int"> </argument> <description> + Returns [code]true[/code] if the tab at index [code]tab_idx[/code] is disabled. </description> </method> <method name="get_tab_icon" qualifiers="const"> @@ -82,6 +83,7 @@ <argument index="0" name="tab_idx" type="int"> </argument> <description> + Returns the [Texture] for the tab at index [code]tab_idx[/code] or null if the tab has no [Texture]. </description> </method> <method name="get_tab_title" qualifiers="const"> @@ -90,7 +92,7 @@ <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 overridden. + Returns the title for the tab at index [code]tab_idx[/code]. Tab titles are by default the children node name, but this can be overridden. </description> </method> <method name="set_current_tab"> @@ -127,6 +129,7 @@ <argument index="1" name="disabled" type="bool"> </argument> <description> + Set tab at index [code]tab_idx[/code] disabled. </description> </method> <method name="set_tab_icon"> @@ -137,7 +140,7 @@ <argument index="1" name="icon" type="Texture"> </argument> <description> - Set an icon for a tab. + Set an icon for a tab at index [code]tab_idx[/code]. </description> </method> <method name="set_tab_title"> @@ -148,7 +151,7 @@ <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 overridden. + Set a title for the tab at index [code]tab_idx[/code]. Tab titles are by default the children node name, but this can be overridden. </description> </method> <method name="set_tabs_visible"> @@ -157,16 +160,19 @@ <argument index="0" name="visible" type="bool"> </argument> <description> - Set whether the tabs should be visible or hidden. + If [code]true[/code] all the tabs will be visible. </description> </method> </methods> <members> <member name="current_tab" type="int" setter="set_current_tab" getter="get_current_tab"> + The current tab. </member> <member name="tab_align" type="int" setter="set_tab_align" getter="get_tab_align" enum="TabContainer.TabAlign"> + The alignment of all the tabs of the tab container. See the [code]ALIGN_*[/code] constants. </member> <member name="tabs_visible" type="bool" setter="set_tabs_visible" getter="are_tabs_visible"> + If [code]true[/code] all tabs that are children of the TabContainer will be visible. </member> </members> <signals> diff --git a/doc/classes/TouchScreenButton.xml b/doc/classes/TouchScreenButton.xml index 8a96fa1454..51cb7f86f2 100644 --- a/doc/classes/TouchScreenButton.xml +++ b/doc/classes/TouchScreenButton.xml @@ -1,8 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="TouchScreenButton" inherits="Node2D" category="Core" version="3.0.alpha.custom_build"> <brief_description> + Button for touch screen devices. </brief_description> <description> + Button for touch screen devices. You can set it to be visible on all screens, or only on touch devices. </description> <tutorials> </tutorials> @@ -13,36 +15,42 @@ <return type="String"> </return> <description> + Returns the button's action. </description> </method> <method name="get_bitmask" qualifiers="const"> <return type="BitMap"> </return> <description> + Returns the button's bitmask. </description> </method> <method name="get_shape" qualifiers="const"> <return type="Shape2D"> </return> <description> + Returns the button's shape. </description> </method> <method name="get_texture" qualifiers="const"> <return type="Texture"> </return> <description> + Returns the button's texture for the normal state. </description> </method> <method name="get_texture_pressed" qualifiers="const"> <return type="Texture"> </return> <description> + Returns the button's texture for the pressed state. </description> </method> <method name="get_visibility_mode" qualifiers="const"> <return type="int" enum="TouchScreenButton.VisibilityMode"> </return> <description> + Sets the button's visibility mode. See [code]VISIBILITY_*[/code] constants. </description> </method> <method name="is_passby_press_enabled" qualifiers="const"> @@ -55,6 +63,7 @@ <return type="bool"> </return> <description> + Returns [code]true[/code] if this button is currently pressed. </description> </method> <method name="is_shape_centered" qualifiers="const"> @@ -75,6 +84,7 @@ <argument index="0" name="action" type="String"> </argument> <description> + Sets the button's action. </description> </method> <method name="set_bitmask"> @@ -83,6 +93,7 @@ <argument index="0" name="bitmask" type="BitMap"> </argument> <description> + Sets the button's [BitMap] bitmask. </description> </method> <method name="set_passby_press"> @@ -91,6 +102,7 @@ <argument index="0" name="enabled" type="bool"> </argument> <description> + If [code]true[/code] passby presses are enabled for this button. </description> </method> <method name="set_shape"> @@ -99,6 +111,7 @@ <argument index="0" name="shape" type="Shape2D"> </argument> <description> + Sets the button's shape. </description> </method> <method name="set_shape_centered"> @@ -107,6 +120,7 @@ <argument index="0" name="bool" type="bool"> </argument> <description> + If [code]true[/code] the button's shape is centered. </description> </method> <method name="set_shape_visible"> @@ -115,6 +129,7 @@ <argument index="0" name="bool" type="bool"> </argument> <description> + If [code]true[/code] the button's shape is visible. </description> </method> <method name="set_texture"> @@ -123,6 +138,7 @@ <argument index="0" name="texture" type="Texture"> </argument> <description> + Sets the button's [Texture] for the normal state. </description> </method> <method name="set_texture_pressed"> @@ -131,6 +147,7 @@ <argument index="0" name="texture_pressed" type="Texture"> </argument> <description> + Sets the button's [Texture] for the pressed state. </description> </method> <method name="set_visibility_mode"> @@ -139,43 +156,57 @@ <argument index="0" name="mode" type="int" enum="TouchScreenButton.VisibilityMode"> </argument> <description> + Sets the button's visibility mode. See the [code]VISIBILITY_*[/code] constants. </description> </method> </methods> <members> <member name="action" type="String" setter="set_action" getter="get_action"> + The button's action. Actions can be handled with [InputEventAction]. </member> <member name="bitmask" type="BitMap" setter="set_bitmask" getter="get_bitmask"> + The button's bitmask. </member> <member name="normal" type="Texture" setter="set_texture" getter="get_texture"> + The button's texture for the normal state. </member> <member name="passby_press" type="bool" setter="set_passby_press" getter="is_passby_press_enabled"> + If [code]true[/code] passby presses are enabled. </member> <member name="pressed" type="Texture" setter="set_texture_pressed" getter="get_texture_pressed"> + The button's texture for the pressed state. </member> <member name="shape" type="Shape2D" setter="set_shape" getter="get_shape"> + The button's shape. </member> <member name="shape_centered" type="bool" setter="set_shape_centered" getter="is_shape_centered"> + If [code]true[/code] the button's shape is centered. </member> <member name="shape_visible" type="bool" setter="set_shape_visible" getter="is_shape_visible"> + If [code]true[/code] the button's shape is visible. </member> <member name="visibility_mode" type="int" setter="set_visibility_mode" getter="get_visibility_mode" enum="TouchScreenButton.VisibilityMode"> + The button's visibility mode. See [code]VISIBILITY_*[/code] constants. </member> </members> <signals> <signal name="pressed"> <description> + Emitted when the button is pressed (down). </description> </signal> <signal name="released"> <description> + Emitted when the button is released (up). </description> </signal> </signals> <constants> <constant name="VISIBILITY_ALWAYS" value="0"> + Always visible. </constant> <constant name="VISIBILITY_TOUCHSCREEN_ONLY" value="1"> + Visible on touch screens only. </constant> </constants> </class> diff --git a/doc/classes/Transform.xml b/doc/classes/Transform.xml index 6780de1943..cd80d568e7 100644 --- a/doc/classes/Transform.xml +++ b/doc/classes/Transform.xml @@ -68,7 +68,7 @@ <return type="Transform"> </return> <description> - Returns the inverse of the transfrom, under the assumption that the transformation is composed of rotation, scaling and translation. + Returns the inverse of the transform, under the assumption that the transformation is composed of rotation, scaling and translation. </description> </method> <method name="interpolate_with"> @@ -104,7 +104,7 @@ <return type="Transform"> </return> <description> - Returns the transfrom with the basis orthogonal (90 degrees), and normalized axis vectors. + Returns the transform with the basis orthogonal (90 degrees), and normalized axis vectors. </description> </method> <method name="rotated"> diff --git a/doc/classes/Transform2D.xml b/doc/classes/Transform2D.xml index 0e39505ac3..76b9b0e845 100644 --- a/doc/classes/Transform2D.xml +++ b/doc/classes/Transform2D.xml @@ -112,7 +112,7 @@ <return type="Transform2D"> </return> <description> - Returns the transfrom with the basis orthogonal (90 degrees), and normalized axis vectors. + Returns the transform with the basis orthogonal (90 degrees), and normalized axis vectors. </description> </method> <method name="rotated"> diff --git a/doc/classes/Tween.xml b/doc/classes/Tween.xml index c90ac09557..23229aec4a 100644 --- a/doc/classes/Tween.xml +++ b/doc/classes/Tween.xml @@ -12,7 +12,7 @@ tween.start() [/codeblock] Some of the methods of this class require a property name. You can get the property name by hovering over the property in the inspector of the editor. - Many of the methods accept [code]trans_type[/code] and [code]ease_type[/code]. The first accepts an TRANS_* constant, and refers to the way the timing of the animation is handled (you might want to see [code]http://easings.net/[/code] for some examples). The second accepts an EASE_* constant, and controls the where [code]trans_type[/code] is applied to the interpolation (in the beginning, the end, or both). If you don't know which transision and easing to pick, you can try different TRANS_* constants with EASE_IN_OUT, and use the one that looks best. + Many of the methods accept [code]trans_type[/code] and [code]ease_type[/code]. The first accepts an TRANS_* constant, and refers to the way the timing of the animation is handled (you might want to see [code]http://easings.net/[/code] for some examples). The second accepts an EASE_* constant, and controls the where [code]trans_type[/code] is applied to the interpolation (in the beginning, the end, or both). If you don't know which transition and easing to pick, you can try different TRANS_* constants with EASE_IN_OUT, and use the one that looks best. </description> <tutorials> </tutorials> @@ -135,7 +135,7 @@ <argument index="7" name="arg5" type="Variant" default="null"> </argument> <description> - Call [code]callback[/code] of [code]object[/code] after [code]duration[/code] on the main thread (similar to [methog Object.call_deferred). [code]arg1[/code]-[code]arg5[/code] are arguments to be passed to the callback. + Call [code]callback[/code] of [code]object[/code] after [code]duration[/code] on the main thread (similar to [method Object.call_deferred]). [code]arg1[/code]-[code]arg5[/code] are arguments to be passed to the callback. </description> </method> <method name="interpolate_method"> @@ -158,7 +158,7 @@ <argument index="7" name="delay" type="float" default="0"> </argument> <description> - Animate [code]method[/code] of [code]object[/code] from [code]initial_val[/code] to [code]final_val[/code] for [code]duration[/code] seconds, [code]delay[/code] seconds later. Methods are animated by calling them with consecuitive values. + Animate [code]method[/code] of [code]object[/code] from [code]initial_val[/code] to [code]final_val[/code] for [code]duration[/code] seconds, [code]delay[/code] seconds later. Methods are animated by calling them with consecutive values. [code]trans_type[/code] accepts TRANS_* constants, and is the way the animation is interpolated, while [code]ease_type[/code] accepts EASE_* constants, and controls the place of the interpolation (the beginning, the end, or both). You can read more about them in the class description. </description> </method> @@ -346,7 +346,7 @@ <argument index="8" name="delay" type="float" default="0"> </argument> <description> - Animate [code]method[/code] of [code]object[/code] from the value returned by [code]initial.initial_method[/code] to [code]final_val[/code] for [code]duration[/code] seconds, [code]delay[/code] seconds later. Methods are animated by calling them with consecuitive values. + Animate [code]method[/code] of [code]object[/code] from the value returned by [code]initial.initial_method[/code] to [code]final_val[/code] for [code]duration[/code] seconds, [code]delay[/code] seconds later. Methods are animated by calling them with consecutive values. [code]trans_type[/code] accepts TRANS_* constants, and is the way the animation is interpolated, while [code]ease_type[/code] accepts EASE_* constants, and controls the place of the interpolation (the beginning, the end, or both). You can read more about them in the class description. </description> </method> diff --git a/doc/classes/VideoPlayer.xml b/doc/classes/VideoPlayer.xml index bac7d1e3b0..5387ec30b3 100644 --- a/doc/classes/VideoPlayer.xml +++ b/doc/classes/VideoPlayer.xml @@ -22,7 +22,7 @@ <return type="int"> </return> <description> - Get the amount of miliseconds to store in buffer while playing. + Get the amount of milliseconds to store in buffer while playing. </description> </method> <method name="get_stream" qualifiers="const"> @@ -126,7 +126,7 @@ <argument index="0" name="msec" type="int"> </argument> <description> - Set the amount of miliseconds to buffer during playback. + Set the amount of milliseconds to buffer during playback. </description> </method> <method name="set_expand"> diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml index 2cf36ba69b..58626356bf 100644 --- a/doc/classes/Viewport.xml +++ b/doc/classes/Viewport.xml @@ -192,14 +192,14 @@ <return type="Variant"> </return> <description> - Returs the drag data from the GUI, that was previously returned by [method Control.get_drag_data]. + Returns the drag data from the GUI, that was previously returned by [method Control.get_drag_data]. </description> </method> <method name="gui_has_modal_stack" qualifiers="const"> <return type="bool"> </return> <description> - Returs whether there are shown modals on-screen. + Returns whether there are shown modals on-screen. </description> </method> <method name="has_transparent_background" qualifiers="const"> diff --git a/doc/classes/VisualScript.xml b/doc/classes/VisualScript.xml index e44547cd8f..8961ff1564 100644 --- a/doc/classes/VisualScript.xml +++ b/doc/classes/VisualScript.xml @@ -4,7 +4,7 @@ A script implemented in the Visual Script programming environment. </brief_description> <description> - A script implemented in the Visual Script programming environment. The script exends the functionality of all objects that instance it. + A script implemented in the Visual Script programming environment. The script extends the functionality of all objects that instance it. [method Object.set_script] extends an existing object, if that object's class matches one of the script's base classes. You are most likely to use this class via the Visual Script editor or when writing plugins for it. </description> diff --git a/doc/classes/VisualScriptClassConstant.xml b/doc/classes/VisualScriptClassConstant.xml index 70e7de5dd9..0377fa8f09 100644 --- a/doc/classes/VisualScriptClassConstant.xml +++ b/doc/classes/VisualScriptClassConstant.xml @@ -1,10 +1,14 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="VisualScriptClassConstant" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> <brief_description> - A Visual Script node representing a constant from a class. + Gets a constant from a given class. </brief_description> <description> - A Visual Script node representing a constant from the classes, such as [@GlobalScope.TYPE_INT]. + This node returns a constant from a given class, such as [@GlobalScope.TYPE_INT]. See the given class' documentation for available constants. + [b]Input Ports:[/b] + none + [b]Output Ports:[/b] + - Data (variant): [code]value[/code] </description> <tutorials> </tutorials> @@ -42,10 +46,10 @@ </methods> <members> <member name="base_type" type="String" setter="set_base_type" getter="get_base_type"> - The type to get the constant from. + The constant's parent class. </member> <member name="constant" type="String" setter="set_class_constant" getter="get_class_constant"> - The name of the constant to return. + The constant to return. See the given class for its available constants. </member> </members> <constants> diff --git a/doc/classes/VisualScriptConstant.xml b/doc/classes/VisualScriptConstant.xml index 508087a928..2a704adecf 100644 --- a/doc/classes/VisualScriptConstant.xml +++ b/doc/classes/VisualScriptConstant.xml @@ -1,10 +1,14 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="VisualScriptConstant" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> <brief_description> - A Visual Script node which returns a constant value. + Gets a contant's value. </brief_description> <description> - A Visual Script node which returns the specified constant value. + This node returns a constant's value. + [b]Input Ports:[/b] + none + [b]Output Ports:[/b] + - Data (variant): [code]get[/code] </description> <tutorials> </tutorials> diff --git a/doc/classes/VisualScriptEmitSignal.xml b/doc/classes/VisualScriptEmitSignal.xml index 844b5a40ec..8d132ed321 100644 --- a/doc/classes/VisualScriptEmitSignal.xml +++ b/doc/classes/VisualScriptEmitSignal.xml @@ -1,10 +1,14 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="VisualScriptEmitSignal" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> <brief_description> - A Visual Script node which emits a specified signal. + Emits a specified signal. </brief_description> <description> - A Visual Script node which emits a specified signal when it is executed. + Emits a specified signal when it is executed. + [b]Input Ports:[/b] + - Sequence: [code]emit[/code] + [b]Output Ports:[/b] + - Sequence </description> <tutorials> </tutorials> diff --git a/doc/classes/VisualScriptIterator.xml b/doc/classes/VisualScriptIterator.xml index 74309fcf00..1f9a4fddde 100644 --- a/doc/classes/VisualScriptIterator.xml +++ b/doc/classes/VisualScriptIterator.xml @@ -1,8 +1,17 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="VisualScriptIterator" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> <brief_description> + Steps through items in a given input. </brief_description> <description> + This node steps through each item in a given input. Input can be any sequence data type, such as an [Array] or [String]. When each item has been processed, execution passed out the [code]exit[/code] Sequence port. + [b]Input Ports:[/b] + - Sequence: [code]for (elem) in (input)[/code] + - Data (variant): [code]input[/code] + [b]Output Ports:[/b] + - Sequence: [code]each[/code] + - Sequence: [code]exit[/code] + - Data (variant): [code]elem[/code] </description> <tutorials> </tutorials> diff --git a/doc/classes/VisualScriptLocalVar.xml b/doc/classes/VisualScriptLocalVar.xml index 7db550d5fe..bca19d06d5 100644 --- a/doc/classes/VisualScriptLocalVar.xml +++ b/doc/classes/VisualScriptLocalVar.xml @@ -1,8 +1,14 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="VisualScriptLocalVar" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> <brief_description> + Gets a local variable's value. </brief_description> <description> + This node returns a local variable's value. "Var Name" must be supplied, with an optional type. + [b]Input Ports:[/b] + none + [b]Output Ports:[/b] + - Data (variant): [code]get[/code] </description> <tutorials> </tutorials> @@ -40,8 +46,10 @@ </methods> <members> <member name="type" type="int" setter="set_var_type" getter="get_var_type" enum="Variant.Type"> + The local variable's type. </member> <member name="var_name" type="String" setter="set_var_name" getter="get_var_name"> + The local variable's name. </member> </members> <constants> diff --git a/doc/classes/VisualScriptLocalVarSet.xml b/doc/classes/VisualScriptLocalVarSet.xml index 6e69f13383..67a5efa33e 100644 --- a/doc/classes/VisualScriptLocalVarSet.xml +++ b/doc/classes/VisualScriptLocalVarSet.xml @@ -1,8 +1,16 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="VisualScriptLocalVarSet" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> <brief_description> + Changes a local variable's value. </brief_description> <description> + The node changes a local variable's value to the given input. The new value is also provided on an output Data port. + [b]Input Ports:[/b] + - Sequence + - Data (variant): [code]set[/code] + [b]Output Ports:[/b] + - Sequence + - Data (variant): [code]get[/code] </description> <tutorials> </tutorials> @@ -40,8 +48,10 @@ </methods> <members> <member name="type" type="int" setter="set_var_type" getter="get_var_type" enum="Variant.Type"> + The local variable's type. </member> <member name="var_name" type="String" setter="set_var_name" getter="get_var_name"> + The local variable's name. </member> </members> <constants> diff --git a/doc/classes/VisualScriptMathConstant.xml b/doc/classes/VisualScriptMathConstant.xml index 1ef7d71e10..86744e5caf 100644 --- a/doc/classes/VisualScriptMathConstant.xml +++ b/doc/classes/VisualScriptMathConstant.xml @@ -1,8 +1,14 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="VisualScriptMathConstant" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> <brief_description> + Commonly used mathematical constants. </brief_description> <description> + Provides common math constants, such as Pi or Euler's constant, on an output Data port. + [b]Input Ports:[/b] + none + [b]Output Ports:[/b] + - Data (variant): [code]get[/code] </description> <tutorials> </tutorials> @@ -26,24 +32,33 @@ </methods> <members> <member name="constant" type="int" setter="set_math_constant" getter="get_math_constant" enum="VisualScriptMathConstant.MathConstant"> + The math constant. </member> </members> <constants> <constant name="MATH_CONSTANT_ONE" value="0"> + Unity: [code]1[/code] </constant> <constant name="MATH_CONSTANT_PI" value="1"> + Pi: [code]3.141593[/code] </constant> <constant name="MATH_CONSTANT_2PI" value="2"> + Pi times two: [code]6.283185[/code] </constant> <constant name="MATH_CONSTANT_HALF_PI" value="3"> + Pi divided by two: [code]1.570796[/code] </constant> <constant name="MATH_CONSTANT_E" value="4"> + Natural log: [code]2.718282[/code] </constant> <constant name="MATH_CONSTANT_SQRT2" value="5"> + Square root of two: [code]1.414214[/code] </constant> <constant name="MATH_CONSTANT_INF" value="6"> + Infinity: [code]inf[/code] </constant> <constant name="MATH_CONSTANT_NAN" value="7"> + Not a number: [code]nan[/code] </constant> <constant name="MATH_CONSTANT_MAX" value="8"> </constant> diff --git a/doc/classes/VisualScriptOperator.xml b/doc/classes/VisualScriptOperator.xml index 7e85af8af2..de08075af2 100644 --- a/doc/classes/VisualScriptOperator.xml +++ b/doc/classes/VisualScriptOperator.xml @@ -7,9 +7,7 @@ - Data (variant): [code]A[/code] - Data (variant): [code]B[/code] [b]Output Ports:[/b] - - Sequence: [code]true[/code] - - Sequence: [code]false[/code] - - Sequence: [code]done[/code] + - Data (variant): [code]result[/code] </description> <tutorials> </tutorials> diff --git a/doc/classes/VisualScriptReturn.xml b/doc/classes/VisualScriptReturn.xml index 55c53e17a0..ad18e96230 100644 --- a/doc/classes/VisualScriptReturn.xml +++ b/doc/classes/VisualScriptReturn.xml @@ -1,8 +1,15 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="VisualScriptReturn" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> <brief_description> + Exits a function and returns an optional value. </brief_description> <description> + Ends the execution of a function and returns control to the calling function. Optionally, it can return a [Variant] value. + [b]Input Ports:[/b] + - Sequence + - Data (variant): [code]result[/code] (optional) + [b]Output Ports:[/b] + none </description> <tutorials> </tutorials> @@ -40,8 +47,10 @@ </methods> <members> <member name="return_enabled" type="bool" setter="set_enable_return_value" getter="is_return_value_enabled"> + If [code]true[/code] the [code]return[/code] input port is available. </member> <member name="return_type" type="int" setter="set_return_type" getter="get_return_type" enum="Variant.Type"> + The return value's data type. </member> </members> <constants> diff --git a/doc/classes/VisualScriptSelf.xml b/doc/classes/VisualScriptSelf.xml index a60f7eee03..723b138722 100644 --- a/doc/classes/VisualScriptSelf.xml +++ b/doc/classes/VisualScriptSelf.xml @@ -1,8 +1,14 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="VisualScriptSelf" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> <brief_description> + Outputs a reference to the current instance. </brief_description> <description> + Provides a reference to the node running the visual script. + [b]Input Ports:[/b] + none + [b]Output Ports:[/b] + - Data (object): [code]instance[/code] </description> <tutorials> </tutorials> diff --git a/doc/classes/VisualScriptSequence.xml b/doc/classes/VisualScriptSequence.xml index a60c9e782b..4ea4203407 100644 --- a/doc/classes/VisualScriptSequence.xml +++ b/doc/classes/VisualScriptSequence.xml @@ -1,8 +1,16 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="VisualScriptSequence" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> <brief_description> + Executes a series of Sequence ports. </brief_description> <description> + Steps through a series of one or more output Sequence ports. The [code]current[/code] data port outputs the currently executing item. + [b]Input Ports:[/b] + - Sequence: [code]in order[/code] + [b]Output Ports:[/b] + - Sequence: [code]1[/code] + - Sequence: [code]2 - n[/code] (optional) + - Data (int): [code]current[/code] </description> <tutorials> </tutorials> @@ -26,6 +34,7 @@ </methods> <members> <member name="steps" type="int" setter="set_steps" getter="get_steps"> + The number of steps in the sequence. </member> </members> <constants> diff --git a/doc/classes/VisualScriptSwitch.xml b/doc/classes/VisualScriptSwitch.xml index 95ed737372..2540ae54cc 100644 --- a/doc/classes/VisualScriptSwitch.xml +++ b/doc/classes/VisualScriptSwitch.xml @@ -1,8 +1,19 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="VisualScriptSwitch" inherits="VisualScriptNode" category="Core" version="3.0.alpha.custom_build"> <brief_description> + Branches program flow based on a given input's value. </brief_description> <description> + Branches the flow based on an input's value. Use "Case Count" in the Inspector to set the number of branches and each comparison's optional type. + [b]Input Ports:[/b] + - Sequence: [code]'input' is[/code] + - Data (variant): [code]=[/code] + - Data (variant): [code]=[/code] (optional) + - Data (variant): [code]input[/code] + [b]Output Ports:[/b] + - Sequence + - Sequence (optional) + - Sequence: [code]done[/code] </description> <tutorials> </tutorials> diff --git a/doc/classes/VisualServer.xml b/doc/classes/VisualServer.xml index 85e6207d3f..4bc6a49e91 100644 --- a/doc/classes/VisualServer.xml +++ b/doc/classes/VisualServer.xml @@ -24,6 +24,20 @@ <description> </description> </method> + <method name="request_frame_drawn_callback"> + <return type="void"> + </return> + <argument index="0" name="where" type="Object"> + </argument> + <argument index="1" name="method" type="String"> + </argument> + <argument index="2" name="userdata" type="Variant"> + </argument> + <description> + Schedules a callback to the corresponding named 'method' on 'where' after a frame has been drawn. + The callback method must use only 1 argument which will be called with 'userdata'. + </description> + </method> <method name="texture_create"> <return type="RID"> </return> diff --git a/doc/classes/WeakRef.xml b/doc/classes/WeakRef.xml index 1071a40c3b..23629881d3 100644 --- a/doc/classes/WeakRef.xml +++ b/doc/classes/WeakRef.xml @@ -4,7 +4,7 @@ Holds an [Object], but does not contribute to the reference count if the object is a reference. </brief_description> <description> - A weakref can hold a [Reference], without contributing to the reference counter. A weakref can be created from an [Object] using [method @GDScript.weakref]. If this object is not a reference, weakref still works, however, it does not have any effect on the object. Weakrefs are useful in cases where multiple classes have variables that refer to eachother. Without weakrefs, using these classes could lead to memory leaks, since both references keep eachother from being released. Making part of the variables a weakref can prevent this cyclic dependency, and allows the references to be released. + A weakref can hold a [Reference], without contributing to the reference counter. A weakref can be created from an [Object] using [method @GDScript.weakref]. If this object is not a reference, weakref still works, however, it does not have any effect on the object. Weakrefs are useful in cases where multiple classes have variables that refer to each other. Without weakrefs, using these classes could lead to memory leaks, since both references keep each other from being released. Making part of the variables a weakref can prevent this cyclic dependency, and allows the references to be released. </description> <tutorials> </tutorials> |