diff options
Diffstat (limited to 'doc/classes')
74 files changed, 1388 insertions, 339 deletions
diff --git a/doc/classes/@GlobalScope.xml b/doc/classes/@GlobalScope.xml index 47553659c9..d2c6a853ad 100644 --- a/doc/classes/@GlobalScope.xml +++ b/doc/classes/@GlobalScope.xml @@ -1262,12 +1262,14 @@ </constant> <constant name="PROPERTY_HINT_MULTILINE_TEXT" value="18" enum="PropertyHint"> </constant> - <constant name="PROPERTY_HINT_COLOR_NO_ALPHA" value="19" enum="PropertyHint"> + <constant name="PROPERTY_HINT_PLACEHOLDER_TEXT" value="19" enum="PropertyHint"> </constant> - <constant name="PROPERTY_HINT_IMAGE_COMPRESS_LOSSY" value="20" enum="PropertyHint"> + <constant name="PROPERTY_HINT_COLOR_NO_ALPHA" value="20" enum="PropertyHint"> + </constant> + <constant name="PROPERTY_HINT_IMAGE_COMPRESS_LOSSY" value="21" enum="PropertyHint"> Hints that the image is compressed using lossy compression. </constant> - <constant name="PROPERTY_HINT_IMAGE_COMPRESS_LOSSLESS" value="21" enum="PropertyHint"> + <constant name="PROPERTY_HINT_IMAGE_COMPRESS_LOSSLESS" value="22" enum="PropertyHint"> Hints that the image is compressed using lossless compression. </constant> <constant name="PROPERTY_USAGE_STORAGE" value="1" enum="PropertyUsageFlags"> diff --git a/doc/classes/AnimationNode.xml b/doc/classes/AnimationNode.xml index 2f991699d6..d9bad150df 100644 --- a/doc/classes/AnimationNode.xml +++ b/doc/classes/AnimationNode.xml @@ -9,14 +9,6 @@ <demos> </demos> <methods> - <method name="_parent_set" qualifiers="virtual"> - <return type="void"> - </return> - <argument index="0" name="parent" type="Object"> - </argument> - <description> - </description> - </method> <method name="add_input"> <return type="void"> </return> @@ -62,40 +54,26 @@ <method name="blend_node"> <return type="float"> </return> - <argument index="0" name="node" type="AnimationNode"> + <argument index="0" name="name" type="String"> </argument> - <argument index="1" name="time" type="float"> + <argument index="1" name="node" type="AnimationNode"> </argument> - <argument index="2" name="seek" type="bool"> + <argument index="2" name="time" type="float"> </argument> - <argument index="3" name="blend" type="float"> + <argument index="3" name="seek" type="bool"> </argument> - <argument index="4" name="filter" type="int" enum="AnimationNode.FilterAction" default="0"> + <argument index="4" name="blend" type="float"> </argument> - <argument index="5" name="optimize" type="bool" default="true"> + <argument index="5" name="filter" type="int" enum="AnimationNode.FilterAction" default="0"> </argument> - <description> - </description> - </method> - <method name="get_caption" qualifiers="virtual"> - <return type="String"> - </return> - <description> - </description> - </method> - <method name="get_input_activity" qualifiers="const"> - <return type="float"> - </return> - <argument index="0" name="input" type="int"> + <argument index="6" name="optimize" type="bool" default="true"> </argument> <description> </description> </method> - <method name="get_input_connection"> + <method name="get_caption" qualifiers="virtual"> <return type="String"> </return> - <argument index="0" name="input" type="int"> - </argument> <description> </description> </method> @@ -113,21 +91,11 @@ <description> </description> </method> - <method name="get_parent" qualifiers="const"> - <return type="AnimationNode"> - </return> - <description> - </description> - </method> - <method name="get_position" qualifiers="const"> - <return type="Vector2"> - </return> - <description> - </description> - </method> - <method name="get_tree" qualifiers="const"> - <return type="AnimationTree"> + <method name="get_parameter" qualifiers="const"> + <return type="Variant"> </return> + <argument index="0" name="name" type="String"> + </argument> <description> </description> </method> @@ -173,18 +141,12 @@ <description> </description> </method> - <method name="set_parent"> + <method name="set_parameter"> <return type="void"> </return> - <argument index="0" name="parent" type="Object"> + <argument index="0" name="name" type="String"> </argument> - <description> - </description> - </method> - <method name="set_position"> - <return type="void"> - </return> - <argument index="0" name="position" type="Vector2"> + <argument index="1" name="value" type="Variant"> </argument> <description> </description> @@ -199,6 +161,10 @@ <description> </description> </signal> + <signal name="tree_changed"> + <description> + </description> + </signal> </signals> <constants> <constant name="FILTER_IGNORE" value="0" enum="FilterAction"> diff --git a/doc/classes/AnimationNodeAdd2.xml b/doc/classes/AnimationNodeAdd2.xml index 267eec6406..9297faa1b7 100644 --- a/doc/classes/AnimationNodeAdd2.xml +++ b/doc/classes/AnimationNodeAdd2.xml @@ -11,8 +11,6 @@ <methods> </methods> <members> - <member name="amount" type="float" setter="set_amount" getter="get_amount"> - </member> <member name="sync" type="bool" setter="set_use_sync" getter="is_using_sync"> </member> </members> diff --git a/doc/classes/AnimationNodeAdd3.xml b/doc/classes/AnimationNodeAdd3.xml index 6596b76f85..deb8d74a38 100644 --- a/doc/classes/AnimationNodeAdd3.xml +++ b/doc/classes/AnimationNodeAdd3.xml @@ -11,8 +11,6 @@ <methods> </methods> <members> - <member name="amount" type="float" setter="set_amount" getter="get_amount"> - </member> <member name="sync" type="bool" setter="set_use_sync" getter="is_using_sync"> </member> </members> diff --git a/doc/classes/AnimationNodeBlend2.xml b/doc/classes/AnimationNodeBlend2.xml index 8ef114f69b..42bb12d9d0 100644 --- a/doc/classes/AnimationNodeBlend2.xml +++ b/doc/classes/AnimationNodeBlend2.xml @@ -11,8 +11,6 @@ <methods> </methods> <members> - <member name="amount" type="float" setter="set_amount" getter="get_amount"> - </member> <member name="sync" type="bool" setter="set_use_sync" getter="is_using_sync"> </member> </members> diff --git a/doc/classes/AnimationNodeBlend3.xml b/doc/classes/AnimationNodeBlend3.xml index 094810d008..cd3d9f9bc8 100644 --- a/doc/classes/AnimationNodeBlend3.xml +++ b/doc/classes/AnimationNodeBlend3.xml @@ -11,8 +11,6 @@ <methods> </methods> <members> - <member name="amount" type="float" setter="set_amount" getter="get_amount"> - </member> <member name="sync" type="bool" setter="set_use_sync" getter="is_using_sync"> </member> </members> diff --git a/doc/classes/AnimationNodeBlendSpace1D.xml b/doc/classes/AnimationNodeBlendSpace1D.xml index 96c94a8972..2113948b2e 100644 --- a/doc/classes/AnimationNodeBlendSpace1D.xml +++ b/doc/classes/AnimationNodeBlendSpace1D.xml @@ -73,8 +73,6 @@ </method> </methods> <members> - <member name="blend_pos" type="float" setter="set_blend_pos" getter="get_blend_pos"> - </member> <member name="max_space" type="float" setter="set_max_space" getter="get_max_space"> </member> <member name="min_space" type="float" setter="set_min_space" getter="get_min_space"> diff --git a/doc/classes/AnimationNodeBlendSpace2D.xml b/doc/classes/AnimationNodeBlendSpace2D.xml index 31dc7eebac..39d780b6ef 100644 --- a/doc/classes/AnimationNodeBlendSpace2D.xml +++ b/doc/classes/AnimationNodeBlendSpace2D.xml @@ -113,8 +113,6 @@ <members> <member name="auto_triangles" type="bool" setter="set_auto_triangles" getter="get_auto_triangles"> </member> - <member name="blend_position" type="Vector2" setter="set_blend_position" getter="get_blend_position"> - </member> <member name="max_space" type="Vector2" setter="set_max_space" getter="get_max_space"> </member> <member name="min_space" type="Vector2" setter="set_min_space" getter="get_min_space"> diff --git a/doc/classes/AnimationNodeBlendTree.xml b/doc/classes/AnimationNodeBlendTree.xml index 88257883a3..cd28232908 100644 --- a/doc/classes/AnimationNodeBlendTree.xml +++ b/doc/classes/AnimationNodeBlendTree.xml @@ -16,6 +16,8 @@ </argument> <argument index="1" name="node" type="AnimationNode"> </argument> + <argument index="2" name="position" type="Vector2" default="Vector2( 0, 0 )"> + </argument> <description> </description> </method> @@ -49,6 +51,14 @@ <description> </description> </method> + <method name="get_node_position" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> <method name="has_node" qualifiers="const"> <return type="bool"> </return> @@ -75,6 +85,16 @@ <description> </description> </method> + <method name="set_node_position"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="position" type="Vector2"> + </argument> + <description> + </description> + </method> </methods> <members> <member name="graph_offset" type="Vector2" setter="set_graph_offset" getter="get_graph_offset"> diff --git a/doc/classes/AnimationNodeOneShot.xml b/doc/classes/AnimationNodeOneShot.xml index b59b6e2b83..12cb9775a2 100644 --- a/doc/classes/AnimationNodeOneShot.xml +++ b/doc/classes/AnimationNodeOneShot.xml @@ -15,12 +15,6 @@ <description> </description> </method> - <method name="is_active" qualifiers="const"> - <return type="bool"> - </return> - <description> - </description> - </method> <method name="set_mix_mode"> <return type="void"> </return> @@ -29,18 +23,6 @@ <description> </description> </method> - <method name="start"> - <return type="void"> - </return> - <description> - </description> - </method> - <method name="stop"> - <return type="void"> - </return> - <description> - </description> - </method> </methods> <members> <member name="autorestart" type="bool" setter="set_autorestart" getter="has_autorestart"> diff --git a/doc/classes/AnimationNodeStateMachine.xml b/doc/classes/AnimationNodeStateMachine.xml index ad40f20db1..ed4098d938 100644 --- a/doc/classes/AnimationNodeStateMachine.xml +++ b/doc/classes/AnimationNodeStateMachine.xml @@ -16,6 +16,8 @@ </argument> <argument index="1" name="node" type="AnimationNode"> </argument> + <argument index="2" name="position" type="Vector2" default="Vector2( 0, 0 )"> + </argument> <description> </description> </method> @@ -31,12 +33,6 @@ <description> </description> </method> - <method name="get_current_node" qualifiers="const"> - <return type="String"> - </return> - <description> - </description> - </method> <method name="get_end_node" qualifiers="const"> <return type="String"> </return> @@ -65,6 +61,14 @@ <description> </description> </method> + <method name="get_node_position" qualifiers="const"> + <return type="Vector2"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> <method name="get_start_node" qualifiers="const"> <return type="String"> </return> @@ -101,12 +105,6 @@ <description> </description> </method> - <method name="get_travel_path" qualifiers="const"> - <return type="PoolStringArray"> - </return> - <description> - </description> - </method> <method name="has_node" qualifiers="const"> <return type="bool"> </return> @@ -115,21 +113,13 @@ <description> </description> </method> - <method name="has_transition"> - <return type="void"> + <method name="has_transition" qualifiers="const"> + <return type="bool"> </return> <argument index="0" name="from" type="String"> </argument> <argument index="1" name="to" type="String"> </argument> - <argument index="2" name="arg2" type="AnimationNodeStateMachineTransition"> - </argument> - <description> - </description> - </method> - <method name="is_playing" qualifiers="const"> - <return type="bool"> - </return> <description> </description> </method> @@ -185,32 +175,20 @@ <description> </description> </method> - <method name="set_start_node"> + <method name="set_node_position"> <return type="void"> </return> <argument index="0" name="name" type="String"> </argument> - <description> - </description> - </method> - <method name="start"> - <return type="void"> - </return> - <argument index="0" name="node" type="String"> + <argument index="1" name="position" type="Vector2"> </argument> <description> </description> </method> - <method name="stop"> + <method name="set_start_node"> <return type="void"> </return> - <description> - </description> - </method> - <method name="travel"> - <return type="bool"> - </return> - <argument index="0" name="to_node" type="String"> + <argument index="0" name="name" type="String"> </argument> <description> </description> diff --git a/doc/classes/AnimationNodeStateMachinePlayback.xml b/doc/classes/AnimationNodeStateMachinePlayback.xml new file mode 100644 index 0000000000..6bf9504efb --- /dev/null +++ b/doc/classes/AnimationNodeStateMachinePlayback.xml @@ -0,0 +1,55 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AnimationNodeStateMachinePlayback" inherits="Resource" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_current_node" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="get_travel_path" qualifiers="const"> + <return type="PoolStringArray"> + </return> + <description> + </description> + </method> + <method name="is_playing" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="start"> + <return type="void"> + </return> + <argument index="0" name="node" type="String"> + </argument> + <description> + </description> + </method> + <method name="stop"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="travel"> + <return type="void"> + </return> + <argument index="0" name="to_node" type="String"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/AnimationNodeStateMachineTransition.xml b/doc/classes/AnimationNodeStateMachineTransition.xml index 280a1413b8..e07a9fc980 100644 --- a/doc/classes/AnimationNodeStateMachineTransition.xml +++ b/doc/classes/AnimationNodeStateMachineTransition.xml @@ -11,6 +11,8 @@ <methods> </methods> <members> + <member name="advance_condition" type="String" setter="set_advance_condition" getter="get_advance_condition"> + </member> <member name="auto_advance" type="bool" setter="set_auto_advance" getter="has_auto_advance"> </member> <member name="disabled" type="bool" setter="set_disabled" getter="is_disabled"> @@ -22,6 +24,12 @@ <member name="xfade_time" type="float" setter="set_xfade_time" getter="get_xfade_time"> </member> </members> + <signals> + <signal name="advance_condition_changed"> + <description> + </description> + </signal> + </signals> <constants> <constant name="SWITCH_MODE_IMMEDIATE" value="0" enum="SwitchMode"> </constant> diff --git a/doc/classes/AnimationNodeTimeScale.xml b/doc/classes/AnimationNodeTimeScale.xml index b3e90d190b..226c855b83 100644 --- a/doc/classes/AnimationNodeTimeScale.xml +++ b/doc/classes/AnimationNodeTimeScale.xml @@ -10,10 +10,6 @@ </demos> <methods> </methods> - <members> - <member name="scale" type="float" setter="set_scale" getter="get_scale"> - </member> - </members> <constants> </constants> </class> diff --git a/doc/classes/AnimationNodeTimeSeek.xml b/doc/classes/AnimationNodeTimeSeek.xml index a479208128..707b09a4a5 100644 --- a/doc/classes/AnimationNodeTimeSeek.xml +++ b/doc/classes/AnimationNodeTimeSeek.xml @@ -10,10 +10,6 @@ </demos> <methods> </methods> - <members> - <member name="seek_pos" type="float" setter="set_seek_pos" getter="get_seek_pos"> - </member> - </members> <constants> </constants> </class> diff --git a/doc/classes/AnimationNodeTransition.xml b/doc/classes/AnimationNodeTransition.xml index 3731fc05ed..317bc5ed69 100644 --- a/doc/classes/AnimationNodeTransition.xml +++ b/doc/classes/AnimationNodeTransition.xml @@ -11,8 +11,6 @@ <methods> </methods> <members> - <member name="current" type="int" setter="set_current" getter="get_current"> - </member> <member name="input_0/auto_advance" type="bool" setter="set_input_as_auto_advance" getter="is_input_set_as_auto_advance"> </member> <member name="input_0/name" type="String" setter="set_input_caption" getter="get_input_caption"> diff --git a/doc/classes/AnimationTree.xml b/doc/classes/AnimationTree.xml index 9b3679ae93..9a6a75079c 100644 --- a/doc/classes/AnimationTree.xml +++ b/doc/classes/AnimationTree.xml @@ -23,6 +23,16 @@ <description> </description> </method> + <method name="rename_parameter"> + <return type="void"> + </return> + <argument index="0" name="old_name" type="String"> + </argument> + <argument index="1" name="new_name" type="String"> + </argument> + <description> + </description> + </method> </methods> <members> <member name="active" type="bool" setter="set_active" getter="is_active"> diff --git a/doc/classes/ArrayMesh.xml b/doc/classes/ArrayMesh.xml index 5ccf0b55aa..1e2478dd14 100644 --- a/doc/classes/ArrayMesh.xml +++ b/doc/classes/ArrayMesh.xml @@ -76,9 +76,9 @@ <method name="lightmap_unwrap"> <return type="int" enum="Error"> </return> - <argument index="0" name="arg0" type="Transform"> + <argument index="0" name="transform" type="Transform"> </argument> - <argument index="1" name="arg1" type="float"> + <argument index="1" name="texel_size" type="float"> </argument> <description> Will perform a UV unwrap on the [code]ArrayMesh[/code] to prepare the mesh for lightmapping. diff --git a/doc/classes/AudioEffectRecord.xml b/doc/classes/AudioEffectRecord.xml new file mode 100644 index 0000000000..b7771fc9c5 --- /dev/null +++ b/doc/classes/AudioEffectRecord.xml @@ -0,0 +1,39 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AudioEffectRecord" inherits="AudioEffect" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_recording" qualifiers="const"> + <return type="AudioStreamSample"> + </return> + <description> + </description> + </method> + <method name="is_recording_active" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="set_recording_active"> + <return type="void"> + </return> + <argument index="0" name="record" type="bool"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="format" type="int" setter="set_format" getter="get_format" enum="AudioStreamSample.Format"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/AudioServer.xml b/doc/classes/AudioServer.xml index 51df1e99dd..37756bcfd8 100644 --- a/doc/classes/AudioServer.xml +++ b/doc/classes/AudioServer.xml @@ -34,6 +34,26 @@ 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> + <description> + </description> + </method> + <method name="capture_set_device"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> <method name="generate_bus_layout" qualifiers="const"> <return type="AudioBusLayout"> </return> @@ -328,7 +348,7 @@ <method name="set_device"> <return type="void"> </return> - <argument index="0" name="arg0" type="String"> + <argument index="0" name="device" type="String"> </argument> <description> </description> diff --git a/doc/classes/AudioStreamMicrophone.xml b/doc/classes/AudioStreamMicrophone.xml new file mode 100644 index 0000000000..079555d17e --- /dev/null +++ b/doc/classes/AudioStreamMicrophone.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="AudioStreamMicrophone" inherits="AudioStream" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/AudioStreamSample.xml b/doc/classes/AudioStreamSample.xml index b6abda1a6f..9e56cc6016 100644 --- a/doc/classes/AudioStreamSample.xml +++ b/doc/classes/AudioStreamSample.xml @@ -11,6 +11,14 @@ <demos> </demos> <methods> + <method name="save_to_wav"> + <return type="void"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + </description> + </method> </methods> <members> <member name="data" type="PoolByteArray" setter="set_data" getter="get_data"> diff --git a/doc/classes/BakedLightmap.xml b/doc/classes/BakedLightmap.xml index 77895249e5..966b6dd7c4 100644 --- a/doc/classes/BakedLightmap.xml +++ b/doc/classes/BakedLightmap.xml @@ -1,8 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="BakedLightmap" inherits="VisualInstance" category="Core" version="3.1"> <brief_description> + Prerendered indirect light map for a scene. </brief_description> <description> + Baked lightmaps are an alternative workflow for adding indirect (or baked) lighting to a scene. Unlike the [GIProbe] approach, baked lightmaps work fine on low-end PCs and mobile devices as they consume almost no resources in run-time. </description> <tutorials> <link>http://docs.godotengine.org/en/3.0/tutorials/3d/baked_lightmaps.html</link> @@ -29,36 +31,49 @@ </methods> <members> <member name="bake_cell_size" type="float" setter="set_bake_cell_size" getter="get_bake_cell_size"> + Grid subdivision size for lightmapper calculation. Default value of [code]0.25[/code] will work for most cases. Increase for better lighting on small details or if your scene is very large. </member> <member name="bake_energy" type="float" setter="set_energy" getter="get_energy"> </member> <member name="bake_extents" type="Vector3" setter="set_extents" getter="get_extents"> + Size of affected area. </member> <member name="bake_hdr" type="bool" setter="set_hdr" getter="is_hdr"> + If [code]true[/code] lightmap can capture light values greater than [code]1.0[/code]. Turning this off will result in a smaller lightmap. Default value:[code]false[/code]. </member> <member name="bake_mode" type="int" setter="set_bake_mode" getter="get_bake_mode" enum="BakedLightmap.BakeMode"> + Lightmapping mode. See [enum BakeMode]. </member> <member name="bake_propagation" type="float" setter="set_propagation" getter="get_propagation"> </member> <member name="bake_quality" type="int" setter="set_bake_quality" getter="get_bake_quality" enum="BakedLightmap.BakeQuality"> + Three quality modes are available. Higher quality requires more rendering time. See [enum BakeQuality]. </member> <member name="capture_cell_size" type="float" setter="set_capture_cell_size" getter="get_capture_cell_size"> + Grid size used for real-time capture information on dynamic objects. Cannot be larger than [member bake_cell_size]. </member> <member name="image_path" type="String" setter="set_image_path" getter="get_image_path"> + Location where lightmaps will be saved. </member> <member name="light_data" type="BakedLightmapData" setter="set_light_data" getter="get_light_data"> + The calculated light data. </member> </members> <constants> <constant name="BAKE_QUALITY_LOW" value="0" enum="BakeQuality"> + Lowest bake quality mode. Fastest to calculate. </constant> <constant name="BAKE_QUALITY_MEDIUM" value="1" enum="BakeQuality"> + Default bake quality mode. </constant> <constant name="BAKE_QUALITY_HIGH" value="2" enum="BakeQuality"> + Highest bake quality mode. Takes longer to calculate. </constant> <constant name="BAKE_MODE_CONE_TRACE" value="0" enum="BakeMode"> + Less precise but faster bake mode. </constant> <constant name="BAKE_MODE_RAY_TRACE" value="1" enum="BakeMode"> + More precise bake mode but can take considerably longer to bake. </constant> <constant name="BAKE_ERROR_OK" value="0" enum="BakeError"> </constant> diff --git a/doc/classes/BitMap.xml b/doc/classes/BitMap.xml index 98f554ebaa..7fe6a2acef 100644 --- a/doc/classes/BitMap.xml +++ b/doc/classes/BitMap.xml @@ -54,6 +54,26 @@ Returns the amount of bitmap elements that are set to true. </description> </method> + <method name="grow_mask"> + <return type="void"> + </return> + <argument index="0" name="pixels" type="int"> + </argument> + <argument index="1" name="rect" type="Rect2"> + </argument> + <description> + </description> + </method> + <method name="opaque_to_polygons" qualifiers="const"> + <return type="Array"> + </return> + <argument index="0" name="rect" type="Rect2"> + </argument> + <argument index="1" name="epsilon" type="float" default="2.0"> + </argument> + <description> + </description> + </method> <method name="set_bit"> <return type="void"> </return> diff --git a/doc/classes/Camera.xml b/doc/classes/Camera.xml index 7f7f152ae9..c7eb365891 100644 --- a/doc/classes/Camera.xml +++ b/doc/classes/Camera.xml @@ -27,6 +27,14 @@ Gets the camera transform. Subclassed cameras (such as CharacterCamera) may provide different transforms than the [Node] transform. </description> </method> + <method name="get_cull_mask_bit" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="layer" type="int"> + </argument> + <description> + </description> + </method> <method name="is_position_behind" qualifiers="const"> <return type="bool"> </return> @@ -79,6 +87,16 @@ Returns a 3D position in worldspace, that is the result of projecting a point on the [Viewport] rectangle by the camera projection. This is useful for casting rays in the form of (origin, normal) for object intersection or picking. </description> </method> + <method name="set_cull_mask_bit"> + <return type="void"> + </return> + <argument index="0" name="layer" type="int"> + </argument> + <argument index="1" name="enable" type="bool"> + </argument> + <description> + </description> + </method> <method name="set_orthogonal"> <return type="void"> </return> diff --git a/doc/classes/Color.xml b/doc/classes/Color.xml index c675bbe994..b66239181a 100644 --- a/doc/classes/Color.xml +++ b/doc/classes/Color.xml @@ -305,5 +305,295 @@ </member> </members> <constants> + <constant name="gray" value="Color( 0.75, 0.75, 0.75, 1 )"> + </constant> + <constant name="aliceblue" value="Color( 0.94, 0.97, 1, 1 )"> + </constant> + <constant name="antiquewhite" value="Color( 0.98, 0.92, 0.84, 1 )"> + </constant> + <constant name="aqua" value="Color( 0, 1, 1, 1 )"> + </constant> + <constant name="aquamarine" value="Color( 0.5, 1, 0.83, 1 )"> + </constant> + <constant name="azure" value="Color( 0.94, 1, 1, 1 )"> + </constant> + <constant name="beige" value="Color( 0.96, 0.96, 0.86, 1 )"> + </constant> + <constant name="bisque" value="Color( 1, 0.89, 0.77, 1 )"> + </constant> + <constant name="black" value="Color( 0, 0, 0, 1 )"> + </constant> + <constant name="blanchedalmond" value="Color( 1, 0.92, 0.8, 1 )"> + </constant> + <constant name="blue" value="Color( 0, 0, 1, 1 )"> + </constant> + <constant name="blueviolet" value="Color( 0.54, 0.17, 0.89, 1 )"> + </constant> + <constant name="brown" value="Color( 0.65, 0.16, 0.16, 1 )"> + </constant> + <constant name="burlywood" value="Color( 0.87, 0.72, 0.53, 1 )"> + </constant> + <constant name="cadetblue" value="Color( 0.37, 0.62, 0.63, 1 )"> + </constant> + <constant name="chartreuse" value="Color( 0.5, 1, 0, 1 )"> + </constant> + <constant name="chocolate" value="Color( 0.82, 0.41, 0.12, 1 )"> + </constant> + <constant name="coral" value="Color( 1, 0.5, 0.31, 1 )"> + </constant> + <constant name="cornflower" value="Color( 0.39, 0.58, 0.93, 1 )"> + </constant> + <constant name="cornsilk" value="Color( 1, 0.97, 0.86, 1 )"> + </constant> + <constant name="crimson" value="Color( 0.86, 0.08, 0.24, 1 )"> + </constant> + <constant name="cyan" value="Color( 0, 1, 1, 1 )"> + </constant> + <constant name="darkblue" value="Color( 0, 0, 0.55, 1 )"> + </constant> + <constant name="darkcyan" value="Color( 0, 0.55, 0.55, 1 )"> + </constant> + <constant name="darkgoldenrod" value="Color( 0.72, 0.53, 0.04, 1 )"> + </constant> + <constant name="darkgray" value="Color( 0.66, 0.66, 0.66, 1 )"> + </constant> + <constant name="darkgreen" value="Color( 0, 0.39, 0, 1 )"> + </constant> + <constant name="darkkhaki" value="Color( 0.74, 0.72, 0.42, 1 )"> + </constant> + <constant name="darkmagenta" value="Color( 0.55, 0, 0.55, 1 )"> + </constant> + <constant name="darkolivegreen" value="Color( 0.33, 0.42, 0.18, 1 )"> + </constant> + <constant name="darkorange" value="Color( 1, 0.55, 0, 1 )"> + </constant> + <constant name="darkorchid" value="Color( 0.6, 0.2, 0.8, 1 )"> + </constant> + <constant name="darkred" value="Color( 0.55, 0, 0, 1 )"> + </constant> + <constant name="darksalmon" value="Color( 0.91, 0.59, 0.48, 1 )"> + </constant> + <constant name="darkseagreen" value="Color( 0.56, 0.74, 0.56, 1 )"> + </constant> + <constant name="darkslateblue" value="Color( 0.28, 0.24, 0.55, 1 )"> + </constant> + <constant name="darkslategray" value="Color( 0.18, 0.31, 0.31, 1 )"> + </constant> + <constant name="darkturquoise" value="Color( 0, 0.81, 0.82, 1 )"> + </constant> + <constant name="darkviolet" value="Color( 0.58, 0, 0.83, 1 )"> + </constant> + <constant name="deeppink" value="Color( 1, 0.08, 0.58, 1 )"> + </constant> + <constant name="deepskyblue" value="Color( 0, 0.75, 1, 1 )"> + </constant> + <constant name="dimgray" value="Color( 0.41, 0.41, 0.41, 1 )"> + </constant> + <constant name="dodgerblue" value="Color( 0.12, 0.56, 1, 1 )"> + </constant> + <constant name="firebrick" value="Color( 0.7, 0.13, 0.13, 1 )"> + </constant> + <constant name="floralwhite" value="Color( 1, 0.98, 0.94, 1 )"> + </constant> + <constant name="forestgreen" value="Color( 0.13, 0.55, 0.13, 1 )"> + </constant> + <constant name="fuchsia" value="Color( 1, 0, 1, 1 )"> + </constant> + <constant name="gainsboro" value="Color( 0.86, 0.86, 0.86, 1 )"> + </constant> + <constant name="ghostwhite" value="Color( 0.97, 0.97, 1, 1 )"> + </constant> + <constant name="gold" value="Color( 1, 0.84, 0, 1 )"> + </constant> + <constant name="goldenrod" value="Color( 0.85, 0.65, 0.13, 1 )"> + </constant> + <constant name="green" value="Color( 0, 1, 0, 1 )"> + </constant> + <constant name="greenyellow" value="Color( 0.68, 1, 0.18, 1 )"> + </constant> + <constant name="honeydew" value="Color( 0.94, 1, 0.94, 1 )"> + </constant> + <constant name="hotpink" value="Color( 1, 0.41, 0.71, 1 )"> + </constant> + <constant name="indianred" value="Color( 0.8, 0.36, 0.36, 1 )"> + </constant> + <constant name="indigo" value="Color( 0.29, 0, 0.51, 1 )"> + </constant> + <constant name="ivory" value="Color( 1, 1, 0.94, 1 )"> + </constant> + <constant name="khaki" value="Color( 0.94, 0.9, 0.55, 1 )"> + </constant> + <constant name="lavender" value="Color( 0.9, 0.9, 0.98, 1 )"> + </constant> + <constant name="lavenderblush" value="Color( 1, 0.94, 0.96, 1 )"> + </constant> + <constant name="lawngreen" value="Color( 0.49, 0.99, 0, 1 )"> + </constant> + <constant name="lemonchiffon" value="Color( 1, 0.98, 0.8, 1 )"> + </constant> + <constant name="lightblue" value="Color( 0.68, 0.85, 0.9, 1 )"> + </constant> + <constant name="lightcoral" value="Color( 0.94, 0.5, 0.5, 1 )"> + </constant> + <constant name="lightcyan" value="Color( 0.88, 1, 1, 1 )"> + </constant> + <constant name="lightgoldenrod" value="Color( 0.98, 0.98, 0.82, 1 )"> + </constant> + <constant name="lightgray" value="Color( 0.83, 0.83, 0.83, 1 )"> + </constant> + <constant name="lightgreen" value="Color( 0.56, 0.93, 0.56, 1 )"> + </constant> + <constant name="lightpink" value="Color( 1, 0.71, 0.76, 1 )"> + </constant> + <constant name="lightsalmon" value="Color( 1, 0.63, 0.48, 1 )"> + </constant> + <constant name="lightseagreen" value="Color( 0.13, 0.7, 0.67, 1 )"> + </constant> + <constant name="lightskyblue" value="Color( 0.53, 0.81, 0.98, 1 )"> + </constant> + <constant name="lightslategray" value="Color( 0.47, 0.53, 0.6, 1 )"> + </constant> + <constant name="lightsteelblue" value="Color( 0.69, 0.77, 0.87, 1 )"> + </constant> + <constant name="lightyellow" value="Color( 1, 1, 0.88, 1 )"> + </constant> + <constant name="lime" value="Color( 0, 1, 0, 1 )"> + </constant> + <constant name="limegreen" value="Color( 0.2, 0.8, 0.2, 1 )"> + </constant> + <constant name="linen" value="Color( 0.98, 0.94, 0.9, 1 )"> + </constant> + <constant name="magenta" value="Color( 1, 0, 1, 1 )"> + </constant> + <constant name="maroon" value="Color( 0.69, 0.19, 0.38, 1 )"> + </constant> + <constant name="mediumaquamarine" value="Color( 0.4, 0.8, 0.67, 1 )"> + </constant> + <constant name="mediumblue" value="Color( 0, 0, 0.8, 1 )"> + </constant> + <constant name="mediumorchid" value="Color( 0.73, 0.33, 0.83, 1 )"> + </constant> + <constant name="mediumpurple" value="Color( 0.58, 0.44, 0.86, 1 )"> + </constant> + <constant name="mediumseagreen" value="Color( 0.24, 0.7, 0.44, 1 )"> + </constant> + <constant name="mediumslateblue" value="Color( 0.48, 0.41, 0.93, 1 )"> + </constant> + <constant name="mediumspringgreen" value="Color( 0, 0.98, 0.6, 1 )"> + </constant> + <constant name="mediumturquoise" value="Color( 0.28, 0.82, 0.8, 1 )"> + </constant> + <constant name="mediumvioletred" value="Color( 0.78, 0.08, 0.52, 1 )"> + </constant> + <constant name="midnightblue" value="Color( 0.1, 0.1, 0.44, 1 )"> + </constant> + <constant name="mintcream" value="Color( 0.96, 1, 0.98, 1 )"> + </constant> + <constant name="mistyrose" value="Color( 1, 0.89, 0.88, 1 )"> + </constant> + <constant name="moccasin" value="Color( 1, 0.89, 0.71, 1 )"> + </constant> + <constant name="navajowhite" value="Color( 1, 0.87, 0.68, 1 )"> + </constant> + <constant name="navyblue" value="Color( 0, 0, 0.5, 1 )"> + </constant> + <constant name="oldlace" value="Color( 0.99, 0.96, 0.9, 1 )"> + </constant> + <constant name="olive" value="Color( 0.5, 0.5, 0, 1 )"> + </constant> + <constant name="olivedrab" value="Color( 0.42, 0.56, 0.14, 1 )"> + </constant> + <constant name="orange" value="Color( 1, 0.65, 0, 1 )"> + </constant> + <constant name="orangered" value="Color( 1, 0.27, 0, 1 )"> + </constant> + <constant name="orchid" value="Color( 0.85, 0.44, 0.84, 1 )"> + </constant> + <constant name="palegoldenrod" value="Color( 0.93, 0.91, 0.67, 1 )"> + </constant> + <constant name="palegreen" value="Color( 0.6, 0.98, 0.6, 1 )"> + </constant> + <constant name="paleturquoise" value="Color( 0.69, 0.93, 0.93, 1 )"> + </constant> + <constant name="palevioletred" value="Color( 0.86, 0.44, 0.58, 1 )"> + </constant> + <constant name="papayawhip" value="Color( 1, 0.94, 0.84, 1 )"> + </constant> + <constant name="peachpuff" value="Color( 1, 0.85, 0.73, 1 )"> + </constant> + <constant name="peru" value="Color( 0.8, 0.52, 0.25, 1 )"> + </constant> + <constant name="pink" value="Color( 1, 0.75, 0.8, 1 )"> + </constant> + <constant name="plum" value="Color( 0.87, 0.63, 0.87, 1 )"> + </constant> + <constant name="powderblue" value="Color( 0.69, 0.88, 0.9, 1 )"> + </constant> + <constant name="purple" value="Color( 0.63, 0.13, 0.94, 1 )"> + </constant> + <constant name="rebeccapurple" value="Color( 0.4, 0.2, 0.6, 1 )"> + </constant> + <constant name="red" value="Color( 1, 0, 0, 1 )"> + </constant> + <constant name="rosybrown" value="Color( 0.74, 0.56, 0.56, 1 )"> + </constant> + <constant name="royalblue" value="Color( 0.25, 0.41, 0.88, 1 )"> + </constant> + <constant name="saddlebrown" value="Color( 0.55, 0.27, 0.07, 1 )"> + </constant> + <constant name="salmon" value="Color( 0.98, 0.5, 0.45, 1 )"> + </constant> + <constant name="sandybrown" value="Color( 0.96, 0.64, 0.38, 1 )"> + </constant> + <constant name="seagreen" value="Color( 0.18, 0.55, 0.34, 1 )"> + </constant> + <constant name="seashell" value="Color( 1, 0.96, 0.93, 1 )"> + </constant> + <constant name="sienna" value="Color( 0.63, 0.32, 0.18, 1 )"> + </constant> + <constant name="silver" value="Color( 0.75, 0.75, 0.75, 1 )"> + </constant> + <constant name="skyblue" value="Color( 0.53, 0.81, 0.92, 1 )"> + </constant> + <constant name="slateblue" value="Color( 0.42, 0.35, 0.8, 1 )"> + </constant> + <constant name="slategray" value="Color( 0.44, 0.5, 0.56, 1 )"> + </constant> + <constant name="snow" value="Color( 1, 0.98, 0.98, 1 )"> + </constant> + <constant name="springgreen" value="Color( 0, 1, 0.5, 1 )"> + </constant> + <constant name="steelblue" value="Color( 0.27, 0.51, 0.71, 1 )"> + </constant> + <constant name="tan" value="Color( 0.82, 0.71, 0.55, 1 )"> + </constant> + <constant name="teal" value="Color( 0, 0.5, 0.5, 1 )"> + </constant> + <constant name="thistle" value="Color( 0.85, 0.75, 0.85, 1 )"> + </constant> + <constant name="tomato" value="Color( 1, 0.39, 0.28, 1 )"> + </constant> + <constant name="turquoise" value="Color( 0.25, 0.88, 0.82, 1 )"> + </constant> + <constant name="violet" value="Color( 0.93, 0.51, 0.93, 1 )"> + </constant> + <constant name="webgray" value="Color( 0.5, 0.5, 0.5, 1 )"> + </constant> + <constant name="webgreen" value="Color( 0, 0.5, 0, 1 )"> + </constant> + <constant name="webmaroon" value="Color( 0.5, 0, 0, 1 )"> + </constant> + <constant name="webpurple" value="Color( 0.5, 0, 0.5, 1 )"> + </constant> + <constant name="wheat" value="Color( 0.96, 0.87, 0.7, 1 )"> + </constant> + <constant name="white" value="Color( 1, 1, 1, 1 )"> + </constant> + <constant name="whitesmoke" value="Color( 0.96, 0.96, 0.96, 1 )"> + </constant> + <constant name="yellow" value="Color( 1, 1, 0, 1 )"> + </constant> + <constant name="yellowgreen" value="Color( 0.6, 0.8, 0.2, 1 )"> + </constant> </constants> </class> diff --git a/doc/classes/ColorPicker.xml b/doc/classes/ColorPicker.xml index 232357f822..4d52eacba8 100644 --- a/doc/classes/ColorPicker.xml +++ b/doc/classes/ColorPicker.xml @@ -4,7 +4,7 @@ Color picker control. </brief_description> <description> - This is a simple color picker [Control]. It's useful for selecting a color from an RGB/RGBA colorspace. + [Control] node displaying a color picker widget. It's useful for selecting a color from an RGB/RGBA colorspace. </description> <tutorials> </tutorials> @@ -17,7 +17,7 @@ <argument index="0" name="color" type="Color"> </argument> <description> - Adds the current selected to color to a list of colors (presets), the presets will be displayed in the color picker and the user will be able to select them, notice that the presets list is only for this color picker. + Adds the given color to a list of color presets. The presets are displayed in the color picker and the user will be able to select them. Note: the presets list is only for [i]this[/i] color picker. </description> </method> </methods> @@ -26,13 +26,13 @@ The currently selected color. </member> <member name="deferred_mode" type="bool" setter="set_deferred_mode" getter="is_deferred_mode"> - If [code]true[/code], the color will apply only after user releases mouse button, otherwise it will apply immediatly even in mouse motion event (which can cause performance issues). + If [code]true[/code] the color will apply only after the user releases the mouse button, otherwise it will apply immediatly even in mouse motion event (which can cause performance issues). </member> <member name="edit_alpha" type="bool" setter="set_edit_alpha" getter="is_editing_alpha"> - If [code]true[/code], shows an alpha channel slider (transparency). + If [code]true[/code] shows an alpha channel slider (transparency). </member> <member name="raw_mode" type="bool" setter="set_raw_mode" getter="is_raw_mode"> - If [code]true[/code], allows the color R, G, B component values to go beyond 1.0, which can be used for certain special operations that require it (like tinting without darkening or rendering sprites in HDR). + If [code]true[/code] allows the color R, G, B component values to go beyond 1.0, which can be used for certain special operations that require it (like tinting without darkening or rendering sprites in HDR). </member> </members> <signals> diff --git a/doc/classes/ColorPickerButton.xml b/doc/classes/ColorPickerButton.xml index d049e936a8..6ac2911c11 100644 --- a/doc/classes/ColorPickerButton.xml +++ b/doc/classes/ColorPickerButton.xml @@ -4,7 +4,7 @@ Button that pops out a [ColorPicker]. </brief_description> <description> - Encapsulates a [ColorPicker] making it accesible by pressing a button, pressing the button will toggle the [ColorPicker] visibility + Encapsulates a [ColorPicker] making it accesible by pressing a button. Pressing the button will toggle the [ColorPicker] visibility. </description> <tutorials> </tutorials> @@ -15,14 +15,14 @@ <return type="ColorPicker"> </return> <description> - Returns the [code]ColorPicker[/code] that this [code]ColorPickerButton[/code] toggles. + Returns the [ColorPicker] that this node toggles. </description> </method> <method name="get_popup"> <return type="PopupPanel"> </return> <description> - Returns the control's [PopupPanel] which allows you to connect to Popup Signals. This allows you to handle events when the ColorPicker is shown or hidden. + Returns the control's [PopupPanel] which allows you to connect to popup signals. This allows you to handle events when the ColorPicker is shown or hidden. </description> </method> </methods> diff --git a/doc/classes/ColorRect.xml b/doc/classes/ColorRect.xml index 69a70cfa39..e1bffb719e 100644 --- a/doc/classes/ColorRect.xml +++ b/doc/classes/ColorRect.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="ColorRect" inherits="Control" category="Core" version="3.1"> <brief_description> - Colored rect for canvas. + Colored rectangle. </brief_description> <description> - An object that is represented on the canvas as a rect with color. [Color] is used to set or get color info for the rect. + Displays a colored rectangle. </description> <tutorials> </tutorials> @@ -14,9 +14,9 @@ </methods> <members> <member name="color" type="Color" setter="set_frame_color" getter="get_frame_color"> - The color to fill the [code]ColorRect[/code]. + The fill color. [codeblock] - $ColorRect.color = Color(1, 0, 0, 1) # Set ColorRect node's color to red + $ColorRect.color = Color(1, 0, 0, 1) # Set ColorRect's color to red. [/codeblock] </member> </members> diff --git a/doc/classes/Control.xml b/doc/classes/Control.xml index d11b369e68..4301102e4a 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.1"> <brief_description> - All User Interface nodes inherit from Control. Features anchors and margins to adapt its position and size 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 User Interface or [i]UI[/i] related nodes. [code]Control[/code] features a bounding rectangle that defines its extents, an anchor position relative to its parent 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. @@ -19,11 +19,17 @@ <demos> </demos> <methods> + <method name="_clips_input" qualifiers="virtual"> + <return type="bool"> + </return> + <description> + </description> + </method> <method name="_get_minimum_size" qualifiers="virtual"> <return type="Vector2"> </return> <description> - Returns the minimum size this Control can shrink to. The node can never be smaller than this minimum size. + Returns the minimum size for this control. See [member rect_min_size]. </description> </method> <method name="_gui_input" qualifiers="virtual"> @@ -129,7 +135,7 @@ This method should only be used to test the data. Process the data in [method drop_data]. [codeblock] extends Control - + func can_drop_data(position, data): # check position if it is relevant to you # otherwise just check data @@ -148,10 +154,10 @@ Godot calls this method to pass you the [code]data[/code] from a control's [method get_drag_data] result. Godot first calls [method can_drop_data] to test if [code]data[/code] is allowed to drop at [code]position[/code] where [code]position[/code] is local to this control. [codeblock] extends ColorRect - + func can_drop_data(position, data): return typeof(data) == TYPE_DICTIONARY and data.has('color') - + func drop_data(position, data): color = data['color'] [/codeblock] @@ -173,6 +179,7 @@ <return type="Vector2"> </return> <description> + Returns [member margin_left] and [member margin_top]. See also [member rect_position]. </description> </method> <method name="get_color" qualifiers="const"> @@ -207,7 +214,7 @@ <argument index="0" name="position" type="Vector2" default="Vector2( 0, 0 )"> </argument> <description> - Returns the mouse cursor shape the control displays on mouse hover, one of the [code]CURSOR_*[/code] constants. + Returns the mouse cursor shape the control displays on mouse hover. See [enum CursorShape]. </description> </method> <method name="get_drag_data" qualifiers="virtual"> @@ -220,7 +227,7 @@ A preview that will follow the mouse that should represent the data can be set with [method set_drag_preview]. A good time to set the preview is in this method. [codeblock] extends Control - + func get_drag_data(position): var mydata = make_data() set_drag_preview(make_preview(mydata)) @@ -232,14 +239,14 @@ <return type="Vector2"> </return> <description> - Returns MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see [method set_margin]). + Returns [member margin_right] and [member margin_bottom]. </description> </method> <method name="get_focus_owner" qualifiers="const"> <return type="Control"> </return> <description> - Return which control is owning the keyboard focus, or null if no one. + Returns the control that has the keyboard focus or [code]null[/code] if none. </description> </method> <method name="get_font" qualifiers="const"> @@ -256,7 +263,7 @@ <return type="Rect2"> </return> <description> - Return position and size of the Control, relative to the top-left corner of the [i]window[/i] Control. This is a helper (see [method get_global_position], [method get_size]). + Returns the position and size of the control relative to the top-left corner of the screen. See [member rect_position] and [member rect_size]. </description> </method> <method name="get_icon" qualifiers="const"> @@ -273,33 +280,35 @@ <return type="Vector2"> </return> <description> - Return the minimum size this Control can shrink to. A control will never be displayed or resized smaller than its minimum size. + Returns the minimum size for this control. See [member rect_min_size]. </description> </method> <method name="get_parent_area_size" qualifiers="const"> <return type="Vector2"> </return> <description> + Returns the width/height occupied in the parent control. </description> </method> <method name="get_parent_control" qualifiers="const"> <return type="Control"> </return> <description> + Returns the parent control node. </description> </method> <method name="get_rect" qualifiers="const"> <return type="Rect2"> </return> <description> - Return position and size of the Control, relative to the top-left corner of the parent Control. This is a helper (see [method get_position], [method get_size]). + Returns the position and size of the control relative to the top-left corner of the parent Control. See [member rect_position] and [member rect_size]. </description> </method> <method name="get_rotation" qualifiers="const"> <return type="float"> </return> <description> - Return the rotation (in radians) + Returns the rotation (in radians). </description> </method> <method name="get_stylebox" qualifiers="const"> @@ -318,7 +327,7 @@ <argument index="0" name="at_position" type="Vector2" default="Vector2( 0, 0 )"> </argument> <description> - Return the tooltip, which will appear when the cursor is resting over this control. + Returns the tooltip, which will appear when the cursor is resting over this control. </description> </method> <method name="grab_click_focus"> @@ -374,7 +383,7 @@ <return type="bool"> </return> <description> - Return whether the Control is the current focused control (see [method set_focus_mode]). + Returns [code]true[/code] if this is the current focused control. See [member focus_mode]. </description> </method> <method name="has_font" qualifiers="const"> @@ -457,7 +466,7 @@ <return type="void"> </return> <description> - Give up the focus, no other control will be able to receive keyboard input. + Give up the focus. No other control will be able to receive keyboard input. </description> </method> <method name="set_anchor"> @@ -516,7 +525,7 @@ <argument index="0" name="position" type="Vector2"> </argument> <description> - Sets MARGIN_LEFT and MARGIN_TOP at the same time. This is a helper (see [method set_margin]). + Sets [member margin_left] and [member margin_top] at the same time. </description> </method> <method name="set_drag_forwarding"> @@ -534,15 +543,15 @@ extends Control func _ready(): set_drag_forwarding(target_control) - + # TargetControl.gd extends Control func can_drop_data_fw(position, data, from_control): return true - + func drop_data_fw(position, data, from_control): my_handle_data(data) - + func get_drag_data_fw(position, from_control): set_drag_preview(my_preview) return my_data() @@ -564,7 +573,7 @@ <argument index="0" name="position" type="Vector2"> </argument> <description> - Sets MARGIN_RIGHT and MARGIN_BOTTOM at the same time. This is a helper (see [method set_margin]). + Sets [member margin_right] and [member margin_bottom] at the same time. </description> </method> <method name="set_margins_preset"> @@ -585,7 +594,7 @@ <argument index="0" name="radians" type="float"> </argument> <description> - Set the rotation (in radians). + Sets the rotation (in radians). </description> </method> <method name="show_modal"> @@ -594,7 +603,7 @@ <argument index="0" name="exclusive" type="bool" default="false"> </argument> <description> - Display a Control as modal. Control must be a subwindow. Modal controls capture the input signals until closed or the area outside them is accessed. When a modal control loses focus, or the ESC key is pressed, they automatically hide. Modal controls are used extensively for popup dialogs and menus. + Displays a control as modal. Control must be a subwindow. Modal controls capture the input signals until closed or the area outside them is accessed. When a modal control loses focus, or the ESC key is pressed, they automatically hide. Modal controls are used extensively for popup dialogs and menus. </description> </method> <method name="warp_mouse"> @@ -753,22 +762,22 @@ </signals> <constants> <constant name="FOCUS_NONE" value="0" enum="FocusMode"> - The node cannot grab focus. Use with [member set_focus_mode]. + The node cannot grab focus. Use with [member focus_mode]. </constant> <constant name="FOCUS_CLICK" value="1" enum="FocusMode"> - The node can only grab focus on mouse clicks. Use with [member set_focus_mode]. + The node can only grab focus on mouse clicks. Use with [member focus_mode]. </constant> <constant name="FOCUS_ALL" value="2" enum="FocusMode"> - The node can grab focus on mouse click or using the arrows and the Tab keys on the keyboard. Use with [member set_focus_mode]. + The node can grab focus on mouse click or using the arrows and the Tab keys on the keyboard. Use with [member focus_mode]. </constant> <constant name="NOTIFICATION_RESIZED" value="40"> Sent when the node changes size. Use [member rect_size] to get the new size. </constant> <constant name="NOTIFICATION_MOUSE_ENTER" value="41"> - Sent when the mouse pointer enters the node's [code]Rect[/code] area. + Sent when the mouse pointer enters the node. </constant> <constant name="NOTIFICATION_MOUSE_EXIT" value="42"> - Sent when the mouse pointer exits the node's [code]Rect[/code] area. + Sent when the mouse pointer exits the node. </constant> <constant name="NOTIFICATION_FOCUS_ENTER" value="43"> Sent when the node grabs focus. @@ -777,7 +786,7 @@ Sent when the node loses focus. </constant> <constant name="NOTIFICATION_THEME_CHANGED" value="45"> - Sent when the node's [member theme] changes, right before Godot redraws the [code]Control[/code]. Happens when you call one of the [code]add_*_override[/code] + Sent when the node's [member theme] changes, right before Godot redraws the control. Happens when you call one of the [code]add_*_override[/code] </constant> <constant name="NOTIFICATION_MODAL_CLOSE" value="46"> Sent when an open modal dialog closes. See [member show_modal]. @@ -903,7 +912,7 @@ Sets the node's size flags to both fill and expand. See the 2 constants above for more information. </constant> <constant name="SIZE_SHRINK_CENTER" value="4" enum="SizeFlags"> - Tells the parent [Container] to center the node in itself. It centers the [code]Control[/code] based on its bounding box, so it doesn't work with the fill or expand size flags. Use with [member size_flags_horizontal] and [member size_flags_vertical]. + Tells the parent [Container] to center the node in itself. It centers the control based on its bounding box, so it doesn't work with the fill or expand size flags. Use with [member size_flags_horizontal] and [member size_flags_vertical]. </constant> <constant name="SIZE_SHRINK_END" value="8" enum="SizeFlags"> Tells the parent [Container] to align the node with its end, either the bottom or the right edge. It doesn't work with the fill or expand size flags. Use with [member size_flags_horizontal] and [member size_flags_vertical]. diff --git a/doc/classes/Dictionary.xml b/doc/classes/Dictionary.xml index 9fa1e3ea6c..800a76ccf1 100644 --- a/doc/classes/Dictionary.xml +++ b/doc/classes/Dictionary.xml @@ -33,6 +33,8 @@ </description> </method> <method name="erase"> + <return type="bool"> + </return> <argument index="0" name="key" type="var"> </argument> <description> diff --git a/doc/classes/DirectionalLight.xml b/doc/classes/DirectionalLight.xml index ef75182811..2dc522083d 100644 --- a/doc/classes/DirectionalLight.xml +++ b/doc/classes/DirectionalLight.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="DirectionalLight" inherits="Light" category="Core" version="3.1"> <brief_description> - Directional Light, such as the Sun or the Moon. + Directional light from a distance, as from the Sun. </brief_description> <description> - A DirectionalLight is a type of [Light] node that emits light constantly in one direction (the negative z axis of the node). It is used lights with strong intensity that are located far away from the scene to model sunlight or moonlight. The worldspace location of the DirectionalLight transform (origin) is ignored, only the basis is used do determine light direction. + A directional light is a type of [Light] node that models an infinite number of parallel rays covering the entire scene. It is used for lights with strong intensity that are located far away from the scene to model sunlight or moonlight. The worldspace location of the DirectionalLight transform (origin) is ignored. Only the basis is used do determine light direction. </description> <tutorials> <link>http://docs.godotengine.org/en/3.0/tutorials/3d/lights_and_shadows.html</link> @@ -15,34 +15,48 @@ </methods> <members> <member name="directional_shadow_bias_split_scale" type="float" setter="set_param" getter="get_param"> + Amount of extra bias for shadow splits that are far away. If self shadowing occurs only on the splits far away, this value can fix them. </member> <member name="directional_shadow_blend_splits" type="bool" setter="set_blend_splits" getter="is_blend_splits_enabled"> + If [code]true[/code] shadow detail is sacrificed in exchange for smoother transitions between splits. Default value:[code]false[/code]. </member> <member name="directional_shadow_depth_range" type="int" setter="set_shadow_depth_range" getter="get_shadow_depth_range" enum="DirectionalLight.ShadowDepthRange"> + Optimizes shadow rendering for detail versus movement. See [enum ShadowDepthRange]. </member> <member name="directional_shadow_max_distance" type="float" setter="set_param" getter="get_param"> + The maximum distance for shadow splits. </member> <member name="directional_shadow_mode" type="int" setter="set_shadow_mode" getter="get_shadow_mode" enum="DirectionalLight.ShadowMode"> + The light's shadow rendering algorithm. See [enum ShadowMode]. </member> <member name="directional_shadow_normal_bias" type="float" setter="set_param" getter="get_param"> + Can be used to fix special cases of self shadowing when objects are perpendicular to the light. </member> <member name="directional_shadow_split_1" type="float" setter="set_param" getter="get_param"> + The distance from camera to shadow split 1. Relative to [member directional_shadow_max_distance]. Only used in [enum directional_shadow_mode] SHADOW_PARALLEL_*_SPLITS. </member> <member name="directional_shadow_split_2" type="float" setter="set_param" getter="get_param"> + The distance from shadow split 1 to split 2. Relative to [member directional_shadow_max_distance]. Only used in [enum directional_shadow_mode] SHADOW_PARALLEL_*_SPLITS. </member> <member name="directional_shadow_split_3" type="float" setter="set_param" getter="get_param"> + The distance from shadow split 2 to split 3. Relative to [member directional_shadow_max_distance]. Only used in [enum directional_shadow_mode] SHADOW_PARALLEL_4_SPLITS. </member> </members> <constants> <constant name="SHADOW_ORTHOGONAL" value="0" enum="ShadowMode"> + Renders the entire scene's shadow map from an orthogonal point of view. May result in blockier shadows on close objects. </constant> <constant name="SHADOW_PARALLEL_2_SPLITS" value="1" enum="ShadowMode"> + Splits the view frustum in 2 areas, each with its own shadow map. </constant> <constant name="SHADOW_PARALLEL_4_SPLITS" value="2" enum="ShadowMode"> + Splits the view frustum in 4 areas, each with its own shadow map. </constant> <constant name="SHADOW_DEPTH_RANGE_STABLE" value="0" enum="ShadowDepthRange"> + Keeps the shadow stable when the camera moves, at the cost of lower effective shadow resolution. Default value. </constant> <constant name="SHADOW_DEPTH_RANGE_OPTIMIZED" value="1" enum="ShadowDepthRange"> + Tries to achieve maximum shadow resolution. May result in saw effect on shadow edges. </constant> </constants> </class> diff --git a/doc/classes/EditorFileSystem.xml b/doc/classes/EditorFileSystem.xml index 5a8b506f9e..ade6d2034d 100644 --- a/doc/classes/EditorFileSystem.xml +++ b/doc/classes/EditorFileSystem.xml @@ -93,6 +93,10 @@ Remitted if a resource is reimported. </description> </signal> + <signal name="script_classes_updated"> + <description> + </description> + </signal> <signal name="sources_changed"> <argument index="0" name="exist" type="bool"> </argument> diff --git a/doc/classes/EditorPlugin.xml b/doc/classes/EditorPlugin.xml index f5fbf8e313..62fc56e990 100644 --- a/doc/classes/EditorPlugin.xml +++ b/doc/classes/EditorPlugin.xml @@ -156,15 +156,6 @@ Clear all the state and reset the object being edited to zero. This ensures your plugin does not keep editing a currently existing node, or a node from the wrong scene. </description> </method> - <method name="create_spatial_gizmo" qualifiers="virtual"> - <return type="EditorSpatialGizmo"> - </return> - <argument index="0" name="for_spatial" type="Spatial"> - </argument> - <description> - This is used for plugins that create gizmos used by the spatial editor. Just check that the node passed in the "for_spatial" argument matches your plugin. - </description> - </method> <method name="edit" qualifiers="virtual"> <return type="void"> </return> diff --git a/doc/classes/EditorSpatialGizmo.xml b/doc/classes/EditorSpatialGizmo.xml index 3636442b85..2081ae7a4d 100644 --- a/doc/classes/EditorSpatialGizmo.xml +++ b/doc/classes/EditorSpatialGizmo.xml @@ -33,9 +33,11 @@ </return> <argument index="0" name="handles" type="PoolVector3Array"> </argument> - <argument index="1" name="billboard" type="bool" default="false"> + <argument index="1" name="material" type="Material"> </argument> - <argument index="2" name="secondary" type="bool" default="false"> + <argument index="2" name="billboard" type="bool" default="false"> + </argument> + <argument index="3" name="secondary" type="bool" default="false"> </argument> <description> Add a list of handles (points) which can be used to deform the object being edited. @@ -138,6 +140,14 @@ The [Camera] is also provided so screen coordinates can be converted to raycasts. </description> </method> + <method name="set_hidden"> + <return type="void"> + </return> + <argument index="0" name="hidden" type="bool"> + </argument> + <description> + </description> + </method> <method name="set_spatial_node"> <return type="void"> </return> diff --git a/doc/classes/Expression.xml b/doc/classes/Expression.xml new file mode 100644 index 0000000000..d5b831a61a --- /dev/null +++ b/doc/classes/Expression.xml @@ -0,0 +1,49 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Expression" inherits="Reference" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="execute"> + <return type="Variant"> + </return> + <argument index="0" name="inputs" type="Array" default="[ ]"> + </argument> + <argument index="1" name="base_instance" type="Object" default="null"> + </argument> + <argument index="2" name="show_error" type="bool" default="true"> + </argument> + <description> + </description> + </method> + <method name="get_error_text" qualifiers="const"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="has_execute_failed" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="parse"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="expression" type="String"> + </argument> + <argument index="1" name="input_names" type="PoolStringArray" default="PoolStringArray( )"> + </argument> + <description> + </description> + </method> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/InputEventKey.xml b/doc/classes/InputEventKey.xml index 7503e53188..a013ee6266 100644 --- a/doc/classes/InputEventKey.xml +++ b/doc/classes/InputEventKey.xml @@ -16,6 +16,7 @@ <return type="int"> </return> <description> + Returns the scancode combined with modifier keys such as [code]Shift[/code] or [code]Alt[/code]. See also [InputEventWithModifiers]. </description> </method> </methods> diff --git a/doc/classes/InputMap.xml b/doc/classes/InputMap.xml index 2f5fb49dba..7fd1d7e8ac 100644 --- a/doc/classes/InputMap.xml +++ b/doc/classes/InputMap.xml @@ -40,6 +40,7 @@ <argument index="0" name="action" type="String"> </argument> <description> + Removes all events from an action. </description> </method> <method name="action_has_event"> @@ -50,15 +51,15 @@ <argument index="1" name="event" type="InputEvent"> </argument> <description> - Returns [true] if an action has an [InputEvent] associated with it. + Returns [code]true[/code] if the action has the given [InputEvent] associated with it. </description> </method> <method name="action_set_deadzone"> <return type="void"> </return> - <argument index="0" name="deadzone" type="String"> + <argument index="0" name="action" type="String"> </argument> - <argument index="1" name="arg1" type="float"> + <argument index="1" name="deadzone" type="float"> </argument> <description> </description> @@ -71,7 +72,7 @@ <argument index="1" name="deadzone" type="float" default="0.5"> </argument> <description> - Adds an (empty) action to the [code]InputMap[/code], with a configurable [code]deadzone[/code]. + Adds an empty action to the [code]InputMap[/code] with a configurable [code]deadzone[/code]. An [InputEvent] can then be added to this action with [method action_add_event]. </description> </method> diff --git a/doc/classes/ItemList.xml b/doc/classes/ItemList.xml index 48ca0ddc01..4723cf8ee4 100644 --- a/doc/classes/ItemList.xml +++ b/doc/classes/ItemList.xml @@ -77,6 +77,14 @@ <description> </description> </method> + <method name="get_item_custom_fg_color" qualifiers="const"> + <return type="Color"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + </description> + </method> <method name="get_item_icon" qualifiers="const"> <return type="Texture"> </return> @@ -227,6 +235,16 @@ <description> </description> </method> + <method name="set_item_custom_fg_color"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="custom_fg_color" type="Color"> + </argument> + <description> + </description> + </method> <method name="set_item_disabled"> <return type="void"> </return> diff --git a/doc/classes/KinematicBody.xml b/doc/classes/KinematicBody.xml index e6d537b895..0c66319ae7 100644 --- a/doc/classes/KinematicBody.xml +++ b/doc/classes/KinematicBody.xml @@ -65,8 +65,11 @@ </argument> <argument index="1" name="infinite_inertia" type="bool" default="true"> </argument> + <argument index="2" name="test_only" type="bool" default="false"> + </argument> <description> Moves the body along the vector [code]rel_vec[/code]. The body will stop if it collides. Returns a [KinematicCollision], which contains information about the collision. + If [code]test_only[/code] is [code]true[/true], the body does not move but the would-be collision information is given. </description> </method> <method name="move_and_slide"> @@ -76,7 +79,7 @@ </argument> <argument index="1" name="floor_normal" type="Vector3" default="Vector3( 0, 0, 0 )"> </argument> - <argument index="2" name="slope_stop_min_velocity" type="float" default="0.05"> + <argument index="2" name="stop_on_slope" type="bool" default="false"> </argument> <argument index="3" name="max_slides" type="int" default="4"> </argument> @@ -88,12 +91,32 @@ Moves the body along a vector. If the body collides with another, it will slide along the other body rather than stop immediately. If the other body is a [code]KinematicBody[/code] or [RigidBody], it will also be affected by the motion of the other body. You can use this to make moving or rotating platforms, or to make nodes push other nodes. [code]linear_velocity[/code] is a value in pixels per second. Unlike in for example [method move_and_collide], you should [i]not[/i] multiply it with [code]delta[/code] — this is done by the method. [code]floor_normal[/code] is the up direction, used to determine what is a wall and what is a floor or a ceiling. If set to the default value of [code]Vector3(0, 0, 0)[/code], everything is considered a wall. This is useful for topdown games. - If the body is standing on a slope and the horizontal speed (relative to the floor's speed) goes below [code]slope_stop_min_velocity[/code], the body will stop completely. This prevents the body from sliding down slopes when you include gravity in [code]linear_velocity[/code]. When set to lower values, the body will not be able to stand still on steep slopes. + [i]TODO: Update for new stop_on_slode argument.[/i] If the body is standing on a slope and the horizontal speed (relative to the floor's speed) goes below [code]slope_stop_min_velocity[/code], the body will stop completely. This prevents the body from sliding down slopes when you include gravity in [code]linear_velocity[/code]. When set to lower values, the body will not be able to stand still on steep slopes. If the body collides, it will change direction a maximum of [code]max_slides[/code] times before it stops. [code]floor_max_angle[/code] is the maximum angle (in radians) where a slope is still considered a floor (or a ceiling), rather than a wall. The default value equals 45 degrees. Returns the movement that remained when the body stopped. To get more detailed information about collisions that occurred, use [method get_slide_collision]. </description> </method> + <method name="move_and_slide_with_snap"> + <return type="Vector3"> + </return> + <argument index="0" name="linear_velocity" type="Vector3"> + </argument> + <argument index="1" name="snap" type="Vector3"> + </argument> + <argument index="2" name="floor_normal" type="Vector3" default="Vector3( 0, 0, 0 )"> + </argument> + <argument index="3" name="infinite_inertia" type="bool" default="true"> + </argument> + <argument index="4" name="stop_on_slope" type="bool" default="false"> + </argument> + <argument index="5" name="max_bounces" type="int" default="4"> + </argument> + <argument index="6" name="floor_max_angle" type="float" default="0.785398"> + </argument> + <description> + </description> + </method> <method name="test_move"> <return type="bool"> </return> @@ -109,20 +132,14 @@ </method> </methods> <members> - <member name="axis_lock_angular_x" type="bool" setter="set_axis_lock" getter="get_axis_lock"> - </member> - <member name="axis_lock_angular_y" type="bool" setter="set_axis_lock" getter="get_axis_lock"> - </member> - <member name="axis_lock_angular_z" type="bool" setter="set_axis_lock" getter="get_axis_lock"> - </member> - <member name="axis_lock_linear_x" type="bool" setter="set_axis_lock" getter="get_axis_lock"> + <member name="collision/safe_margin" type="float" setter="set_safe_margin" getter="get_safe_margin"> + If the body is at least this close to another body, this body will consider them to be colliding. </member> - <member name="axis_lock_linear_y" type="bool" setter="set_axis_lock" getter="get_axis_lock"> + <member name="move_lock_x" type="bool" setter="set_axis_lock" getter="get_axis_lock"> </member> - <member name="axis_lock_linear_z" type="bool" setter="set_axis_lock" getter="get_axis_lock"> + <member name="move_lock_y" type="bool" setter="set_axis_lock" getter="get_axis_lock"> </member> - <member name="collision/safe_margin" type="float" setter="set_safe_margin" getter="get_safe_margin"> - If the body is at least this close to another body, this body will consider them to be colliding. + <member name="move_lock_z" type="bool" setter="set_axis_lock" getter="get_axis_lock"> </member> </members> <constants> diff --git a/doc/classes/KinematicBody2D.xml b/doc/classes/KinematicBody2D.xml index fdc974630f..e48660a889 100644 --- a/doc/classes/KinematicBody2D.xml +++ b/doc/classes/KinematicBody2D.xml @@ -81,7 +81,7 @@ </argument> <argument index="2" name="infinite_inertia" type="bool" default="true"> </argument> - <argument index="3" name="slope_stop_min_velocity" type="float" default="5"> + <argument index="3" name="stop_on_slope" type="bool" default="false"> </argument> <argument index="4" name="max_bounces" type="int" default="4"> </argument> @@ -91,7 +91,7 @@ Moves the body along a vector. If the body collides with another, it will slide along the other body rather than stop immediately. If the other body is a [code]KinematicBody2D[/code] or [RigidBody2D], it will also be affected by the motion of the other body. You can use this to make moving or rotating platforms, or to make nodes push other nodes. [code]linear_velocity[/code] is a value in pixels per second. Unlike in for example [method move_and_collide], you should [i]not[/i] multiply it with [code]delta[/code] — this is done by the method. [code]floor_normal[/code] is the up direction, used to determine what is a wall and what is a floor or a ceiling. If set to the default value of [code]Vector2(0, 0)[/code], everything is considered a wall. This is useful for topdown games. - If the body is standing on a slope and the horizontal speed (relative to the floor's speed) goes below [code]slope_stop_min_velocity[/code], the body will stop completely. This prevents the body from sliding down slopes when you include gravity in [code]linear_velocity[/code]. When set to lower values, the body will not be able to stand still on steep slopes. + [i]TODO: Update for stop_on_slope argument.[/i] If the body is standing on a slope and the horizontal speed (relative to the floor's speed) goes below [code]slope_stop_min_velocity[/code], the body will stop completely. This prevents the body from sliding down slopes when you include gravity in [code]linear_velocity[/code]. When set to lower values, the body will not be able to stand still on steep slopes. If the body collides, it will change direction a maximum of [code]max_bounces[/code] times before it stops. [code]floor_max_angle[/code] is the maximum angle (in radians) where a slope is still considered a floor (or a ceiling), rather than a wall. The default value equals 45 degrees. Returns the movement that remained when the body stopped. To get more detailed information about collisions that occurred, use [method get_slide_collision]. @@ -108,13 +108,15 @@ </argument> <argument index="3" name="infinite_inertia" type="bool" default="true"> </argument> - <argument index="4" name="slope_stop_min_velocity" type="float" default="5"> + <argument index="4" name="stop_on_slope" type="bool" default="false"> </argument> <argument index="5" name="max_bounces" type="int" default="4"> </argument> <argument index="6" name="floor_max_angle" type="float" default="0.785398"> </argument> <description> + Moves the body while keeping it attached to slopes. Similar to [method move_and_slide]. + As long as the [code]snap[/code] vector is in contact with the ground, the body will remain attached to the surface. This means you must disable snap in order to jump, for example. You can do this by setting[code]snap[/code] to[code](0, 0)[/code] or by using [method move_and_slide] instead. </description> </method> <method name="test_move"> @@ -136,6 +138,7 @@ If the body is at least this close to another body, this body will consider them to be colliding. </member> <member name="motion/sync_to_physics" type="bool" setter="set_sync_to_physics" getter="is_sync_to_physics_enabled"> + If [code]true[/code] the body's movement will be synchronized to the physics frame. This is useful when animating movement via [AnimationPlayer], for example on moving platforms. </member> </members> <constants> diff --git a/doc/classes/Light.xml b/doc/classes/Light.xml index e9b36c2f9d..04191136a8 100644 --- a/doc/classes/Light.xml +++ b/doc/classes/Light.xml @@ -15,28 +15,40 @@ </methods> <members> <member name="editor_only" type="bool" setter="set_editor_only" getter="is_editor_only"> + If [code]true[/code] the light only appears in the editor and will not be visible at runtime. Default value:[code]false[/code]. </member> <member name="light_bake_mode" type="int" setter="set_bake_mode" getter="get_bake_mode" enum="Light.BakeMode"> + The light's bake mode. See [enum BakeMode]. </member> <member name="light_color" type="Color" setter="set_color" getter="get_color"> + The light's color. </member> <member name="light_cull_mask" type="int" setter="set_cull_mask" getter="get_cull_mask"> + The light will affect objects in the selected layers. </member> <member name="light_energy" type="float" setter="set_param" getter="get_param"> + The light's strength multiplier. </member> <member name="light_indirect_energy" type="float" setter="set_param" getter="get_param"> + Secondary multiplier used with indirect light (light bounces). This works in baked light or GIProbe. </member> <member name="light_negative" type="bool" setter="set_negative" getter="is_negative"> + If [code]true[/code] the light's effect is reversed, darkening areas and casting bright shadows. Default value: [code]false[/code]. </member> <member name="light_specular" type="float" setter="set_param" getter="get_param"> + The intensity of the specular blob in objects affected by the light. At [code]0[/code] the light becomes a pure diffuse light. </member> <member name="shadow_bias" type="float" setter="set_param" getter="get_param"> + Used to adjust shadow appearance. Too small a value results in self shadowing, while too large a value causes shadows to separate from casters. Adjust as needed. </member> <member name="shadow_color" type="Color" setter="set_shadow_color" getter="get_shadow_color"> + The color of shadows cast by this light. </member> <member name="shadow_contact" type="float" setter="set_param" getter="get_param"> + Attempts to reduce [member shadow_bias] gap. </member> <member name="shadow_enabled" type="bool" setter="set_shadow" getter="has_shadow"> + If [code]true[/code] the light will cast shadows. Default value: [code]false[/code]. </member> <member name="shadow_reverse_cull_face" type="bool" setter="set_shadow_reverse_cull_face" getter="get_shadow_reverse_cull_face"> </member> @@ -75,10 +87,13 @@ <constant name="PARAM_MAX" value="15" enum="Param"> </constant> <constant name="BAKE_DISABLED" value="0" enum="BakeMode"> + Light is ignored when baking. Note: hiding a light does [i]not[/i] affect baking. </constant> <constant name="BAKE_INDIRECT" value="1" enum="BakeMode"> + Only indirect lighting will be baked. Default value. </constant> <constant name="BAKE_ALL" value="2" enum="BakeMode"> + Both direct and indirect light will be baked. Note: you should hide the light if you don't want it to appear twice (dynamic and baked). </constant> </constants> </class> diff --git a/doc/classes/LineEdit.xml b/doc/classes/LineEdit.xml index d7a0385bb3..c244b8b7a7 100644 --- a/doc/classes/LineEdit.xml +++ b/doc/classes/LineEdit.xml @@ -88,6 +88,8 @@ <member name="caret_position" type="int" setter="set_cursor_position" getter="get_cursor_position"> The cursor's position inside the [code]LineEdit[/code]. When set, the text may scroll to accommodate it. </member> + <member name="clear_button_enabled" type="bool" setter="set_clear_button_enabled" getter="is_clear_button_enabled"> + </member> <member name="context_menu_enabled" type="bool" setter="set_context_menu_enabled" getter="is_context_menu_enabled"> If [code]true[/code] the context menu will appear when right clicked. </member> @@ -172,6 +174,12 @@ </constant> </constants> <theme_items> + <theme_item name="clear" type="Texture"> + </theme_item> + <theme_item name="clear_button_color" type="Color"> + </theme_item> + <theme_item name="clear_button_color_pressed" type="Color"> + </theme_item> <theme_item name="cursor_color" type="Color"> </theme_item> <theme_item name="focus" type="StyleBox"> diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml index bfef3c8588..d02e3dfdfa 100644 --- a/doc/classes/Node.xml +++ b/doc/classes/Node.xml @@ -38,6 +38,12 @@ Corresponds to the NOTIFICATION_EXIT_TREE notification in [method Object._notification] and signal [signal tree_exiting]. To get notified when the node has already left the active tree, connect to the [signal tree_exited] </description> </method> + <method name="_get_configuration_warning" qualifiers="virtual"> + <return type="String"> + </return> + <description> + </description> + </method> <method name="_input" qualifiers="virtual"> <return type="void"> </return> diff --git a/doc/classes/Object.xml b/doc/classes/Object.xml index a830468042..f4ad196ad2 100644 --- a/doc/classes/Object.xml +++ b/doc/classes/Object.xml @@ -420,5 +420,7 @@ <constant name="CONNECT_ONESHOT" value="4" enum="ConnectFlags"> One shot connections disconnect themselves after emission. </constant> + <constant name="CONNECT_REFERENCE_COUNTED" value="8" enum="ConnectFlags"> + </constant> </constants> </class> diff --git a/doc/classes/OmniLight.xml b/doc/classes/OmniLight.xml index ff2e77ffbe..5ed058bb06 100644 --- a/doc/classes/OmniLight.xml +++ b/doc/classes/OmniLight.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="OmniLight" inherits="Light" category="Core" version="3.1"> <brief_description> - OmniDirectional Light, such as a light bulb or a candle. + Omnidirectional light, such as a light bulb or a candle. </brief_description> <description> - An OmniDirectional light is a type of [Light] node that emits lights in all directions. The light is attenuated through the distance and this attenuation can be configured by changing the energy, radius and attenuation parameters of [Light]. + An Omnidirectional light is a type of [Light] that emits light in all directions. The light is attenuated by distance and this attenuation can be configured by changing its energy, radius, and attenuation parameters. </description> <tutorials> <link>http://docs.godotengine.org/en/3.0/tutorials/3d/lights_and_shadows.html</link> @@ -15,12 +15,16 @@ </methods> <members> <member name="omni_attenuation" type="float" setter="set_param" getter="get_param"> + The light's attenuation (drop-off) curve. A number of presets are available in the Inspector. </member> <member name="omni_range" type="float" setter="set_param" getter="get_param"> + Maximum distance the light affects. </member> <member name="omni_shadow_detail" type="int" setter="set_shadow_detail" getter="get_shadow_detail" enum="OmniLight.ShadowDetail"> + See [enum ShadowDetail]. </member> <member name="omni_shadow_mode" type="int" setter="set_shadow_mode" getter="get_shadow_mode" enum="OmniLight.ShadowMode"> + See [enum ShadowMode]. </member> </members> <constants> diff --git a/doc/classes/PhysicalBone.xml b/doc/classes/PhysicalBone.xml index 99f551b865..5eb4550e93 100644 --- a/doc/classes/PhysicalBone.xml +++ b/doc/classes/PhysicalBone.xml @@ -9,6 +9,12 @@ <demos> </demos> <methods> + <method name="get_bone_id" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> <method name="get_simulate_physics"> <return type="bool"> </return> diff --git a/doc/classes/PhysicsDirectBodyState.xml b/doc/classes/PhysicsDirectBodyState.xml index 5117c9ef6c..91fc4df4ff 100644 --- a/doc/classes/PhysicsDirectBodyState.xml +++ b/doc/classes/PhysicsDirectBodyState.xml @@ -121,7 +121,7 @@ <argument index="0" name="contact_idx" type="int"> </argument> <description> - Impulse created by the contact. Only implemented for Bullet physics. + Impulse created by the contact. Only implemented for Bullet physics. </description> </method> <method name="get_contact_local_normal" qualifiers="const"> diff --git a/doc/classes/PhysicsMaterial.xml b/doc/classes/PhysicsMaterial.xml index 5512c4605a..bfebb472a5 100644 --- a/doc/classes/PhysicsMaterial.xml +++ b/doc/classes/PhysicsMaterial.xml @@ -10,6 +10,16 @@ </demos> <methods> </methods> + <members> + <member name="absorbent" type="bool" setter="set_absorbent" getter="is_absorbent"> + </member> + <member name="bounce" type="float" setter="set_bounce" getter="get_bounce"> + </member> + <member name="friction" type="float" setter="set_friction" getter="get_friction"> + </member> + <member name="rough" type="bool" setter="set_rough" getter="is_rough"> + </member> + </members> <constants> </constants> </class> diff --git a/doc/classes/Plane.xml b/doc/classes/Plane.xml index 6f616401cb..62e4fc5d9d 100644 --- a/doc/classes/Plane.xml +++ b/doc/classes/Plane.xml @@ -157,5 +157,11 @@ </member> </members> <constants> + <constant name="X" value="Plane( 1, 0, 0, 0 )"> + </constant> + <constant name="Y" value="Plane( 0, 1, 0, 0 )"> + </constant> + <constant name="Z" value="Plane( 0, 0, 1, 0 )"> + </constant> </constants> </class> diff --git a/doc/classes/PopupMenu.xml b/doc/classes/PopupMenu.xml index 0c8769714b..fe7dbe52b0 100644 --- a/doc/classes/PopupMenu.xml +++ b/doc/classes/PopupMenu.xml @@ -260,6 +260,12 @@ <description> </description> </method> + <method name="is_hide_on_window_lose_focus" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> <method name="is_item_checkable" qualifiers="const"> <return type="bool"> </return> @@ -322,6 +328,14 @@ Removes the item at index "idx" from the menu. Note that the indexes of items after the removed item are going to be shifted by one. </description> </method> + <method name="set_hide_on_window_lose_focus"> + <return type="void"> + </return> + <argument index="0" name="enable" type="bool"> + </argument> + <description> + </description> + </method> <method name="set_item_accelerator"> <return type="void"> </return> diff --git a/doc/classes/ProgressBar.xml b/doc/classes/ProgressBar.xml index 919ecd7c86..0f03b7b80a 100644 --- a/doc/classes/ProgressBar.xml +++ b/doc/classes/ProgressBar.xml @@ -14,6 +14,7 @@ </methods> <members> <member name="percent_visible" type="bool" setter="set_percent_visible" getter="is_percent_visible"> + If [code]true[/code] the fill percentage is displayed on the bar. Default value: [code]true[/code]. </member> </members> <constants> diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index a4af5509a6..358b7292a5 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -224,6 +224,58 @@ </member> <member name="compression/formats/zstd/window_log_size" type="int" setter="" getter=""> </member> + <member name="debug/gdscript/warnings/constant_used_as_function" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/enable" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/function_conflicts_constant" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/function_conflicts_variable" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/function_may_yield" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/function_used_as_property" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/incompatible_ternary" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/integer_division" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/narrowing_conversion" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/property_used_as_function" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/return_value_discarded" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/standalone_expression" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/treat_warnings_as_errors" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/unassigned_variable" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/unassigned_variable_op_assign" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/unreachable_code" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/unsafe_call_argument" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/unsafe_cast" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/unsafe_method_access" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/unsafe_property_access" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/unused_argument" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/unused_class_variable" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/unused_signal" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/unused_variable" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/variable_conflicts_function" type="bool" setter="" getter=""> + </member> + <member name="debug/gdscript/warnings/void_assignment" type="bool" setter="" getter=""> + </member> <member name="debug/settings/crash_handler/message" type="String" setter="" getter=""> </member> <member name="debug/settings/fps/force_fps" type="int" setter="" getter=""> @@ -315,31 +367,31 @@ <member name="gui/timers/text_edit_idle_detect_sec" type="int" setter="" getter=""> Timer for detecting idle in the editor. </member> - <member name="input/ui_accept" type="Array" setter="" getter=""> + <member name="input/ui_accept" type="Dictionary" setter="" getter=""> </member> - <member name="input/ui_cancel" type="Array" setter="" getter=""> + <member name="input/ui_cancel" type="Dictionary" setter="" getter=""> </member> - <member name="input/ui_down" type="Array" setter="" getter=""> + <member name="input/ui_down" type="Dictionary" setter="" getter=""> </member> - <member name="input/ui_end" type="Array" setter="" getter=""> + <member name="input/ui_end" type="Dictionary" setter="" getter=""> </member> - <member name="input/ui_focus_next" type="Array" setter="" getter=""> + <member name="input/ui_focus_next" type="Dictionary" setter="" getter=""> </member> - <member name="input/ui_focus_prev" type="Array" setter="" getter=""> + <member name="input/ui_focus_prev" type="Dictionary" setter="" getter=""> </member> - <member name="input/ui_home" type="Array" setter="" getter=""> + <member name="input/ui_home" type="Dictionary" setter="" getter=""> </member> - <member name="input/ui_left" type="Array" setter="" getter=""> + <member name="input/ui_left" type="Dictionary" setter="" getter=""> </member> - <member name="input/ui_page_down" type="Array" setter="" getter=""> + <member name="input/ui_page_down" type="Dictionary" setter="" getter=""> </member> - <member name="input/ui_page_up" type="Array" setter="" getter=""> + <member name="input/ui_page_up" type="Dictionary" setter="" getter=""> </member> - <member name="input/ui_right" type="Array" setter="" getter=""> + <member name="input/ui_right" type="Dictionary" setter="" getter=""> </member> - <member name="input/ui_select" type="Array" setter="" getter=""> + <member name="input/ui_select" type="Dictionary" setter="" getter=""> </member> - <member name="input/ui_up" type="Array" setter="" getter=""> + <member name="input/ui_up" type="Dictionary" setter="" getter=""> </member> <member name="input_devices/pointing/emulate_mouse_from_touch" type="bool" setter="" getter=""> </member> diff --git a/doc/classes/Quat.xml b/doc/classes/Quat.xml index c755e6b02a..67631bbc92 100644 --- a/doc/classes/Quat.xml +++ b/doc/classes/Quat.xml @@ -188,5 +188,7 @@ </member> </members> <constants> + <constant name="IDENTITY" value="Quat( 0, 0, 0, 1 )"> + </constant> </constants> </class> diff --git a/doc/classes/Range.xml b/doc/classes/Range.xml index fa7e20eff6..46a6132b94 100644 --- a/doc/classes/Range.xml +++ b/doc/classes/Range.xml @@ -17,30 +17,32 @@ <argument index="0" name="with" type="Node"> </argument> <description> - Binds two Ranges together along with any Ranges previously grouped with either of them. When any of Range's member variables change, it will share the new value with all other Ranges in its group. + Binds two ranges together along with any ranges previously grouped with either of them. When any of range's member variables change, it will share the new value with all other ranges in its group. </description> </method> <method name="unshare"> <return type="void"> </return> <description> - Stop Range from sharing its member variables with any other Range. + Stop range from sharing its member variables with any other. </description> </method> </methods> <members> <member name="allow_greater" type="bool" setter="set_allow_greater" getter="is_greater_allowed"> + If [code]true[/code] [member value] may be greater than [member max_value]. Default value: [code]false[/code]. </member> <member name="allow_lesser" type="bool" setter="set_allow_lesser" getter="is_lesser_allowed"> + If [code]true[/code] [member value] may be less than [member min_value]. Default value: [code]false[/code]. </member> <member name="exp_edit" type="bool" setter="set_exp_ratio" getter="is_ratio_exp"> If [code]true[/code] and [code]min_value[/code] is greater than 0, [code]value[/code] will be represented exponentially rather than linearly. </member> <member name="max_value" type="float" setter="set_max" getter="get_max"> - Maximum value. Range is clamped if [code]value[/code] is greater than [code]max_value[/code]. Default value: 100. + Maximum value. Range is clamped if [code]value[/code] is greater than [code]max_value[/code]. Default value: [code]100[/code]. </member> <member name="min_value" type="float" setter="set_min" getter="get_min"> - Minimum value. Range is clamped if [code]value[/code] is less than [code]min_value[/code]. Default value: 0. + Minimum value. Range is clamped if [code]value[/code] is less than [code]min_value[/code]. Default value: [code]0[/code]. </member> <member name="page" type="float" setter="set_page" getter="get_page"> Page size. Used mainly for [ScrollBar]. ScrollBar's length is its size multiplied by [code]page[/code] over the difference between [code]min_value[/code] and [code]max_value[/code]. @@ -49,7 +51,7 @@ The value mapped between 0 and 1. </member> <member name="rounded" type="bool" setter="set_use_rounded_values" getter="is_using_rounded_values"> - If [code]true[/code], [code]value[/code] will always be rounded to the nearest integer. + If [code]true[/code] [code]value[/code] will always be rounded to the nearest integer. Default value: [code]false[/code]. </member> <member name="step" type="float" setter="set_step" getter="get_step"> If greater than 0, [code]value[/code] will always be rounded to a multiple of [code]step[/code]. If [code]rounded[/code] is also [code]true[/code], [code]value[/code] will first be rounded to a multiple of [code]step[/code] then rounded to the nearest integer. @@ -61,14 +63,14 @@ <signals> <signal name="changed"> <description> - This signal is emitted when min, max, range or step change. + Emitted when [member min_value], [member max_value], [member page], or [member step] change. </description> </signal> <signal name="value_changed"> <argument index="0" name="value" type="float"> </argument> <description> - This signal is emitted when value changes. + Emitted when [member value] changes. </description> </signal> </signals> diff --git a/doc/classes/ReferenceRect.xml b/doc/classes/ReferenceRect.xml index 4c6f014965..e1cb104e40 100644 --- a/doc/classes/ReferenceRect.xml +++ b/doc/classes/ReferenceRect.xml @@ -12,10 +12,10 @@ </demos> <methods> </methods> - <constants> - </constants> <members> <member name="border_color" type="Color" setter="set_border_color" getter="get_border_color"> </member> </members> + <constants> + </constants> </class> diff --git a/doc/classes/ResourceLoader.xml b/doc/classes/ResourceLoader.xml index ac00c13b2f..ae900e34ef 100644 --- a/doc/classes/ResourceLoader.xml +++ b/doc/classes/ResourceLoader.xml @@ -11,6 +11,16 @@ <demos> </demos> <methods> + <method name="exists"> + <return type="bool"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <argument index="1" name="type_hint" type="String" default=""""> + </argument> + <description> + </description> + </method> <method name="get_dependencies"> <return type="PoolStringArray"> </return> @@ -36,6 +46,14 @@ <description> </description> </method> + <method name="has_cached"> + <return type="bool"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + </description> + </method> <method name="load"> <return type="Resource"> </return> diff --git a/doc/classes/Skeleton.xml b/doc/classes/Skeleton.xml index 4d826002fe..233df28255 100644 --- a/doc/classes/Skeleton.xml +++ b/doc/classes/Skeleton.xml @@ -196,6 +196,16 @@ <description> </description> </method> + <method name="set_bone_ignore_animation"> + <return type="void"> + </return> + <argument index="0" name="bone" type="int"> + </argument> + <argument index="1" name="ignore" type="bool"> + </argument> + <description> + </description> + </method> <method name="set_bone_parent"> <return type="void"> </return> diff --git a/doc/classes/Skeleton2D.xml b/doc/classes/Skeleton2D.xml index 654c816ba8..712b9ca2a5 100644 --- a/doc/classes/Skeleton2D.xml +++ b/doc/classes/Skeleton2D.xml @@ -12,7 +12,7 @@ <method name="get_bone"> <return type="Bone2D"> </return> - <argument index="0" name="arg0" type="int"> + <argument index="0" name="idx" type="int"> </argument> <description> </description> diff --git a/doc/classes/SkeletonIK.xml b/doc/classes/SkeletonIK.xml new file mode 100644 index 0000000000..50246f1b18 --- /dev/null +++ b/doc/classes/SkeletonIK.xml @@ -0,0 +1,61 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="SkeletonIK" inherits="Node" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_parent_skeleton" qualifiers="const"> + <return type="Skeleton"> + </return> + <description> + </description> + </method> + <method name="is_running"> + <return type="bool"> + </return> + <description> + </description> + </method> + <method name="start"> + <return type="void"> + </return> + <argument index="0" name="one_time" type="bool" default="false"> + </argument> + <description> + </description> + </method> + <method name="stop"> + <return type="void"> + </return> + <description> + </description> + </method> + </methods> + <members> + <member name="interpolation" type="float" setter="set_interpolation" getter="get_interpolation"> + </member> + <member name="magnet" type="Vector3" setter="set_magnet_position" getter="get_magnet_position"> + </member> + <member name="max_iterations" type="int" setter="set_max_iterations" getter="get_max_iterations"> + </member> + <member name="min_distance" type="float" setter="set_min_distance" getter="get_min_distance"> + </member> + <member name="root_bone" type="String" setter="set_root_bone" getter="get_root_bone"> + </member> + <member name="target" type="Transform" setter="set_target_transform" getter="get_target_transform"> + </member> + <member name="target_node" type="NodePath" setter="set_target_node" getter="get_target_node"> + </member> + <member name="tip_bone" type="String" setter="set_tip_bone" getter="get_tip_bone"> + </member> + <member name="use_magnet" type="bool" setter="set_use_magnet" getter="is_using_magnet"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/SpringArm.xml b/doc/classes/SpringArm.xml new file mode 100644 index 0000000000..198ff4a81d --- /dev/null +++ b/doc/classes/SpringArm.xml @@ -0,0 +1,53 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="SpringArm" inherits="Spatial" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_excluded_object"> + <return type="void"> + </return> + <argument index="0" name="RID" type="RID"> + </argument> + <description> + </description> + </method> + <method name="clear_excluded_objects"> + <return type="void"> + </return> + <description> + </description> + </method> + <method name="get_hit_length"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="remove_excluded_object"> + <return type="bool"> + </return> + <argument index="0" name="RID" type="RID"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="collision_mask" type="int" setter="set_collision_mask" getter="get_collision_mask"> + </member> + <member name="margin" type="float" setter="set_margin" getter="get_margin"> + </member> + <member name="shape" type="Shape" setter="set_shape" getter="get_shape"> + </member> + <member name="spring_length" type="float" setter="set_length" getter="get_length"> + </member> + </members> + <constants> + </constants> +</class> diff --git a/doc/classes/Tabs.xml b/doc/classes/Tabs.xml index 0d5f1f0ba9..fc1d0476ed 100644 --- a/doc/classes/Tabs.xml +++ b/doc/classes/Tabs.xml @@ -35,6 +35,12 @@ <description> </description> </method> + <method name="get_select_with_rmb" qualifiers="const"> + <return type="bool"> + </return> + <description> + </description> + </method> <method name="get_tab_count" qualifiers="const"> <return type="int"> </return> @@ -105,6 +111,14 @@ <description> </description> </method> + <method name="set_select_with_rmb"> + <return type="void"> + </return> + <argument index="0" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> <method name="set_tab_disabled"> <return type="void"> </return> diff --git a/doc/classes/Texture.xml b/doc/classes/Texture.xml index eb7cfac87b..a9be42d1a1 100644 --- a/doc/classes/Texture.xml +++ b/doc/classes/Texture.xml @@ -128,7 +128,7 @@ <constant name="FLAG_MIRRORED_REPEAT" value="32" enum="Flags"> Repeats texture with alternate sections mirrored. </constant> - <constant name="FLAG_VIDEO_SURFACE" value="4096" enum="Flags"> + <constant name="FLAG_VIDEO_SURFACE" value="2048" enum="Flags"> Texture is a video surface. </constant> </constants> diff --git a/doc/classes/Texture3D.xml b/doc/classes/Texture3D.xml new file mode 100644 index 0000000000..691d1f229e --- /dev/null +++ b/doc/classes/Texture3D.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Texture3D" inherits="TextureLayered" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/TextureArray.xml b/doc/classes/TextureArray.xml new file mode 100644 index 0000000000..a08d8421f1 --- /dev/null +++ b/doc/classes/TextureArray.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="TextureArray" inherits="TextureLayered" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + </methods> + <constants> + </constants> +</class> diff --git a/doc/classes/TextureLayered.xml b/doc/classes/TextureLayered.xml new file mode 100644 index 0000000000..026144cf5a --- /dev/null +++ b/doc/classes/TextureLayered.xml @@ -0,0 +1,103 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="TextureLayered" inherits="Resource" category="Core" version="3.1"> + <brief_description> + </brief_description> + <description> + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="create"> + <return type="void"> + </return> + <argument index="0" name="width" type="int"> + </argument> + <argument index="1" name="height" type="int"> + </argument> + <argument index="2" name="depth" type="int"> + </argument> + <argument index="3" name="format" type="int" enum="Image.Format"> + </argument> + <argument index="4" name="flags" type="int" default="4"> + </argument> + <description> + </description> + </method> + <method name="get_depth" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_format" qualifiers="const"> + <return type="int" enum="Image.Format"> + </return> + <description> + </description> + </method> + <method name="get_height" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_layer_data" qualifiers="const"> + <return type="Image"> + </return> + <argument index="0" name="layer" type="int"> + </argument> + <description> + </description> + </method> + <method name="get_width" qualifiers="const"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="set_data_partial"> + <return type="void"> + </return> + <argument index="0" name="image" type="Image"> + </argument> + <argument index="1" name="x_offset" type="int"> + </argument> + <argument index="2" name="y_offset" type="int"> + </argument> + <argument index="3" name="layer" type="int"> + </argument> + <argument index="4" name="mipmap" type="int" default="0"> + </argument> + <description> + </description> + </method> + <method name="set_layer_data"> + <return type="void"> + </return> + <argument index="0" name="image" type="Image"> + </argument> + <argument index="1" name="layer" type="int"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="data" type="Dictionary" setter="_set_data" getter="_get_data"> + </member> + <member name="flags" type="int" setter="set_flags" getter="get_flags"> + </member> + </members> + <constants> + <constant name="FLAG_MIPMAPS" value="1" enum="Flags"> + </constant> + <constant name="FLAG_REPEAT" value="2" enum="Flags"> + </constant> + <constant name="FLAG_FILTER" value="4" enum="Flags"> + </constant> + <constant name="FLAGS_DEFAULT" value="4" enum="Flags"> + </constant> + </constants> +</class> diff --git a/doc/classes/TileSet.xml b/doc/classes/TileSet.xml index 7121bc8b9c..56bb33c5e1 100644 --- a/doc/classes/TileSet.xml +++ b/doc/classes/TileSet.xml @@ -58,7 +58,7 @@ <return type="void"> </return> <description> - Clear all tiles. + Clears all tiles. </description> </method> <method name="create_tile"> @@ -67,7 +67,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Create a new tile which will be referenced by the given ID. + Creates a new tile which will be referenced by the given ID. </description> </method> <method name="find_tile_by_name" qualifiers="const"> @@ -76,21 +76,21 @@ <argument index="0" name="name" type="String"> </argument> <description> - Find the first tile matching the given name. + Returns the first tile matching the given name. </description> </method> <method name="get_last_unused_tile_id" qualifiers="const"> <return type="int"> </return> <description> - Return the ID following the last currently used ID, useful when creating a new tile. + Returns the ID following the last currently used ID, useful when creating a new tile. </description> </method> <method name="get_tiles_ids" qualifiers="const"> <return type="Array"> </return> <description> - Return an array of all currently used tile IDs. + Returns an array of all currently used tile IDs. </description> </method> <method name="remove_tile"> @@ -99,7 +99,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Remove the tile referenced by the given ID. + Removes the tile referenced by the given ID. </description> </method> <method name="tile_add_shape"> @@ -124,7 +124,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Return the light occluder of the tile. + Returns the light occluder of the tile. </description> </method> <method name="tile_get_material" qualifiers="const"> @@ -133,7 +133,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Return the material of the tile. + Returns the material of the tile. </description> </method> <method name="tile_get_modulate" qualifiers="const"> @@ -150,7 +150,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Return the name of the tile. + Returns the name of the tile. </description> </method> <method name="tile_get_navigation_polygon" qualifiers="const"> @@ -159,7 +159,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Return the navigation polygon of the tile. + Returns the navigation polygon of the tile. </description> </method> <method name="tile_get_navigation_polygon_offset" qualifiers="const"> @@ -168,7 +168,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Return the offset of the tile's navigation polygon. + Returns the offset of the tile's navigation polygon. </description> </method> <method name="tile_get_normal_map" qualifiers="const"> @@ -185,7 +185,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Return the offset of the tile's light occluder. + Returns the offset of the tile's light occluder. </description> </method> <method name="tile_get_region" qualifiers="const"> @@ -194,7 +194,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Return the tile sub-region in the texture. + Returns the tile sub-region in the texture. </description> </method> <method name="tile_get_shape" qualifiers="const"> @@ -241,7 +241,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Return the array of shapes of the tile. + Returns the array of shapes of the tile. </description> </method> <method name="tile_get_texture" qualifiers="const"> @@ -250,7 +250,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Return the texture of the tile. + Returns the texture of the tile. </description> </method> <method name="tile_get_texture_offset" qualifiers="const"> @@ -259,7 +259,7 @@ <argument index="0" name="id" type="int"> </argument> <description> - Return the texture offset of the tile. + Returns the texture offset of the tile. </description> </method> <method name="tile_get_tile_mode" qualifiers="const"> @@ -286,7 +286,7 @@ <argument index="1" name="light_occluder" type="OccluderPolygon2D"> </argument> <description> - Set a light occluder for the tile. + Sets a light occluder for the tile. </description> </method> <method name="tile_set_material"> @@ -297,7 +297,7 @@ <argument index="1" name="material" type="ShaderMaterial"> </argument> <description> - Set the material of the tile. + Sets the tile's material. </description> </method> <method name="tile_set_modulate"> @@ -308,6 +308,7 @@ <argument index="1" name="color" type="Color"> </argument> <description> + Sets the tile's modulation color. </description> </method> <method name="tile_set_name"> @@ -318,7 +319,7 @@ <argument index="1" name="name" type="String"> </argument> <description> - Set the name of the tile, for descriptive purposes. + Sets the tile's name. </description> </method> <method name="tile_set_navigation_polygon"> @@ -329,7 +330,7 @@ <argument index="1" name="navigation_polygon" type="NavigationPolygon"> </argument> <description> - Set a navigation polygon for the tile. + Sets the tile's navigation polygon. </description> </method> <method name="tile_set_navigation_polygon_offset"> @@ -340,7 +341,7 @@ <argument index="1" name="navigation_polygon_offset" type="Vector2"> </argument> <description> - Set an offset for the tile's navigation polygon. + Sets an offset for the tile's navigation polygon. </description> </method> <method name="tile_set_normal_map"> @@ -351,6 +352,7 @@ <argument index="1" name="normal_map" type="Texture"> </argument> <description> + Sets the tile's normal map texture. </description> </method> <method name="tile_set_occluder_offset"> @@ -372,7 +374,7 @@ <argument index="1" name="region" type="Rect2"> </argument> <description> - Set the tile sub-region in the texture. This is common in texture atlases. + Set the tile's sub-region in the texture. This is common in texture atlases. </description> </method> <method name="tile_set_shape"> @@ -419,7 +421,7 @@ <argument index="1" name="shapes" type="Array"> </argument> <description> - Set an array of shapes for the tile, enabling physics to collide with it. + Sets an array of shapes for the tile, enabling collision. </description> </method> <method name="tile_set_texture"> @@ -430,7 +432,7 @@ <argument index="1" name="texture" type="Texture"> </argument> <description> - Set the texture of the tile. + Sets the tile's texture. </description> </method> <method name="tile_set_texture_offset"> @@ -441,7 +443,7 @@ <argument index="1" name="texture_offset" type="Vector2"> </argument> <description> - Set the texture offset of the tile. + Sets the tile's texture offset. </description> </method> <method name="tile_set_tile_mode"> @@ -452,6 +454,7 @@ <argument index="1" name="tilemode" type="int" enum="TileSet.TileMode"> </argument> <description> + Sets the tile's [enum TileMode]. </description> </method> <method name="tile_set_z_index"> @@ -462,6 +465,7 @@ <argument index="1" name="z_index" type="int"> </argument> <description> + Sets the tile's drawing index. </description> </method> </methods> @@ -492,7 +496,7 @@ </constant> <constant name="AUTO_TILE" value="1" enum="TileMode"> </constant> - <constant name="ANIMATED_TILE" value="2" enum="TileMode"> + <constant name="ATLAS_TILE" value="2" enum="TileMode"> </constant> </constants> </class> diff --git a/doc/classes/Transform.xml b/doc/classes/Transform.xml index 0dd8038b36..24c009d922 100644 --- a/doc/classes/Transform.xml +++ b/doc/classes/Transform.xml @@ -168,5 +168,13 @@ </member> </members> <constants> + <constant name="IDENTITY" value="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )"> + </constant> + <constant name="FLIP_X" value="Transform( -1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )"> + </constant> + <constant name="FLIP_Y" value="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )"> + </constant> + <constant name="FLIP_Z" value="Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )"> + </constant> </constants> </class> diff --git a/doc/classes/Transform2D.xml b/doc/classes/Transform2D.xml index d5427ad7f8..b38d9a1a86 100644 --- a/doc/classes/Transform2D.xml +++ b/doc/classes/Transform2D.xml @@ -173,5 +173,11 @@ </member> </members> <constants> + <constant name="IDENTITY" value="Transform2D( 1, 0, 0, 1, 0, 0 )"> + </constant> + <constant name="FLIP_X" value="Transform2D( -1, 0, 0, 1, 0, 0 )"> + </constant> + <constant name="FLIP_Y" value="Transform2D( 1, 0, 0, -1, 0, 0 )"> + </constant> </constants> </class> diff --git a/doc/classes/Vector2.xml b/doc/classes/Vector2.xml index 9b18962a6f..4bc18b926e 100644 --- a/doc/classes/Vector2.xml +++ b/doc/classes/Vector2.xml @@ -130,15 +130,6 @@ Returns the distance to vector [code]b[/code]. </description> </method> - <method name="project"> - <return type="Vector2"> - </return> - <argument index="0" name="b" type="Vector2"> - </argument> - <description> - Returns the vector projected onto the vector [code]b[/code]. - </description> - </method> <method name="dot"> <return type="float"> </return> @@ -194,6 +185,15 @@ Returns the vector scaled to unit length. Equivalent to [code]v / v.length()[/code]. </description> </method> + <method name="project"> + <return type="Vector2"> + </return> + <argument index="0" name="b" type="Vector2"> + </argument> + <description> + Returns the vector projected onto the vector [code]b[/code]. + </description> + </method> <method name="reflect"> <return type="Vector2"> </return> @@ -266,5 +266,17 @@ </member> </members> <constants> + <constant name="ZERO" value="Vector2( 0, 0 )"> + </constant> + <constant name="INF" value="Vector2( inf, inf )"> + </constant> + <constant name="LEFT" value="Vector2( -1, 0 )"> + </constant> + <constant name="RIGHT" value="Vector2( 1, 0 )"> + </constant> + <constant name="UP" value="Vector2( 0, -1 )"> + </constant> + <constant name="DOWN" value="Vector2( 0, 1 )"> + </constant> </constants> </class> diff --git a/doc/classes/Vector3.xml b/doc/classes/Vector3.xml index 22384c5012..b4dcc6c6aa 100644 --- a/doc/classes/Vector3.xml +++ b/doc/classes/Vector3.xml @@ -99,15 +99,6 @@ Returns the distance to [code]b[/code]. </description> </method> - <method name="project_onto"> - <return type="Vector3"> - </return> - <argument index="0" name="b" type="Vector3"> - </argument> - <description> - Returns the vector projected onto the vector [code]b[/code]. - </description> - </method> <method name="dot"> <return type="float"> </return> @@ -193,6 +184,15 @@ Returns the outer product with [code]b[/code]. </description> </method> + <method name="project"> + <return type="Vector3"> + </return> + <argument index="0" name="b" type="Vector3"> + </argument> + <description> + Returns the vector projected onto the vector [code]b[/code]. + </description> + </method> <method name="reflect"> <return type="Vector3"> </return> @@ -279,5 +279,21 @@ <constant name="AXIS_Z" value="2"> Enumerated value for the Z axis. </constant> + <constant name="ZERO" value="Vector3( 0, 0, 0 )"> + </constant> + <constant name="INF" value="Vector3( inf, inf, inf )"> + </constant> + <constant name="LEFT" value="Vector3( -1, 0, 0 )"> + </constant> + <constant name="RIGHT" value="Vector3( 1, 0, 0 )"> + </constant> + <constant name="UP" value="Vector3( 0, 1, 0 )"> + </constant> + <constant name="DOWN" value="Vector3( 0, -1, 0 )"> + </constant> + <constant name="FORWARD" value="Vector3( 0, 0, -1 )"> + </constant> + <constant name="BACK" value="Vector3( 0, 0, 1 )"> + </constant> </constants> </class> diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml index af0712d357..05649193a6 100644 --- a/doc/classes/Viewport.xml +++ b/doc/classes/Viewport.xml @@ -22,35 +22,35 @@ <return type="World"> </return> <description> - Return the 3D world of the viewport, or if no such present, the one of the parent viewport. + Returns the 3D world of the viewport, or if none the world of the parent viewport. </description> </method> <method name="find_world_2d" qualifiers="const"> <return type="World2D"> </return> <description> - Return the 2D world of the viewport. + Returns the 2D world of the viewport. </description> </method> <method name="get_camera" qualifiers="const"> <return type="Camera"> </return> <description> - Return the active 3D camera. + Returns the active 3D camera. </description> </method> <method name="get_final_transform" qualifiers="const"> <return type="Transform2D"> </return> <description> - Get the total transform of the viewport. + Returns the total transform of the viewport. </description> </method> <method name="get_mouse_position" qualifiers="const"> <return type="Vector2"> </return> <description> - Get the mouse position, relative to the viewport. + Returns the mouse position relative to the viewport. </description> </method> <method name="get_render_info"> @@ -59,35 +59,35 @@ <argument index="0" name="info" type="int" enum="Viewport.RenderInfo"> </argument> <description> - Get the specific information about the viewport from rendering pipeline. + Returns information about the viewport from the rendering pipeline. </description> </method> <method name="get_size_override" qualifiers="const"> <return type="Vector2"> </return> <description> - Get the size override set with [method set_size_override]. + Returns the size override set with [method set_size_override]. </description> </method> <method name="get_texture" qualifiers="const"> <return type="ViewportTexture"> </return> <description> - Get the viewport's texture, for use with various objects that you want to texture with the viewport. + Returns the viewport's texture. </description> </method> <method name="get_viewport_rid" qualifiers="const"> <return type="RID"> </return> <description> - Get the viewport RID from the [VisualServer]. + Returns the viewport's RID from the [VisualServer]. </description> </method> <method name="get_visible_rect" qualifiers="const"> <return type="Rect2"> </return> <description> - Return the final, visible rect in global screen coordinates. + Returns the visible rectangle in global screen coordinates. </description> </method> <method name="gui_get_drag_data" qualifiers="const"> @@ -101,7 +101,7 @@ <return type="bool"> </return> <description> - Returns whether there are shown modals on-screen. + Returns [code]true[/code] if there are visible modals on-screen. </description> </method> <method name="input"> @@ -116,14 +116,14 @@ <return type="bool"> </return> <description> - Get the enabled status of the size override set with [method set_size_override]. + Returns [code]true[/code] if the size override is enabled. See [method set_size_override]. </description> </method> <method name="is_size_override_stretch_enabled" qualifiers="const"> <return type="bool"> </return> <description> - Get the enabled status of the size stretch override set with [method set_size_override_stretch]. + Returns [code]true[/code] if the size stretch override is enabled. See [method set_size_override_stretch]. </description> </method> <method name="set_attach_to_screen_rect"> @@ -144,7 +144,7 @@ <argument index="2" name="margin" type="Vector2" default="Vector2( 0, 0 )"> </argument> <description> - Set the size override of the viewport. If the enable parameter is true, it would use the override, otherwise it would use the default size. If the size parameter is equal to [code](-1, -1)[/code], it won't update the size. + Sets the size override of the viewport. If the [code]enable[/code] parameter is [code]true[/code] the override is used, otherwise it uses the default size. If the size parameter is [code](-1, -1)[/code], it won't update the size. </description> </method> <method name="set_size_override_stretch"> @@ -153,7 +153,7 @@ <argument index="0" name="enabled" type="bool"> </argument> <description> - Set whether the size override affects stretch as well. + If [code]true[/code] the size override affects stretch as well. </description> </method> <method name="unhandled_input"> @@ -168,7 +168,7 @@ <return type="void"> </return> <description> - Force update of the 2D and 3D worlds. + Forces update of the 2D and 3D worlds. </description> </method> <method name="warp_mouse"> @@ -177,7 +177,7 @@ <argument index="0" name="to_position" type="Vector2"> </argument> <description> - Warp the mouse to a position, relative to the viewport. + Warps the mouse to a position relative to the viewport. </description> </method> </methods> diff --git a/doc/classes/VisualInstance.xml b/doc/classes/VisualInstance.xml index 502209fac5..30dedb06f4 100644 --- a/doc/classes/VisualInstance.xml +++ b/doc/classes/VisualInstance.xml @@ -16,6 +16,14 @@ Returns the [AABB] (also known as the bounding box) for this VisualInstance. </description> </method> + <method name="get_layer_mask_bit" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="layer" type="int"> + </argument> + <description> + </description> + </method> <method name="get_transformed_aabb" qualifiers="const"> <return type="AABB"> </return> @@ -34,6 +42,16 @@ It is recommended to only use set_base if you know what you're doing. </description> </method> + <method name="set_layer_mask_bit"> + <return type="void"> + </return> + <argument index="0" name="layer" type="int"> + </argument> + <argument index="1" name="enabled" type="bool"> + </argument> + <description> + </description> + </method> </methods> <members> <member name="layers" type="int" setter="set_layer_mask" getter="get_layer_mask"> diff --git a/doc/classes/VisualServer.xml b/doc/classes/VisualServer.xml index c4ebf7c96f..395fb9e829 100644 --- a/doc/classes/VisualServer.xml +++ b/doc/classes/VisualServer.xml @@ -1336,7 +1336,7 @@ <method name="gi_probe_get_bias" qualifiers="const"> <return type="float"> </return> - <argument index="0" name="arg0" type="RID"> + <argument index="0" name="probe" type="RID"> </argument> <description> </description> @@ -1360,7 +1360,7 @@ <method name="gi_probe_get_dynamic_data" qualifiers="const"> <return type="PoolIntArray"> </return> - <argument index="0" name="arg0" type="RID"> + <argument index="0" name="probe" type="RID"> </argument> <description> </description> @@ -1368,7 +1368,7 @@ <method name="gi_probe_get_dynamic_range" qualifiers="const"> <return type="int"> </return> - <argument index="0" name="arg0" type="RID"> + <argument index="0" name="probe" type="RID"> </argument> <description> </description> @@ -1376,7 +1376,7 @@ <method name="gi_probe_get_energy" qualifiers="const"> <return type="float"> </return> - <argument index="0" name="arg0" type="RID"> + <argument index="0" name="probe" type="RID"> </argument> <description> </description> @@ -1384,7 +1384,7 @@ <method name="gi_probe_get_normal_bias" qualifiers="const"> <return type="float"> </return> - <argument index="0" name="arg0" type="RID"> + <argument index="0" name="probe" type="RID"> </argument> <description> </description> @@ -1392,7 +1392,7 @@ <method name="gi_probe_get_propagation" qualifiers="const"> <return type="float"> </return> - <argument index="0" name="arg0" type="RID"> + <argument index="0" name="probe" type="RID"> </argument> <description> </description> @@ -1400,7 +1400,7 @@ <method name="gi_probe_get_to_cell_xform" qualifiers="const"> <return type="Transform"> </return> - <argument index="0" name="arg0" type="RID"> + <argument index="0" name="probe" type="RID"> </argument> <description> </description> @@ -1408,7 +1408,7 @@ <method name="gi_probe_is_compressed" qualifiers="const"> <return type="bool"> </return> - <argument index="0" name="arg0" type="RID"> + <argument index="0" name="probe" type="RID"> </argument> <description> </description> @@ -1416,7 +1416,7 @@ <method name="gi_probe_is_interior" qualifiers="const"> <return type="bool"> </return> - <argument index="0" name="arg0" type="RID"> + <argument index="0" name="probe" type="RID"> </argument> <description> </description> @@ -1424,9 +1424,9 @@ <method name="gi_probe_set_bias"> <return type="void"> </return> - <argument index="0" name="bias" type="RID"> + <argument index="0" name="probe" type="RID"> </argument> - <argument index="1" name="arg1" type="float"> + <argument index="1" name="bias" type="float"> </argument> <description> </description> @@ -1454,9 +1454,9 @@ <method name="gi_probe_set_compress"> <return type="void"> </return> - <argument index="0" name="enable" type="RID"> + <argument index="0" name="probe" type="RID"> </argument> - <argument index="1" name="arg1" type="bool"> + <argument index="1" name="enable" type="bool"> </argument> <description> </description> @@ -1464,9 +1464,9 @@ <method name="gi_probe_set_dynamic_data"> <return type="void"> </return> - <argument index="0" name="data" type="RID"> + <argument index="0" name="probe" type="RID"> </argument> - <argument index="1" name="arg1" type="PoolIntArray"> + <argument index="1" name="data" type="PoolIntArray"> </argument> <description> </description> @@ -1474,9 +1474,9 @@ <method name="gi_probe_set_dynamic_range"> <return type="void"> </return> - <argument index="0" name="range" type="RID"> + <argument index="0" name="probe" type="RID"> </argument> - <argument index="1" name="arg1" type="int"> + <argument index="1" name="range" type="int"> </argument> <description> </description> @@ -1484,9 +1484,9 @@ <method name="gi_probe_set_energy"> <return type="void"> </return> - <argument index="0" name="energy" type="RID"> + <argument index="0" name="probe" type="RID"> </argument> - <argument index="1" name="arg1" type="float"> + <argument index="1" name="energy" type="float"> </argument> <description> </description> @@ -1494,9 +1494,9 @@ <method name="gi_probe_set_interior"> <return type="void"> </return> - <argument index="0" name="enable" type="RID"> + <argument index="0" name="probe" type="RID"> </argument> - <argument index="1" name="arg1" type="bool"> + <argument index="1" name="enable" type="bool"> </argument> <description> </description> @@ -1504,9 +1504,9 @@ <method name="gi_probe_set_normal_bias"> <return type="void"> </return> - <argument index="0" name="bias" type="RID"> + <argument index="0" name="probe" type="RID"> </argument> - <argument index="1" name="arg1" type="float"> + <argument index="1" name="bias" type="float"> </argument> <description> </description> @@ -1514,9 +1514,9 @@ <method name="gi_probe_set_propagation"> <return type="void"> </return> - <argument index="0" name="propagation" type="RID"> + <argument index="0" name="probe" type="RID"> </argument> - <argument index="1" name="arg1" type="float"> + <argument index="1" name="propagation" type="float"> </argument> <description> </description> @@ -1524,9 +1524,9 @@ <method name="gi_probe_set_to_cell_xform"> <return type="void"> </return> - <argument index="0" name="xform" type="RID"> + <argument index="0" name="probe" type="RID"> </argument> - <argument index="1" name="arg1" type="Transform"> + <argument index="1" name="xform" type="Transform"> </argument> <description> </description> @@ -3300,12 +3300,15 @@ </argument> <argument index="2" name="height" type="int"> </argument> - <argument index="3" name="format" type="int" enum="Image.Format"> + <argument index="3" name="depth_3d" type="int"> </argument> - <argument index="4" name="flags" type="int" default="7"> + <argument index="4" name="format" type="int" enum="Image.Format"> + </argument> + <argument index="5" name="type" type="int" enum="VisualServer.TextureType"> + </argument> + <argument index="6" name="flags" type="int" default="7"> </argument> <description> - Allocates space for a texture's image or video. </description> </method> <method name="texture_create"> @@ -3338,12 +3341,20 @@ </return> <argument index="0" name="texture" type="RID"> </argument> - <argument index="1" name="cube_side" type="int" enum="VisualServer.CubeMapSide" default="0"> + <argument index="1" name="cube_side" type="int" default="0"> </argument> <description> Returns a copy of a texture's image unless it's a CubeMap, in which case it returns the [RID] of the image at one of the cubes sides. </description> </method> + <method name="texture_get_depth" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="texture" type="RID"> + </argument> + <description> + </description> + </method> <method name="texture_get_flags" qualifiers="const"> <return type="int"> </return> @@ -3389,6 +3400,14 @@ Returns the opengl id of the texture's image. </description> </method> + <method name="texture_get_type" qualifiers="const"> + <return type="int" enum="VisualServer.TextureType"> + </return> + <argument index="0" name="texture" type="RID"> + </argument> + <description> + </description> + </method> <method name="texture_get_width" qualifiers="const"> <return type="int"> </return> @@ -3405,7 +3424,7 @@ </argument> <argument index="1" name="image" type="Image"> </argument> - <argument index="2" name="cube_side" type="int" enum="VisualServer.CubeMapSide" default="0"> + <argument index="2" name="layer" type="int" default="0"> </argument> <description> Sets the texture's image data. If it's a CubeMap, it sets the image data at a cube side. @@ -3432,7 +3451,7 @@ </argument> <argument index="8" name="dst_mip" type="int"> </argument> - <argument index="9" name="cube_side" type="int" enum="VisualServer.CubeMapSide" default="0"> + <argument index="9" name="layer" type="int" default="0"> </argument> <description> </description> @@ -3477,8 +3496,9 @@ </argument> <argument index="2" name="height" type="int"> </argument> + <argument index="3" name="depth" type="int"> + </argument> <description> - Overwrites the texture's width and height. </description> </method> <method name="textures_keep_original"> @@ -3873,6 +3893,14 @@ <constant name="CUBEMAP_BACK" value="5" enum="CubeMapSide"> Marks the back side of a cubemap. </constant> + <constant name="TEXTURE_TYPE_2D" value="0" enum="TextureType"> + </constant> + <constant name="TEXTURE_TYPE_CUBEMAP" value="1" enum="TextureType"> + </constant> + <constant name="TEXTURE_TYPE_2D_ARRAY" value="2" enum="TextureType"> + </constant> + <constant name="TEXTURE_TYPE_3D" value="3" enum="TextureType"> + </constant> <constant name="TEXTURE_FLAG_MIPMAPS" value="1" enum="TextureFlags"> Generate mipmaps, which are smaller versions of the same texture to use when zoomed out, keeping the aspect ratio. </constant> @@ -3892,10 +3920,7 @@ <constant name="TEXTURE_FLAG_MIRRORED_REPEAT" value="32" enum="TextureFlags"> Repeat texture with alternate sections mirrored. </constant> - <constant name="TEXTURE_FLAG_CUBEMAP" value="2048" enum="TextureFlags"> - Texture is a cubemap. - </constant> - <constant name="TEXTURE_FLAG_USED_FOR_STREAMING" value="4096" enum="TextureFlags"> + <constant name="TEXTURE_FLAG_USED_FOR_STREAMING" value="2048" enum="TextureFlags"> Texture is a video surface. </constant> <constant name="TEXTURE_FLAGS_DEFAULT" value="7" enum="TextureFlags"> @@ -4208,7 +4233,7 @@ </constant> <constant name="INSTANCE_FLAG_USE_BAKED_LIGHT" value="0" enum="InstanceFlags"> </constant> - <constant name="INSTANCE_FLAG_REDRAW_FRAME_IF_VISIBLE" value="1" enum="InstanceFlags"> + <constant name="INSTANCE_FLAG_DRAW_NEXT_FRAME_IF_VISIBLE" value="1" enum="InstanceFlags"> </constant> <constant name="INSTANCE_FLAG_MAX" value="2" enum="InstanceFlags"> </constant> |