diff options
Diffstat (limited to 'doc/classes')
39 files changed, 188 insertions, 367 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/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/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/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/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/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/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/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/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> |