diff options
Diffstat (limited to 'doc/classes')
50 files changed, 811 insertions, 80 deletions
diff --git a/doc/classes/AStar.xml b/doc/classes/AStar.xml index 6d7adc9935..9ca09371dd 100644 --- a/doc/classes/AStar.xml +++ b/doc/classes/AStar.xml @@ -157,6 +157,13 @@ If you change the 2nd point's weight to 3, then the result will be [code][1, 4, 3][/code] instead, because now even though the distance is longer, it's "easier" to get through point 4 than through point 2. </description> </method> + <method name="get_point_capacity" qualifiers="const"> + <return type="int"> + </return> + <description> + Returns the capacity of the structure backing the points, useful in conjunction with [code]reserve_space[/code]. + </description> + </method> <method name="get_point_connections"> <return type="PoolIntArray"> </return> @@ -178,6 +185,13 @@ [/codeblock] </description> </method> + <method name="get_point_count" qualifiers="const"> + <return type="int"> + </return> + <description> + Returns the number of points currently in the points pool. + </description> + </method> <method name="get_point_path"> <return type="PoolVector3Array"> </return> @@ -241,6 +255,15 @@ Removes the point associated with the given [code]id[/code] from the points pool. </description> </method> + <method name="reserve_space"> + <return type="void"> + </return> + <argument index="0" name="num_nodes" type="int"> + </argument> + <description> + Reserves space internally for [code]num_nodes[/code] points, useful if you're adding a known large number of points at once, for a grid for instance. New capacity must be greater or equals to old capacity. + </description> + </method> <method name="set_point_disabled"> <return type="void"> </return> diff --git a/doc/classes/AStar2D.xml b/doc/classes/AStar2D.xml index 9d51330139..0eff2bd560 100644 --- a/doc/classes/AStar2D.xml +++ b/doc/classes/AStar2D.xml @@ -134,6 +134,13 @@ If you change the 2nd point's weight to 3, then the result will be [code][1, 4, 3][/code] instead, because now even though the distance is longer, it's "easier" to get through point 4 than through point 2. </description> </method> + <method name="get_point_capacity" qualifiers="const"> + <return type="int"> + </return> + <description> + Returns the capacity of the structure backing the points, useful in conjunction with [code]reserve_space[/code]. + </description> + </method> <method name="get_point_connections"> <return type="PoolIntArray"> </return> @@ -155,6 +162,13 @@ [/codeblock] </description> </method> + <method name="get_point_count" qualifiers="const"> + <return type="int"> + </return> + <description> + Returns the number of points currently in the points pool. + </description> + </method> <method name="get_point_path"> <return type="PoolVector2Array"> </return> @@ -218,6 +232,15 @@ Removes the point associated with the given [code]id[/code] from the points pool. </description> </method> + <method name="reserve_space"> + <return type="void"> + </return> + <argument index="0" name="num_nodes" type="int"> + </argument> + <description> + Reserves space internally for [code]num_nodes[/code] points, useful if you're adding a known large number of points at once, for a grid for instance. New capacity must be greater or equals to old capacity. + </description> + </method> <method name="set_point_disabled"> <return type="void"> </return> diff --git a/doc/classes/AnimationPlayer.xml b/doc/classes/AnimationPlayer.xml index b4c44fe8eb..e510603281 100644 --- a/doc/classes/AnimationPlayer.xml +++ b/doc/classes/AnimationPlayer.xml @@ -165,6 +165,7 @@ </argument> <description> Queues an animation for playback once the current one is done. + [b]Note:[/b] If a looped animation is currently playing, the queued animation will never play unless the looped animation is stopped somehow. </description> </method> <method name="remove_animation"> diff --git a/doc/classes/AudioServer.xml b/doc/classes/AudioServer.xml index 6f82b103db..2d3ceebed5 100644 --- a/doc/classes/AudioServer.xml +++ b/doc/classes/AudioServer.xml @@ -32,12 +32,6 @@ Adds an [AudioEffect] effect to the bus [code]bus_idx[/code] at [code]at_position[/code]. </description> </method> - <method name="capture_get_device"> - <return type="String"> - </return> - <description> - </description> - </method> <method name="capture_get_device_list"> <return type="Array"> </return> @@ -45,14 +39,6 @@ Returns the names of all audio input devices detected on the system. </description> </method> - <method name="capture_set_device"> - <return type="void"> - </return> - <argument index="0" name="name" type="String"> - </argument> - <description> - </description> - </method> <method name="capture_start"> <return type="int" enum="Error"> </return> @@ -423,17 +409,25 @@ <member name="bus_count" type="int" setter="set_bus_count" getter="get_bus_count" default="1"> Number of available audio buses. </member> + <member name="capture_device" type="String" setter="capture_set_device" getter="capture_get_device" default=""""> + Name of the current device for audio input (see [method capture_get_device_list]). + </member> <member name="device" type="String" setter="set_device" getter="get_device" default=""Default""> Name of the current device for audio output (see [method get_device_list]). </member> - <member name="capture_device" type="String" setter="capture_set_device" getter="capture_get_device" default=""Default""> - Name of the current device for audio input (see [method capture_get_device_list]). - </member> <member name="global_rate_scale" type="float" setter="set_global_rate_scale" getter="get_global_rate_scale" default="1.0"> Scales the rate at which audio is played (i.e. setting it to [code]0.5[/code] will make the audio be played twice as fast). </member> </members> <signals> + <signal name="audio_mix_callback"> + <description> + </description> + </signal> + <signal name="audio_update_callback"> + <description> + </description> + </signal> <signal name="bus_layout_changed"> <description> Emitted when the [AudioBusLayout] changes. diff --git a/doc/classes/AudioStreamGenerator.xml b/doc/classes/AudioStreamGenerator.xml index 9d67b88c71..9a1e4432f1 100644 --- a/doc/classes/AudioStreamGenerator.xml +++ b/doc/classes/AudioStreamGenerator.xml @@ -5,6 +5,7 @@ <description> </description> <tutorials> + <link>https://github.com/godotengine/godot-demo-projects/tree/master/audio/generator</link> </tutorials> <methods> </methods> diff --git a/doc/classes/AudioStreamGeneratorPlayback.xml b/doc/classes/AudioStreamGeneratorPlayback.xml index 310b58c4e5..448284e670 100644 --- a/doc/classes/AudioStreamGeneratorPlayback.xml +++ b/doc/classes/AudioStreamGeneratorPlayback.xml @@ -5,6 +5,7 @@ <description> </description> <tutorials> + <link>https://github.com/godotengine/godot-demo-projects/tree/master/audio/generator</link> </tutorials> <methods> <method name="can_push_buffer" qualifiers="const"> diff --git a/doc/classes/AudioStreamSample.xml b/doc/classes/AudioStreamSample.xml index 6d03301749..a496902ded 100644 --- a/doc/classes/AudioStreamSample.xml +++ b/doc/classes/AudioStreamSample.xml @@ -24,6 +24,7 @@ <members> <member name="data" type="PoolByteArray" setter="set_data" getter="get_data" default="PoolByteArray( )"> Contains the audio data in bytes. + [b]Note:[/b] This property expects signed PCM8 data. To convert unsigned PCM8 to signed PCM8, subtract 128 from each byte. </member> <member name="format" type="int" setter="set_format" getter="get_format" enum="AudioStreamSample.Format" default="0"> Audio format. See [code]FORMAT_*[/code] constants for values. diff --git a/doc/classes/Basis.xml b/doc/classes/Basis.xml index 4d5c76a75c..df9438e695 100644 --- a/doc/classes/Basis.xml +++ b/doc/classes/Basis.xml @@ -208,5 +208,13 @@ </member> </members> <constants> + <constant name="IDENTITY" value="Basis( 1, 0, 0, 0, 1, 0, 0, 0, 1 )"> + </constant> + <constant name="FLIP_X" value="Basis( -1, 0, 0, 0, 1, 0, 0, 0, 1 )"> + </constant> + <constant name="FLIP_Y" value="Basis( 1, 0, 0, 0, -1, 0, 0, 0, 1 )"> + </constant> + <constant name="FLIP_Z" value="Basis( 1, 0, 0, 0, 1, 0, 0, 0, -1 )"> + </constant> </constants> </class> diff --git a/doc/classes/Button.xml b/doc/classes/Button.xml index adf826c26b..305be8b58d 100644 --- a/doc/classes/Button.xml +++ b/doc/classes/Button.xml @@ -15,7 +15,10 @@ Text alignment policy for the button's text, use one of the [code]ALIGN_*[/code] constants. </member> <member name="clip_text" type="bool" setter="set_clip_text" getter="get_clip_text" default="false"> - When this property is enabled, text that is too large to fit the button is clipped, when disabled the Button will always be wide enough to hold the text. This property is disabled by default. + When this property is enabled, text that is too large to fit the button is clipped, when disabled the Button will always be wide enough to hold the text. + </member> + <member name="expand_icon" type="bool" setter="set_expand_icon" getter="is_expand_icon" default="false"> + When enabled, the button's icon will expand/shrink to fit the button's size while keeping its aspect. </member> <member name="flat" type="bool" setter="set_flat" getter="is_flat" default="false"> Flat buttons don't display decoration. diff --git a/doc/classes/Camera2D.xml b/doc/classes/Camera2D.xml index f524a02934..16fb483249 100644 --- a/doc/classes/Camera2D.xml +++ b/doc/classes/Camera2D.xml @@ -110,7 +110,7 @@ <member name="drag_margin_bottom" type="float" setter="set_drag_margin" getter="get_drag_margin" default="0.2"> Bottom margin needed to drag the camera. A value of [code]1[/code] makes the camera move only when reaching the edge of the screen. </member> - <member name="drag_margin_h_enabled" type="bool" setter="set_h_drag_enabled" getter="is_h_drag_enabled" default="true"> + <member name="drag_margin_h_enabled" type="bool" setter="set_h_drag_enabled" getter="is_h_drag_enabled" default="false"> If [code]true[/code], the camera only moves when reaching the horizontal drag margins. If [code]false[/code], the camera moves horizontally regardless of margins. </member> <member name="drag_margin_left" type="float" setter="set_drag_margin" getter="get_drag_margin" default="0.2"> @@ -122,7 +122,7 @@ <member name="drag_margin_top" type="float" setter="set_drag_margin" getter="get_drag_margin" default="0.2"> Top margin needed to drag the camera. A value of [code]1[/code] makes the camera move only when reaching the edge of the screen. </member> - <member name="drag_margin_v_enabled" type="bool" setter="set_v_drag_enabled" getter="is_v_drag_enabled" default="true"> + <member name="drag_margin_v_enabled" type="bool" setter="set_v_drag_enabled" getter="is_v_drag_enabled" default="false"> If [code]true[/code], the camera only moves when reaching the vertical drag margins. If [code]false[/code], the camera moves vertically regardless of margins. </member> <member name="editor_draw_drag_margin" type="bool" setter="set_margin_drawing_enabled" getter="is_margin_drawing_enabled" default="false"> diff --git a/doc/classes/ClassDB.xml b/doc/classes/ClassDB.xml index b7b77bc02a..fd08643dd5 100644 --- a/doc/classes/ClassDB.xml +++ b/doc/classes/ClassDB.xml @@ -134,7 +134,7 @@ <argument index="2" name="no_inheritance" type="bool" default="false"> </argument> <description> - Returns whether [code]class[/code] (or its ancestry if [code]no_inheritance[/code] is false) has a method called [code]method[/code] or not. + Returns whether [code]class[/code] (or its ancestry if [code]no_inheritance[/code] is [code]false[/code]) has a method called [code]method[/code] or not. </description> </method> <method name="class_has_signal" qualifiers="const"> @@ -201,7 +201,7 @@ <argument index="0" name="class" type="String"> </argument> <description> - Returns whether this class is enabled or not. + Returns whether this [code]class[/code] is enabled or not. </description> </method> <method name="is_parent_class" qualifiers="const"> diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml index 6c3cf66c20..1eeef92ccc 100644 --- a/doc/classes/Control.xml +++ b/doc/classes/Control.xml @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="Control" inherits="CanvasItem" category="Core" version="3.2"> <brief_description> - All User Interface nodes inherit from Control. A control's anchors and margins adapt its position and size relative to its parent. + All user interface nodes inherit from Control. A control's anchors and margins adapt its position and size relative to its parent. </brief_description> <description> Base class for all UI-related nodes. [Control] features a bounding rectangle that defines its extents, an anchor position relative to its parent control or the current viewport, and margins that represent an offset to the anchor. The margins update automatically when the node, any of its parents, or the screen size change. @@ -49,10 +49,10 @@ [/codeblock] The event won't trigger if: * clicking outside the control (see [method has_point]); - * control has [member mouse_filter] set to [member MOUSE_FILTER_IGNORE]; - * control is obstructed by another [Control] on top of it, which doesn't have [member mouse_filter] set to [member MOUSE_FILTER_IGNORE]; - * control's parent has [member mouse_filter] set to [member MOUSE_FILTER_STOP] or has accepted the event; - * it happens outside parent's rectangle and the parent has either [member rect_clip_content] or [member _clips_input] enabled. + * control has [member mouse_filter] set to [constant MOUSE_FILTER_IGNORE]; + * control is obstructed by another [Control] on top of it, which doesn't have [member mouse_filter] set to [constant MOUSE_FILTER_IGNORE]; + * control's parent has [member mouse_filter] set to [constant MOUSE_FILTER_STOP] or has accepted the event; + * it happens outside parent's rectangle and the parent has either [member rect_clip_content] or [method _clips_input] enabled. </description> </method> <method name="_make_custom_tooltip" qualifiers="virtual"> @@ -63,7 +63,7 @@ <description> Virtual method to be implemented by the user. Returns a [Control] node that should be used as a tooltip instead of the default one. Use [code]for_text[/code] parameter to determine what text the tooltip should contain (likely the contents of [member hint_tooltip]). The returned node must be of type [Control] or Control-derieved. It can have child nodes of any type. It is freed when the tooltip disappears, so make sure you always provide a new instance, not e.g. a node from scene. When null or non-Control node is returned, the default tooltip will be used instead. - [b]Note:[/b] The tooltip is shrunk to miminal size. If you want to ensure it's fully visible, you might want to set its [member rect_min_size] to some non-zero value. + [b]Note:[/b] The tooltip is shrunk to minimal size. If you want to ensure it's fully visible, you might want to set its [member rect_min_size] to some non-zero value. Example of usage with custom-constructed node: [codeblock] func _make_custom_tooltip(for_text): @@ -229,7 +229,7 @@ [codeblock] func _ready(): modulate = get_color("font_color", "Button") #get the color defined for button fonts - [/codeblock] + [/codeblock] </description> </method> <method name="get_combined_minimum_size" qualifiers="const"> @@ -260,7 +260,7 @@ </description> </method> <method name="get_drag_data" qualifiers="virtual"> - <return type="Object"> + <return type="Variant"> </return> <argument index="0" name="position" type="Vector2"> </argument> @@ -388,7 +388,7 @@ <argument index="0" name="at_position" type="Vector2" default="Vector2( 0, 0 )"> </argument> <description> - Returns the tooltip, which will appear when the cursor is resting over this control. See [member]hint_tooltip[/member]. + Returns the tooltip, which will appear when the cursor is resting over this control. See [member hint_tooltip]. </description> </method> <method name="grab_click_focus"> diff --git a/doc/classes/Crypto.xml b/doc/classes/Crypto.xml new file mode 100644 index 0000000000..bb852f5fff --- /dev/null +++ b/doc/classes/Crypto.xml @@ -0,0 +1,43 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Crypto" inherits="Reference" category="Core" version="3.2"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <methods> + <method name="generate_random_bytes"> + <return type="PoolByteArray"> + </return> + <argument index="0" name="size" type="int"> + </argument> + <description> + </description> + </method> + <method name="generate_rsa"> + <return type="CryptoKey"> + </return> + <argument index="0" name="size" type="int"> + </argument> + <description> + </description> + </method> + <method name="generate_self_signed_certificate"> + <return type="X509Certificate"> + </return> + <argument index="0" name="key" type="CryptoKey"> + </argument> + <argument index="1" name="issuer_name" type="String" default=""CN=myserver,O=myorganisation,C=IT""> + </argument> + <argument index="2" name="not_before" type="String" default=""20140101000000""> + </argument> + <argument index="3" name="not_after" type="String" default=""20340101000000""> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/CryptoKey.xml b/doc/classes/CryptoKey.xml new file mode 100644 index 0000000000..d3cd485a5f --- /dev/null +++ b/doc/classes/CryptoKey.xml @@ -0,0 +1,29 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="CryptoKey" inherits="Resource" category="Core" version="3.2"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <methods> + <method name="load"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + </description> + </method> + <method name="save"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/Directory.xml b/doc/classes/Directory.xml index 9294a515d2..8aae85563a 100644 --- a/doc/classes/Directory.xml +++ b/doc/classes/Directory.xml @@ -127,8 +127,8 @@ </argument> <description> Initializes the stream used to list all files and directories using the [method get_next] function, closing the current opened stream if needed. Once the stream has been processed, it should typically be closed with [method list_dir_end]. - If you pass [code]skip_navigational[/code], then [code].[/code] and [code]..[/code] would be filtered out. - If you pass [code]skip_hidden[/code], then hidden files would be filtered out. + If [code]skip_navigational[/code] is [code]true[/code], [code].[/code] and [code]..[/code] are filtered out. + If [code]skip_hidden[/code] is [code]true[/code], hidden files are filtered out. </description> </method> <method name="list_dir_end"> diff --git a/doc/classes/EditorInterface.xml b/doc/classes/EditorInterface.xml index d55e810c9e..4f7a6d89a9 100644 --- a/doc/classes/EditorInterface.xml +++ b/doc/classes/EditorInterface.xml @@ -169,6 +169,22 @@ Selects the file, with the path provided by [code]file[/code], in the FileSystem dock. </description> </method> + <method name="set_distraction_free_mode"> + <return type="void"> + </return> + <argument index="0" name="enter" type="bool"> + </argument> + <description> + </description> + </method> + <method name="set_main_screen_editor"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> <method name="set_plugin_enabled"> <return type="void"> </return> diff --git a/doc/classes/Environment.xml b/doc/classes/Environment.xml index 86c1002666..9a943aba51 100644 --- a/doc/classes/Environment.xml +++ b/doc/classes/Environment.xml @@ -146,10 +146,11 @@ <member name="fog_depth_enabled" type="bool" setter="set_fog_depth_enabled" getter="is_fog_depth_enabled" default="true"> Enables the fog depth. </member> - <member name="fog_depth_end" type="float" setter="set_fog_depth_end" getter="get_fog_depth_end" default="0.0"> + <member name="fog_depth_end" type="float" setter="set_fog_depth_end" getter="get_fog_depth_end" default="100.0"> + Fog's depth end distance from the camera. If this value is set to 0, it will be equal to the current camera's [member Camera.far] value. </member> <member name="fog_enabled" type="bool" setter="set_fog_enabled" getter="is_fog_enabled" default="false"> - Enables the fog. Needs fog_height_enabled and/or for_depth_enabled to actually display fog. + Enables the fog. Needs [member fog_height_enabled] and/or [member fog_depth_enabled] to actually display fog. </member> <member name="fog_height_curve" type="float" setter="set_fog_height_curve" getter="get_fog_height_curve" default="1.0"> Value defining the fog height intensity. @@ -305,7 +306,7 @@ Replace glow blending mode. Replaces all pixels' color by the glow value. </constant> <constant name="TONE_MAPPER_LINEAR" value="0" enum="ToneMapper"> - Linear tonemapper operator. Reads the linear data and performs an exposure adjustment. + Linear tonemapper operator. Reads the linear data and passes it on unmodified. </constant> <constant name="TONE_MAPPER_REINHARDT" value="1" enum="ToneMapper"> Reinhardt tonemapper operator. Performs a variation on rendered pixels' colors by this formula: [code]color = color / (1 + color)[/code]. diff --git a/doc/classes/FileDialog.xml b/doc/classes/FileDialog.xml index e78f21b274..4f1e8cc309 100644 --- a/doc/classes/FileDialog.xml +++ b/doc/classes/FileDialog.xml @@ -134,6 +134,8 @@ </theme_item> <theme_item name="folder" type="Texture"> </theme_item> + <theme_item name="folder_icon_modulate" type="Color" default="Color( 1, 1, 1, 1 )"> + </theme_item> <theme_item name="parent_folder" type="Texture"> </theme_item> <theme_item name="reload" type="Texture"> diff --git a/doc/classes/Geometry.xml b/doc/classes/Geometry.xml index 3cbbe6da56..3824baa4dc 100644 --- a/doc/classes/Geometry.xml +++ b/doc/classes/Geometry.xml @@ -216,6 +216,19 @@ Intersects [code]polyline[/code] with [code]polygon[/code] and returns an array of intersected polylines. This performs [constant OPERATION_INTERSECTION] between the polyline and the polygon. This operation can be thought of as chopping a line with a closed shape. </description> </method> + <method name="is_point_in_circle"> + <return type="bool"> + </return> + <argument index="0" name="point" type="Vector2"> + </argument> + <argument index="1" name="circle_position" type="Vector2"> + </argument> + <argument index="2" name="circle_radius" type="float"> + </argument> + <description> + Returns [code]true[/code] if [code]point[/code] is inside the circle or if it's located exactly [i]on[/i] the circle's boundary, otherwise returns [code]false[/code]. + </description> + </method> <method name="is_point_in_polygon"> <return type="bool"> </return> @@ -428,18 +441,6 @@ Tests if the segment ([code]from[/code], [code]to[/code]) intersects the triangle [code]a[/code], [code]b[/code], [code]c[/code]. If yes, returns the point of intersection as [Vector3]. If no intersection takes place, an empty [Variant] is returned. </description> </method> - <method name="transform_points_2d"> - <return type="PoolVector2Array"> - </return> - <argument index="0" name="points" type="PoolVector2Array"> - </argument> - <argument index="1" name="transform" type="Transform2D"> - </argument> - <description> - Transforms an array of points by [code]transform[/code] and returns the result. - Can be useful in conjunction with performing polygon boolean operations in a CSG-like manner, see [method merge_polygons_2d], [method clip_polygons_2d], [method intersect_polygons_2d], [method exclude_polygons_2d]. - </description> - </method> <method name="triangulate_delaunay_2d"> <return type="PoolIntArray"> </return> diff --git a/doc/classes/GeometryInstance.xml b/doc/classes/GeometryInstance.xml index b108e1be7c..02f2c27043 100644 --- a/doc/classes/GeometryInstance.xml +++ b/doc/classes/GeometryInstance.xml @@ -46,22 +46,26 @@ </member> <member name="lod_max_distance" type="float" setter="set_lod_max_distance" getter="get_lod_max_distance" default="0.0"> The GeometryInstance's max LOD distance. + [b]Note:[/b] This property currently has no effect. </member> <member name="lod_max_hysteresis" type="float" setter="set_lod_max_hysteresis" getter="get_lod_max_hysteresis" default="0.0"> The GeometryInstance's max LOD margin. + [b]Note:[/b] This property currently has no effect. </member> <member name="lod_min_distance" type="float" setter="set_lod_min_distance" getter="get_lod_min_distance" default="0.0"> The GeometryInstance's min LOD distance. + [b]Note:[/b] This property currently has no effect. </member> <member name="lod_min_hysteresis" type="float" setter="set_lod_min_hysteresis" getter="get_lod_min_hysteresis" default="0.0"> The GeometryInstance's min LOD margin. + [b]Note:[/b] This property currently has no effect. </member> <member name="material_override" type="Material" setter="set_material_override" getter="get_material_override"> The material override for the whole geometry. - If there is a material in [code]material_override[/code], it will be used instead of any material set in any material slot of the mesh. + If a material is assigned to this property, it will be used instead of any material set in any material slot of the mesh. </member> <member name="use_in_baked_light" type="bool" setter="set_flag" getter="get_flag" default="false"> - If [code]true[/code], this GeometryInstance will be used when baking lights using a [GIProbe] and/or any other form of baked lighting. + If [code]true[/code], this GeometryInstance will be used when baking lights using a [GIProbe] or [BakedLightmap]. </member> </members> <constants> @@ -78,10 +82,10 @@ </constant> <constant name="SHADOW_CASTING_SETTING_SHADOWS_ONLY" value="3" enum="ShadowCastingSetting"> Will only show the shadows casted from this object. - In other words: The actual mesh will not be visible, only the shadows casted from the mesh. + In other words, the actual mesh will not be visible, only the shadows casted from the mesh will be. </constant> <constant name="FLAG_USE_BAKED_LIGHT" value="0" enum="Flags"> - Will allow the GeometryInstance to be used when baking lights using a [GIProbe] and/or any other form of baked lighting. + Will allow the GeometryInstance to be used when baking lights using a [GIProbe] or [BakedLightmap]. </constant> <constant name="FLAG_DRAW_NEXT_FRAME_IF_VISIBLE" value="1" enum="Flags"> Unused in this class, exposed for consistency with [enum VisualServer.InstanceFlags]. diff --git a/doc/classes/GraphNode.xml b/doc/classes/GraphNode.xml index 6bc09e5289..8470a346ff 100644 --- a/doc/classes/GraphNode.xml +++ b/doc/classes/GraphNode.xml @@ -174,6 +174,7 @@ </methods> <members> <member name="comment" type="bool" setter="set_comment" getter="is_comment" default="false"> + If [code]true[/code], the GraphNode is a comment node. </member> <member name="offset" type="Vector2" setter="set_offset" getter="get_offset" default="Vector2( 0, 0 )"> The offset of the GraphNode, relative to the scroll offset of the [GraphEdit]. @@ -257,6 +258,8 @@ </theme_item> <theme_item name="resizer" type="Texture"> </theme_item> + <theme_item name="resizer_color" type="Color" default="Color( 0, 0, 0, 1 )"> + </theme_item> <theme_item name="selectedframe" type="StyleBox"> </theme_item> <theme_item name="separation" type="int" default="1"> diff --git a/doc/classes/HashingContext.xml b/doc/classes/HashingContext.xml new file mode 100644 index 0000000000..552a74eba4 --- /dev/null +++ b/doc/classes/HashingContext.xml @@ -0,0 +1,41 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="HashingContext" inherits="Reference" category="Core" version="3.2"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <methods> + <method name="finish"> + <return type="PoolByteArray"> + </return> + <description> + </description> + </method> + <method name="start"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="type" type="int" enum="HashingContext.HashType"> + </argument> + <description> + </description> + </method> + <method name="update"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="chunk" type="PoolByteArray"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + <constant name="HASH_MD5" value="0" enum="HashType"> + </constant> + <constant name="HASH_SHA1" value="1" enum="HashType"> + </constant> + <constant name="HASH_SHA256" value="2" enum="HashType"> + </constant> + </constants> +</class> diff --git a/doc/classes/Image.xml b/doc/classes/Image.xml index a4df0d5c19..10be66feb8 100644 --- a/doc/classes/Image.xml +++ b/doc/classes/Image.xml @@ -406,24 +406,24 @@ <description> </description> </method> - <method name="save_png" qualifiers="const"> + <method name="save_exr" qualifiers="const"> <return type="int" enum="Error"> </return> <argument index="0" name="path" type="String"> </argument> + <argument index="1" name="grayscale" type="bool" default="false"> + </argument> <description> - Saves the image as a PNG file to [code]path[/code]. + Saves the image as an EXR file to [code]path[/code]. If grayscale is true and the image has only one channel, it will be saved explicitely as monochrome rather than one red channel. This function will return [constant ERR_UNAVAILABLE] if Godot was compiled without the TinyEXR module. </description> </method> - <method name="save_exr" qualifiers="const"> + <method name="save_png" qualifiers="const"> <return type="int" enum="Error"> </return> <argument index="0" name="path" type="String"> </argument> - <argument index="1" name="grayscale" type="bool" default="false"> - </argument> <description> - Saves the image as an EXR file to [code]path[/code]. If grayscale is true and the image has only one channel, it will be saved explicitely as monochrome rather than one red channel. This function will return [constant ERR_UNAVAILABLE] if Godot was compiled without the TinyEXR module. + Saves the image as a PNG file to [code]path[/code]. </description> </method> <method name="set_pixel"> diff --git a/doc/classes/Input.xml b/doc/classes/Input.xml index 91ebcd52f6..5fd5e8c3c0 100644 --- a/doc/classes/Input.xml +++ b/doc/classes/Input.xml @@ -20,6 +20,7 @@ <description> This will simulate pressing the specified action. The strength can be used for non-boolean actions, it's ranged between 0 and 1 representing the intensity of the given action. + [b]Note:[/b] This method will not cause any [method Node._input] calls. It is intended to be used with [method is_action_pressed] and [method is_action_just_pressed]. If you want to simulate [code]_input[/code], use [method parse_input_event] instead. </description> </method> <method name="action_release"> @@ -283,7 +284,14 @@ <argument index="0" name="event" type="InputEvent"> </argument> <description> - Feeds an [InputEvent] to the game. Can be used to artificially trigger input events from code. + Feeds an [InputEvent] to the game. Can be used to artificially trigger input events from code. Also generates [method Node._input] calls. + Example: + [codeblock] + var a = InputEventAction.new() + a.action = "ui_cancel" + a.pressed = true + Input.parse_input_event(a) + [/codeblock] </description> </method> <method name="remove_joy_mapping"> @@ -364,6 +372,16 @@ Stops the vibration of the joypad. </description> </method> + <method name="vibrate_handheld"> + <return type="void"> + </return> + <argument index="0" name="duration_ms" type="int" default="500"> + </argument> + <description> + Vibrate Android and iOS devices. + [b]Note:[/b] It needs VIBRATE permission for Android at export settings. iOS does not support duration. + </description> + </method> <method name="warp_mouse_position"> <return type="void"> </return> diff --git a/doc/classes/JSONRPC.xml b/doc/classes/JSONRPC.xml new file mode 100644 index 0000000000..921161afb4 --- /dev/null +++ b/doc/classes/JSONRPC.xml @@ -0,0 +1,95 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="JSONRPC" inherits="Object" category="Core" version="3.2"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <methods> + <method name="make_notification"> + <return type="Dictionary"> + </return> + <argument index="0" name="method" type="String"> + </argument> + <argument index="1" name="params" type="Variant"> + </argument> + <description> + </description> + </method> + <method name="make_request"> + <return type="Dictionary"> + </return> + <argument index="0" name="method" type="String"> + </argument> + <argument index="1" name="params" type="Variant"> + </argument> + <argument index="2" name="id" type="Variant"> + </argument> + <description> + </description> + </method> + <method name="make_response"> + <return type="Dictionary"> + </return> + <argument index="0" name="result" type="Variant"> + </argument> + <argument index="1" name="id" type="Variant"> + </argument> + <description> + </description> + </method> + <method name="make_response_error" qualifiers="const"> + <return type="Dictionary"> + </return> + <argument index="0" name="code" type="int"> + </argument> + <argument index="1" name="message" type="String"> + </argument> + <argument index="2" name="id" type="Variant" default="null"> + </argument> + <description> + </description> + </method> + <method name="process_action"> + <return type="Variant"> + </return> + <argument index="0" name="action" type="Variant"> + </argument> + <argument index="1" name="recurse" type="bool" default="false"> + </argument> + <description> + </description> + </method> + <method name="process_string"> + <return type="String"> + </return> + <argument index="0" name="action" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_scope"> + <return type="void"> + </return> + <argument index="0" name="scope" type="String"> + </argument> + <argument index="1" name="target" type="Object"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + <constant name="ParseError" value="-32700" enum="ErrorCode"> + </constant> + <constant name="InvalidRequest" value="-32600" enum="ErrorCode"> + </constant> + <constant name="MethodNotFound" value="-32601" enum="ErrorCode"> + </constant> + <constant name="InvalidParams" value="-32602" enum="ErrorCode"> + </constant> + <constant name="InternalError" value="-32603" enum="ErrorCode"> + </constant> + </constants> +</class> diff --git a/doc/classes/MainLoop.xml b/doc/classes/MainLoop.xml index f5bf12a876..181a99590a 100644 --- a/doc/classes/MainLoop.xml +++ b/doc/classes/MainLoop.xml @@ -4,7 +4,7 @@ Abstract base class for the game's main loop. </brief_description> <description> - [MainLoop] is the abstract base class for a Godot project's game loop. It in inherited by [SceneTree], which is the default game loop implementation used in Godot projects, though it is also possible to write and use one's own [MainLoop] subclass instead of the scene tree. + [MainLoop] is the abstract base class for a Godot project's game loop. It is inherited by [SceneTree], which is the default game loop implementation used in Godot projects, though it is also possible to write and use one's own [MainLoop] subclass instead of the scene tree. Upon the application start, a [MainLoop] implementation must be provided to the OS; otherwise, the application will exit. This happens automatically (and a [SceneTree] is created) unless a main [Script] is provided from the command line (with e.g. [code]godot -s my_loop.gd[/code], which should then be a [MainLoop] implementation. Here is an example script implementing a simple [MainLoop]: [codeblock] @@ -61,6 +61,16 @@ Called before the program exits. </description> </method> + <method name="_global_menu_action" qualifiers="virtual"> + <return type="void"> + </return> + <argument index="0" name="id" type="Variant"> + </argument> + <argument index="1" name="meta" type="Variant"> + </argument> + <description> + </description> + </method> <method name="_idle" qualifiers="virtual"> <return type="bool"> </return> diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml index 889ce4d3eb..097fa1f6e5 100644 --- a/doc/classes/Node.xml +++ b/doc/classes/Node.xml @@ -122,6 +122,12 @@ <description> Adds a child node. Nodes can have any number of children, but every child must have a unique name. Child nodes are automatically deleted when the parent node is deleted, so an entire scene can be removed by deleting its topmost node. If [code]legible_unique_name[/code] is [code]true[/code], the child node will have an human-readable name based on the name of the node being instanced instead of its type. + [b]Note:[/b] If the child node already has a parent, the function will fail. Use [method remove_child] first to remove the node from its current parent. For example: + [codeblock] + if child_node.get_parent(): + child_node.get_parent().remove_child(child_node) + add_child(child_node) + [/codeblock] </description> </method> <method name="add_child_below_node"> diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index c770e78c7c..938777a36b 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -497,6 +497,50 @@ Returns unobscured area of the window where interactive controls should be rendered. </description> </method> + <method name="global_menu_add_item"> + <return type="void"> + </return> + <argument index="0" name="menu" type="String"> + </argument> + <argument index="1" name="label" type="String"> + </argument> + <argument index="2" name="id" type="Variant"> + </argument> + <argument index="3" name="meta" type="Variant"> + </argument> + <description> + Add a new item with text "label" to global menu. Use "_dock" menu to add item to the macOS dock icon menu. + </description> + </method> + <method name="global_menu_add_separator"> + <return type="void"> + </return> + <argument index="0" name="menu" type="String"> + </argument> + <description> + Add a separator between items. Separators also occupy an index. + </description> + </method> + <method name="global_menu_clear"> + <return type="void"> + </return> + <argument index="0" name="menu" type="String"> + </argument> + <description> + Clear the global menu, in effect removing all items. + </description> + </method> + <method name="global_menu_remove_item"> + <return type="void"> + </return> + <argument index="0" name="menu" type="String"> + </argument> + <argument index="1" name="idx" type="int"> + </argument> + <description> + Removes the item at index "idx" from the global menu. Note that the indexes of items after the removed item are going to be shifted by one. + </description> + </method> <method name="has_environment" qualifiers="const"> <return type="bool"> </return> diff --git a/doc/classes/PoolByteArray.xml b/doc/classes/PoolByteArray.xml index 08848e789b..21bf078017 100644 --- a/doc/classes/PoolByteArray.xml +++ b/doc/classes/PoolByteArray.xml @@ -67,6 +67,12 @@ Returns a copy of the array's contents as [String]. Slower than [method get_string_from_ascii] but supports UTF-8 encoded data. Use this function if you are unsure about the source of the data. For user input this function should always be preferred. </description> </method> + <method name="hex_encode"> + <return type="String"> + </return> + <description> + </description> + </method> <method name="insert"> <return type="int"> </return> @@ -113,13 +119,6 @@ Changes the byte at the given index. </description> </method> - <method name="sha256_string"> - <return type="String"> - </return> - <description> - Returns SHA-256 string of the PoolByteArray. - </description> - </method> <method name="size"> <return type="int"> </return> diff --git a/doc/classes/Popup.xml b/doc/classes/Popup.xml index 1e24aadfd9..fb8168c344 100644 --- a/doc/classes/Popup.xml +++ b/doc/classes/Popup.xml @@ -56,6 +56,13 @@ Popup (show the control in modal form) in the center of the screen relative to the current canvas transform, scaled at a ratio of size of the screen. </description> </method> + <method name="set_as_minsize"> + <return type="void"> + </return> + <description> + Shrink popup to keep to the minimum size of content. + </description> + </method> </methods> <members> <member name="popup_exclusive" type="bool" setter="set_exclusive" getter="is_exclusive" default="false"> diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index 9f18eea0d4..86b874d8ee 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -180,6 +180,9 @@ This user directory is used for storing persistent data ([code]user://[/code] filesystem). If left empty, [code]user://[/code] resolves to a project-specific folder in Godot's own configuration folder (see [method OS.get_user_data_dir]). If a custom directory name is defined, this name will be used instead and appended to the system-specific user data directory (same parent folder as the Godot configuration folder documented in [method OS.get_user_data_dir]). The [member application/config/use_custom_user_dir] setting must be enabled for this to take effect. </member> + <member name="application/config/description" type="String" setter="" getter="" default=""""> + The project's description, displayed as a tooltip in the Project Manager when hovering the project. + </member> <member name="application/config/icon" type="String" setter="" getter="" default=""""> Icon used for the project, set when project loads. Exporters will also use this icon when possible. </member> @@ -412,6 +415,8 @@ <member name="editor/active" type="bool" setter="" getter="" default="false"> Internal editor setting, don't touch. </member> + <member name="editor/script_templates_search_path" type="String" setter="" getter="" default=""res://script_templates""> + </member> <member name="editor/search_in_file_extensions" type="PoolStringArray" setter="" getter="" default="PoolStringArray( "gd", "shader" )"> </member> <member name="gui/common/default_scroll_deadzone" type="int" setter="" getter="" default="0"> @@ -664,6 +669,8 @@ </member> <member name="network/limits/tcp/connect_timeout_seconds" type="int" setter="" getter="" default="30"> </member> + <member name="network/limits/webrtc/max_channel_in_buffer_kb" type="int" setter="" getter="" default="64"> + </member> <member name="network/limits/websocket_client/max_in_buffer_kb" type="int" setter="" getter="" default="64"> </member> <member name="network/limits/websocket_client/max_in_packets" type="int" setter="" getter="" default="1024"> @@ -686,6 +693,8 @@ <member name="network/remote_fs/page_size" type="int" setter="" getter="" default="65536"> Page size used by remote filesystem (in bytes). </member> + <member name="network/ssl/certificates" type="String" setter="" getter="" default=""""> + </member> <member name="node/name_casing" type="int" setter="" getter="" default="0"> When creating node names automatically, set the type of casing in this project. This is mostly an editor setting. </member> diff --git a/doc/classes/ResourceFormatLoaderCrypto.xml b/doc/classes/ResourceFormatLoaderCrypto.xml new file mode 100644 index 0000000000..8bc7d50c75 --- /dev/null +++ b/doc/classes/ResourceFormatLoaderCrypto.xml @@ -0,0 +1,13 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ResourceFormatLoaderCrypto" inherits="ResourceFormatLoader" category="Core" version="3.2"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/ResourceFormatSaverCrypto.xml b/doc/classes/ResourceFormatSaverCrypto.xml new file mode 100644 index 0000000000..2f7d224dab --- /dev/null +++ b/doc/classes/ResourceFormatSaverCrypto.xml @@ -0,0 +1,13 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ResourceFormatSaverCrypto" inherits="ResourceFormatSaver" category="Core" version="3.2"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/RigidBody2D.xml b/doc/classes/RigidBody2D.xml index f280dc81c2..32a1634f77 100644 --- a/doc/classes/RigidBody2D.xml +++ b/doc/classes/RigidBody2D.xml @@ -154,7 +154,7 @@ Multiplies the gravity applied to the body. The body's gravity is calculated from the [b]Default Gravity[/b] value in [b]Project > Project Settings > Physics > 2d[/b] and/or any additional gravity vector applied by [Area2D]s. </member> <member name="inertia" type="float" setter="set_inertia" getter="get_inertia"> - The body's moment of inertia. This is like mass, but for rotation: it determines how much torque it takes to rotate the body. The moment of inertia is usually computed automatically from the mass and the shapes, but this function allows you to set a custom value. Set 0 (or negative) inertia to return to automatically computing it. + The body's moment of inertia. This is like mass, but for rotation: it determines how much torque it takes to rotate the body. The moment of inertia is usually computed automatically from the mass and the shapes, but this function allows you to set a custom value. Set 0 inertia to return to automatically computing it. </member> <member name="linear_damp" type="float" setter="set_linear_damp" getter="get_linear_damp" default="-1.0"> Damps the body's [member linear_velocity]. If [code]-1[/code], the body will use the [b]Default Linear Damp[/b] in [b]Project > Project Settings > Physics > 2d[/b]. diff --git a/doc/classes/SceneTree.xml b/doc/classes/SceneTree.xml index 1302c1e6bf..ed43f83f05 100644 --- a/doc/classes/SceneTree.xml +++ b/doc/classes/SceneTree.xml @@ -324,6 +324,15 @@ Emitted when files are dragged from the OS file manager and dropped in the game window. The arguments are a list of file paths and the identifier of the screen where the drag originated. </description> </signal> + <signal name="global_menu_action"> + <argument index="0" name="id" type="Nil"> + </argument> + <argument index="1" name="meta" type="Nil"> + </argument> + <description> + Emitted whenever global menu item is clicked. + </description> + </signal> <signal name="idle_frame"> <description> Emitted immediately before [method Node._process] is called on every node in the [SceneTree]. diff --git a/doc/classes/SpriteBase3D.xml b/doc/classes/SpriteBase3D.xml index 5529da909d..15d5d7beb4 100644 --- a/doc/classes/SpriteBase3D.xml +++ b/doc/classes/SpriteBase3D.xml @@ -46,6 +46,8 @@ <member name="axis" type="int" setter="set_axis" getter="get_axis" enum="Vector3.Axis" default="2"> The direction in which the front of the texture faces. </member> + <member name="billboard" type="int" setter="set_billboard_mode" getter="get_billboard_mode" enum="SpatialMaterial.BillboardMode" default="0"> + </member> <member name="centered" type="bool" setter="set_centered" getter="is_centered" default="true"> If [code]true[/code], texture will be centered. </member> diff --git a/doc/classes/StreamPeerSSL.xml b/doc/classes/StreamPeerSSL.xml index 9b5f4e7580..c960a794e2 100644 --- a/doc/classes/StreamPeerSSL.xml +++ b/doc/classes/StreamPeerSSL.xml @@ -13,7 +13,13 @@ <method name="accept_stream"> <return type="int" enum="Error"> </return> - <argument index="0" name="base" type="StreamPeer"> + <argument index="0" name="stream" type="StreamPeer"> + </argument> + <argument index="1" name="private_key" type="CryptoKey"> + </argument> + <argument index="2" name="certificate" type="X509Certificate"> + </argument> + <argument index="3" name="chain" type="X509Certificate" default="null"> </argument> <description> </description> @@ -27,6 +33,8 @@ </argument> <argument index="2" name="for_hostname" type="String" default=""""> </argument> + <argument index="3" name="valid_certificate" type="X509Certificate" default="null"> + </argument> <description> Connects to a peer using an underlying [StreamPeer] [code]stream[/code]. If [code]validate_certs[/code] is [code]true[/code], [StreamPeerSSL] will validate that the certificate presented by the peer matches the [code]for_hostname[/code]. </description> diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index 22c769330d..fb5f20361b 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -418,6 +418,10 @@ <member name="highlight_current_line" type="bool" setter="set_highlight_current_line" getter="is_highlight_current_line_enabled" default="false"> If [code]true[/code], the line containing the cursor is highlighted. </member> + <member name="minimap_draw" type="bool" setter="draw_minimap" getter="is_drawing_minimap" default="false"> + </member> + <member name="minimap_width" type="int" setter="set_minimap_width" getter="get_minimap_width" default="80"> + </member> <member name="override_selected_font_color" type="bool" setter="set_override_selected_font_color" getter="is_overriding_selected_font_color" default="false"> </member> <member name="readonly" type="bool" setter="set_readonly" getter="is_readonly" default="false"> diff --git a/doc/classes/Transform.xml b/doc/classes/Transform.xml index 9916d25af5..6ebc389ed7 100644 --- a/doc/classes/Transform.xml +++ b/doc/classes/Transform.xml @@ -144,7 +144,7 @@ <argument index="0" name="v" type="Variant"> </argument> <description> - Transforms the given [Vector3], [Plane], or [AABB] by this transform. + Transforms the given [Vector3], [Plane], [AABB], or [PoolVector3Array] by this transform. </description> </method> <method name="xform_inv"> @@ -153,7 +153,7 @@ <argument index="0" name="v" type="Variant"> </argument> <description> - Inverse-transforms the given [Vector3], [Plane], or [AABB] by this transform. + Inverse-transforms the given [Vector3], [Plane], [AABB], or [PoolVector3Array] by this transform. </description> </method> </methods> diff --git a/doc/classes/Transform2D.xml b/doc/classes/Transform2D.xml index f6fce1aaa1..580da080b3 100644 --- a/doc/classes/Transform2D.xml +++ b/doc/classes/Transform2D.xml @@ -146,7 +146,7 @@ <argument index="0" name="v" type="Variant"> </argument> <description> - Transforms the given [Vector2] or [Rect2] by this transform. + Transforms the given [Vector2], [Rect2], or [PoolVector2Array] by this transform. </description> </method> <method name="xform_inv"> @@ -155,7 +155,7 @@ <argument index="0" name="v" type="Variant"> </argument> <description> - Inverse-transforms the given [Vector2] or [Rect2] by this transform. + Inverse-transforms the given [Vector2], [Rect2], or [PoolVector2Array] by this transform. </description> </method> </methods> diff --git a/doc/classes/Tree.xml b/doc/classes/Tree.xml index 62a7147e08..51d56c758e 100644 --- a/doc/classes/Tree.xml +++ b/doc/classes/Tree.xml @@ -16,7 +16,7 @@ var subchild1 = tree.create_item(child1) subchild1.set_text(0, "Subchild1") [/codeblock] - To iterate over all the [TreeItem] objects in a [Tree] object, use [method TreeItem.get_next] and [method TreeItem.get_children] after getting the root through [get_root]. + To iterate over all the [TreeItem] objects in a [Tree] object, use [method TreeItem.get_next] and [method TreeItem.get_children] after getting the root through [method get_root]. </description> <tutorials> </tutorials> diff --git a/doc/classes/TreeItem.xml b/doc/classes/TreeItem.xml index 56b4b21525..04deae6bf5 100644 --- a/doc/classes/TreeItem.xml +++ b/doc/classes/TreeItem.xml @@ -136,6 +136,15 @@ Returns the column's icon's maximum width. </description> </method> + <method name="get_icon_modulate" qualifiers="const"> + <return type="Color"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <description> + Returns the [Color] modulating the column's icon. + </description> + </method> <method name="get_icon_region" qualifiers="const"> <return type="Rect2"> </return> @@ -464,6 +473,17 @@ Sets the given column's icon's maximum width. </description> </method> + <method name="set_icon_modulate"> + <return type="void"> + </return> + <argument index="0" name="column" type="int"> + </argument> + <argument index="1" name="modulate" type="Color"> + </argument> + <description> + Modulates the given column's icon with [code]modulate[/code]. + </description> + </method> <method name="set_icon_region"> <return type="void"> </return> diff --git a/doc/classes/Vector2.xml b/doc/classes/Vector2.xml index 237b596fad..987ed9867b 100644 --- a/doc/classes/Vector2.xml +++ b/doc/classes/Vector2.xml @@ -203,6 +203,24 @@ Returns the vector scaled to unit length. Equivalent to [code]v / v.length()[/code]. </description> </method> + <method name="posmod"> + <return type="Vector2"> + </return> + <argument index="0" name="mod" type="float"> + </argument> + <description> + Returns a vector composed of the [code]fposmod[/code] of this vector's components and [code]mod[/code]. + </description> + </method> + <method name="posmodv"> + <return type="Vector2"> + </return> + <argument index="0" name="modv" type="Vector2"> + </argument> + <description> + Returns a vector composed of the [code]fposmod[/code] of this vector's components and [code]modv[/code]'s components. + </description> + </method> <method name="project"> <return type="Vector2"> </return> @@ -237,6 +255,13 @@ Returns the vector with all components rounded to the nearest integer, with halfway cases rounded away from zero. </description> </method> + <method name="sign"> + <return type="Vector2"> + </return> + <description> + Returns the vector with each component set to one or negative one, depending on the signs of the components. + </description> + </method> <method name="slerp"> <return type="Vector2"> </return> @@ -284,6 +309,12 @@ </member> </members> <constants> + <constant name="AXIS_X" value="0"> + Enumerated value for the X axis. + </constant> + <constant name="AXIS_Y" value="1"> + Enumerated value for the Y axis. + </constant> <constant name="ZERO" value="Vector2( 0, 0 )"> Zero vector. </constant> @@ -291,7 +322,7 @@ One vector. </constant> <constant name="INF" value="Vector2( inf, inf )"> - Infinite vector. + Infinity vector. </constant> <constant name="LEFT" value="Vector2( -1, 0 )"> Left unit vector. diff --git a/doc/classes/Vector3.xml b/doc/classes/Vector3.xml index 3e1083ab69..05ce6c43ae 100644 --- a/doc/classes/Vector3.xml +++ b/doc/classes/Vector3.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="Vector3" category="Built-In Types" version="3.2"> <brief_description> - Vector class, which performs basic 3D vector math operations. + Vector used for 3D math. </brief_description> <description> - Vector3 is one of the core classes of the engine, and includes several built-in helper functions to perform basic vector math operations. + 3-element structure that can be used to represent positions in 3D space or any other pair of numeric values. </description> <tutorials> <link>https://docs.godotengine.org/en/latest/tutorials/math/index.html</link> @@ -202,6 +202,24 @@ Returns the outer product with [code]b[/code]. </description> </method> + <method name="posmod"> + <return type="Vector3"> + </return> + <argument index="0" name="mod" type="float"> + </argument> + <description> + Returns a vector composed of the [code]fposmod[/code] of this vector's components and [code]mod[/code]. + </description> + </method> + <method name="posmodv"> + <return type="Vector3"> + </return> + <argument index="0" name="modv" type="Vector3"> + </argument> + <description> + Returns a vector composed of the [code]fposmod[/code] of this vector's components and [code]modv[/code]'s components. + </description> + </method> <method name="project"> <return type="Vector3"> </return> @@ -238,6 +256,13 @@ Returns the vector with all components rounded to the nearest integer, with halfway cases rounded away from zero. </description> </method> + <method name="sign"> + <return type="Vector3"> + </return> + <description> + Returns the vector with each component set to one or negative one, depending on the signs of the components. + </description> + </method> <method name="slerp"> <return type="Vector3"> </return> @@ -292,10 +317,10 @@ Enumerated value for the X axis. Returned by [method max_axis] and [method min_axis]. </constant> <constant name="AXIS_Y" value="1"> - Enumerated value for the Y axis. + Enumerated value for the Y axis. Returned by [method max_axis] and [method min_axis]. </constant> <constant name="AXIS_Z" value="2"> - Enumerated value for the Z axis. + Enumerated value for the Z axis. Returned by [method max_axis] and [method min_axis]. </constant> <constant name="ZERO" value="Vector3( 0, 0, 0 )"> Zero vector. @@ -304,7 +329,7 @@ One vector. </constant> <constant name="INF" value="Vector3( inf, inf, inf )"> - Infinite vector. + Infinity vector. </constant> <constant name="LEFT" value="Vector3( -1, 0, 0 )"> Left unit vector. diff --git a/doc/classes/VisualShaderNode.xml b/doc/classes/VisualShaderNode.xml index 19495a8859..3e80349b13 100644 --- a/doc/classes/VisualShaderNode.xml +++ b/doc/classes/VisualShaderNode.xml @@ -39,5 +39,20 @@ </signal> </signals> <constants> + <constant name="PORT_TYPE_SCALAR" value="0" enum="PortType"> + Floating-point scalar. Translated to [code]float[/code] type in shader code. + </constant> + <constant name="PORT_TYPE_VECTOR" value="1" enum="PortType"> + 3D vector of floating-point values. Translated to [code]vec3[/code] type in shader code. + </constant> + <constant name="PORT_TYPE_BOOLEAN" value="2" enum="PortType"> + Boolean type. Translated to [code]bool[/code] type in shader code. + </constant> + <constant name="PORT_TYPE_TRANSFORM" value="3" enum="PortType"> + Transform type. Translated to [code]mat4[/code] type in shader code. + </constant> + <constant name="PORT_TYPE_ICON_COLOR" value="4" enum="PortType"> + Color type. Can be used for return icon type in members dialog (see [method VisualShaderNodeCustom._get_return_icon_type]) - do not use it in other cases! + </constant> </constants> </class> diff --git a/doc/classes/VisualShaderNodeCustom.xml b/doc/classes/VisualShaderNodeCustom.xml new file mode 100644 index 0000000000..9e58abae97 --- /dev/null +++ b/doc/classes/VisualShaderNodeCustom.xml @@ -0,0 +1,149 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeCustom" inherits="VisualShaderNode" category="Core" version="3.2"> + <brief_description> + Virtual class to define custom [VisualShaderNode]s for use in the Visual Shader Editor. + </brief_description> + <description> + By inheriting this class you can create a custom [VisualShader] script addon which will be automatically added to the Visual Shader Editor. The [VisualShaderNode]'s behavior is defined by overriding the provided virtual methods. + In order for the node to be registered as an editor addon, you must use the [code]tool[/code] keyword and provide a [code]class_name[/code] for your custom script. For example: + [codeblock] + tool + extends VisualShaderNodeCustom + class_name VisualShaderNodeNoise + [/codeblock] + </description> + <tutorials> + <link>http://docs.godotengine.org/en/latest/tutorials/plugins/editor/visual_shader_plugins.html</link> + </tutorials> + <methods> + <method name="_get_category" qualifiers="virtual"> + <return type="String"> + </return> + <description> + Override this method to define the category of the associated custom node in the Visual Shader Editor's members dialog. + Defining this method is [b]optional[/b]. If not overridden, the node will be filed under the "Custom" category. + </description> + </method> + <method name="_get_code" qualifiers="virtual"> + <return type="String"> + </return> + <argument index="0" name="input_vars" type="Array"> + </argument> + <argument index="1" name="output_vars" type="Array"> + </argument> + <argument index="2" name="mode" type="int"> + </argument> + <argument index="3" name="type" type="int"> + </argument> + <description> + Override this method to define the actual shader code of the associated custom node. The shader code should be returned as a string, which can have multiple lines (the [code]"""[/code] multiline string construct can be used for convenience). + The [code]input_vars[/code] and [code]output_vars[/code] arrays contain the string names of the various input and output variables, as defined by [code]_get_input_*[/code] and [code]_get_output_*[/code] virtual methods in this class. + The output ports can be assigned values in the shader code. For example, [code]return output_vars[0] + " = " + input_vars[0] + ";"[/code]. + You can customize the generated code based on the shader [code]mode[/code] (see [enum Shader.Mode]) and/or [code]type[/code] (see [enum VisualShader.Type]). + Defining this method is [b]required[/b]. + </description> + </method> + <method name="_get_description" qualifiers="virtual"> + <return type="String"> + </return> + <description> + Override this method to define the description of the associated custom node in the Visual Shader Editor's members dialog. + Defining this method is [b]optional[/b]. + </description> + </method> + <method name="_get_global_code" qualifiers="virtual"> + <return type="String"> + </return> + <argument index="0" name="mode" type="int"> + </argument> + <description> + Override this method to add shader code on top of the global shader, to define your own standard library of reusable methods, varyings, constants, uniforms, etc. The shader code should be returned as a string, which can have multiple lines (the [code]"""[/code] multiline string construct can be used for convenience). + Be careful with this functionality as it can cause name conflicts with other custom nodes, so be sure to give the defined entities unique names. + You can customize the generated code based on the shader [code]mode[/code] (see [enum Shader.Mode]). + Defining this method is [b]optional[/b]. + </description> + </method> + <method name="_get_input_port_count" qualifiers="virtual"> + <return type="int"> + </return> + <description> + Override this method to define the amount of input ports of the associated custom node. + Defining this method is [b]required[/b]. If not overridden, the node has no input ports. + </description> + </method> + <method name="_get_input_port_name" qualifiers="virtual"> + <return type="String"> + </return> + <argument index="0" name="port" type="int"> + </argument> + <description> + Override this method to define the names of input ports of the associated custom node. The names are used both for the input slots in the editor and as identifiers in the shader code, and are passed in the [code]input_vars[/code] array in [method _get_code]. + Defining this method is [b]optional[/b], but recommended. If not overridden, input ports are named as [code]"in" + str(port)[/code]. + </description> + </method> + <method name="_get_input_port_type" qualifiers="virtual"> + <return type="int"> + </return> + <argument index="0" name="port" type="int"> + </argument> + <description> + Override this method to define the returned type of each input port of the associated custom node (see [enum VisualShaderNode.PortType] for possible types). + Defining this method is [b]optional[/b], but recommended. If not overridden, input ports will return the [constant VisualShaderNode.PORT_TYPE_SCALAR] type. + </description> + </method> + <method name="_get_name" qualifiers="virtual"> + <return type="String"> + </return> + <description> + Override this method to define the name of the associated custom node in the Visual Shader Editor's members dialog and graph. + Defining this method is [b]optional[/b], but recommended. If not overridden, the node will be named as "Unnamed". + </description> + </method> + <method name="_get_output_port_count" qualifiers="virtual"> + <return type="int"> + </return> + <description> + Override this method to define the amount of output ports of the associated custom node. + Defining this method is [b]required[/b]. If not overridden, the node has no output ports. + </description> + </method> + <method name="_get_output_port_name" qualifiers="virtual"> + <return type="String"> + </return> + <argument index="0" name="port" type="int"> + </argument> + <description> + Override this method to define the names of output ports of the associated custom node. The names are used both for the output slots in the editor and as identifiers in the shader code, and are passed in the [code]output_vars[/code] array in [method _get_code]. + Defining this method is [b]optional[/b], but recommended. If not overridden, output ports are named as [code]"out" + str(port)[/code]. + </description> + </method> + <method name="_get_output_port_type" qualifiers="virtual"> + <return type="int"> + </return> + <argument index="0" name="port" type="int"> + </argument> + <description> + Override this method to define the returned type of each output port of the associated custom node (see [enum VisualShaderNode.PortType] for possible types). + Defining this method is [b]optional[/b], but recommended. If not overridden, output ports will return the [constant VisualShaderNode.PORT_TYPE_SCALAR] type. + </description> + </method> + <method name="_get_return_icon_type" qualifiers="virtual"> + <return type="int"> + </return> + <description> + Override this method to define the return icon of the associated custom node in the Visual Shader Editor's members dialog. + Defining this method is [b]optional[/b]. If not overridden, no return icon is shown. + </description> + </method> + <method name="_get_subcategory" qualifiers="virtual"> + <return type="String"> + </return> + <description> + Override this method to define the subcategory of the associated custom node in the Visual Shader Editor's members dialog. + Defining this method is [b]optional[/b]. If not overridden, the node will be filed under the root of the main category (see [method _get_category]). + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualShaderNodeGlobalExpression.xml b/doc/classes/VisualShaderNodeGlobalExpression.xml new file mode 100644 index 0000000000..3c5a26bf47 --- /dev/null +++ b/doc/classes/VisualShaderNodeGlobalExpression.xml @@ -0,0 +1,13 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeGlobalExpression" inherits="VisualShaderNodeExpression" category="Core" version="3.2"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/VisualShaderNodeGroupBase.xml b/doc/classes/VisualShaderNodeGroupBase.xml index c2e9b9503b..d32a63d605 100644 --- a/doc/classes/VisualShaderNodeGroupBase.xml +++ b/doc/classes/VisualShaderNodeGroupBase.xml @@ -208,6 +208,10 @@ </description> </method> </methods> + <members> + <member name="editable" type="bool" setter="set_editable" getter="is_editable" default="false"> + </member> + </members> <constants> </constants> </class> diff --git a/doc/classes/VisualShaderNodeVectorScalarMix.xml b/doc/classes/VisualShaderNodeVectorScalarMix.xml new file mode 100644 index 0000000000..d83c2e7d44 --- /dev/null +++ b/doc/classes/VisualShaderNodeVectorScalarMix.xml @@ -0,0 +1,13 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeVectorScalarMix" inherits="VisualShaderNode" category="Core" version="3.2"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/X509Certificate.xml b/doc/classes/X509Certificate.xml new file mode 100644 index 0000000000..013f768843 --- /dev/null +++ b/doc/classes/X509Certificate.xml @@ -0,0 +1,29 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="X509Certificate" inherits="Resource" category="Core" version="3.2"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <methods> + <method name="load"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + </description> + </method> + <method name="save"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> |