diff options
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/AnimationPlayer.xml | 9 | ||||
| -rw-r--r-- | doc/classes/Area.xml | 15 | ||||
| -rw-r--r-- | doc/classes/Area2D.xml | 23 | ||||
| -rw-r--r-- | doc/classes/AudioEffectPitchShift.xml | 16 | ||||
| -rw-r--r-- | doc/classes/CameraFeed.xml | 4 | ||||
| -rw-r--r-- | doc/classes/CameraServer.xml | 4 | ||||
| -rw-r--r-- | doc/classes/ColorPicker.xml | 8 | ||||
| -rw-r--r-- | doc/classes/Engine.xml | 18 | ||||
| -rw-r--r-- | doc/classes/IP.xml | 16 | ||||
| -rw-r--r-- | doc/classes/Object.xml | 1 | ||||
| -rw-r--r-- | doc/classes/PacketPeerUDP.xml | 23 | ||||
| -rw-r--r-- | doc/classes/ReferenceRect.xml | 3 | ||||
| -rw-r--r-- | doc/classes/String.xml | 12 | ||||
| -rw-r--r-- | doc/classes/TextEdit.xml | 6 | ||||
| -rw-r--r-- | doc/classes/VisualShaderNodeGroupBase.xml | 8 |
15 files changed, 135 insertions, 31 deletions
diff --git a/doc/classes/AnimationPlayer.xml b/doc/classes/AnimationPlayer.xml index 5ea993f83d..ff91db2e28 100644 --- a/doc/classes/AnimationPlayer.xml +++ b/doc/classes/AnimationPlayer.xml @@ -238,6 +238,9 @@ <member name="current_animation_position" type="float" setter="" getter="get_current_animation_position"> The position (in seconds) of the currently playing animation. </member> + <member name="method_call_mode" type="int" setter="set_method_call_mode" getter="get_method_call_mode" enum="AnimationPlayer.AnimationMethodCallMode"> + The call mode to use for Call Method tracks. Default value: [code]ANIMATION_METHOD_CALL_DEFERRED[/code]. + </member> <member name="playback_active" type="bool" setter="set_active" getter="is_active"> If [code]true[/code], updates animations in response to process-related notifications. Default value: [code]true[/code]. </member> @@ -293,5 +296,11 @@ <constant name="ANIMATION_PROCESS_MANUAL" value="2" enum="AnimationProcessMode"> Do not process animation. Use the 'advance' method to process the animation manually. </constant> + <constant name="ANIMATION_METHOD_CALL_DEFERRED" value="0" enum="AnimationMethodCallMode"> + Batch method calls during the animation process, then do the calls after events are processed. This avoids bugs involving deleting nodes or modifying the AnimationPlayer while playing. + </constant> + <constant name="ANIMATION_METHOD_CALL_IMMEDIATE" value="1" enum="AnimationMethodCallMode"> + Make method calls immediately when reached in the animation. + </constant> </constants> </class> diff --git a/doc/classes/Area.xml b/doc/classes/Area.xml index c39c570be9..d40376414f 100644 --- a/doc/classes/Area.xml +++ b/doc/classes/Area.xml @@ -56,7 +56,8 @@ <argument index="0" name="body" type="Node"> </argument> <description> - If [code]true[/code], the given body overlaps the Area. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. + If [code]true[/code], the given physics body overlaps the Area. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. + The [code]body[/code] argument can either be a [PhysicsBody] or a [GridMap] instance (while GridMaps are not physics body themselves, they register their tiles with collision shapes as a virtual physics body). </description> </method> <method name="set_collision_layer_bit"> @@ -183,14 +184,16 @@ <argument index="0" name="body" type="Node"> </argument> <description> - Emitted when a [PhysicsBody] object enters. + Emitted when a physics body enters. + The [code]body[/code] argument can either be a [PhysicsBody] or a [GridMap] instance (while GridMaps are not physics body themselves, they register their tiles with collision shapes as a virtual physics body). </description> </signal> <signal name="body_exited"> <argument index="0" name="body" type="Node"> </argument> <description> - Emitted when a [PhysicsBody] object exits. + Emitted when a physics body exits. + The [code]body[/code] argument can either be a [PhysicsBody] or a [GridMap] instance (while GridMaps are not physics body themselves, they register their tiles with collision shapes as a virtual physics body). </description> </signal> <signal name="body_shape_entered"> @@ -203,7 +206,8 @@ <argument index="3" name="area_shape" type="int"> </argument> <description> - Emitted when a [PhysicsBody] object enters, reporting which shapes overlapped. + Emitted when a physics body enters, reporting which shapes overlapped. + The [code]body[/code] argument can either be a [PhysicsBody] or a [GridMap] instance (while GridMaps are not physics body themselves, they register their tiles with collision shapes as a virtual physics body). </description> </signal> <signal name="body_shape_exited"> @@ -216,7 +220,8 @@ <argument index="3" name="area_shape" type="int"> </argument> <description> - Emitted when a [PhysicsBody] object exits, reporting which shapes were overlapping. + Emitted when a physics body exits, reporting which shapes were overlapping. + The [code]body[/code] argument can either be a [PhysicsBody] or a [GridMap] instance (while GridMaps are not physics body themselves, they register their tiles with collision shapes as a virtual physics body). </description> </signal> </signals> diff --git a/doc/classes/Area2D.xml b/doc/classes/Area2D.xml index 8d28ddc889..4771a976b5 100644 --- a/doc/classes/Area2D.xml +++ b/doc/classes/Area2D.xml @@ -56,7 +56,8 @@ <argument index="0" name="body" type="Node"> </argument> <description> - If [code]true[/code], the given body overlaps the Area2D. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. + If [code]true[/code], the given physics body overlaps the Area2D. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. + The [code]body[/code] argument can either be a [PhysicsBody2D] or a [TileMap] instance (while TileMaps are not physics body themselves, they register their tiles with collision shapes as a virtual physics body). </description> </method> <method name="set_collision_layer_bit"> @@ -168,43 +169,47 @@ </description> </signal> <signal name="body_entered"> - <argument index="0" name="body" type="PhysicsBody2D"> + <argument index="0" name="body" type="Node"> </argument> <description> - Emitted when a [PhysicsBody2D] object enters. + Emitted when a physics body enters. + The [code]body[/code] argument can either be a [PhysicsBody2D] or a [TileMap] instance (while TileMaps are not physics body themselves, they register their tiles with collision shapes as a virtual physics body). </description> </signal> <signal name="body_exited"> - <argument index="0" name="body" type="PhysicsBody2D"> + <argument index="0" name="body" type="Node"> </argument> <description> - Emitted when a [PhysicsBody2D] object exits. + Emitted when a physics body exits. + The [code]body[/code] argument can either be a [PhysicsBody2D] or a [TileMap] instance (while TileMaps are not physics body themselves, they register their tiles with collision shapes as a virtual physics body). </description> </signal> <signal name="body_shape_entered"> <argument index="0" name="body_id" type="int"> </argument> - <argument index="1" name="body" type="PhysicsBody2D"> + <argument index="1" name="body" type="Node"> </argument> <argument index="2" name="body_shape" type="int"> </argument> <argument index="3" name="area_shape" type="int"> </argument> <description> - Emitted when a [PhysicsBody2D] object enters, reporting which shapes overlapped. + Emitted when a physics body enters, reporting which shapes overlapped. + The [code]body[/code] argument can either be a [PhysicsBody2D] or a [TileMap] instance (while TileMaps are not physics body themselves, they register their tiles with collision shapes as a virtual physics body). </description> </signal> <signal name="body_shape_exited"> <argument index="0" name="body_id" type="int"> </argument> - <argument index="1" name="body" type="PhysicsBody2D"> + <argument index="1" name="body" type="Node"> </argument> <argument index="2" name="body_shape" type="int"> </argument> <argument index="3" name="area_shape" type="int"> </argument> <description> - Emitted when a [PhysicsBody2D] object exits, reporting which shapes were overlapping. + Emitted when a physics body exits, reporting which shapes were overlapping. + The [code]body[/code] argument can either be a [PhysicsBody2D] or a [TileMap] instance (while TileMaps are not physics body themselves, they register their tiles with collision shapes as a virtual physics body). </description> </signal> </signals> diff --git a/doc/classes/AudioEffectPitchShift.xml b/doc/classes/AudioEffectPitchShift.xml index 7d6c5f2b20..8c22afb40f 100644 --- a/doc/classes/AudioEffectPitchShift.xml +++ b/doc/classes/AudioEffectPitchShift.xml @@ -12,10 +12,26 @@ <methods> </methods> <members> + <member name="fft_size" type="int" setter="set_fft_size" getter="get_fft_size" enum="AudioEffectPitchShift.FFT_Size"> + </member> + <member name="oversampling" type="int" setter="set_oversampling" getter="get_oversampling"> + </member> <member name="pitch_scale" type="float" setter="set_pitch_scale" getter="get_pitch_scale"> Pitch value. Can range from 0 (-1 octave) to 16 (+16 octaves). </member> </members> <constants> + <constant name="FFT_SIZE_256" value="0" enum="FFT_Size"> + </constant> + <constant name="FFT_SIZE_512" value="1" enum="FFT_Size"> + </constant> + <constant name="FFT_SIZE_1024" value="2" enum="FFT_Size"> + </constant> + <constant name="FFT_SIZE_2048" value="3" enum="FFT_Size"> + </constant> + <constant name="FFT_SIZE_4096" value="4" enum="FFT_Size"> + </constant> + <constant name="FFT_SIZE_MAX" value="5" enum="FFT_Size"> + </constant> </constants> </class> diff --git a/doc/classes/CameraFeed.xml b/doc/classes/CameraFeed.xml index 7f353f7a05..4611b9c507 100644 --- a/doc/classes/CameraFeed.xml +++ b/doc/classes/CameraFeed.xml @@ -45,10 +45,10 @@ <constant name="FEED_RGB" value="1" enum="FeedDataType"> Feed supplies RGB images. </constant> - <constant name="FEED_YCbCr" value="2" enum="FeedDataType"> + <constant name="FEED_YCBCR" value="2" enum="FeedDataType"> Feed supplies YCbCr images that need to be converted to RGB. </constant> - <constant name="FEED_YCbCr_Sep" value="3" enum="FeedDataType"> + <constant name="FEED_YCBCR_SEP" value="3" enum="FeedDataType"> Feed supplies separate Y and CbCr images that need to be combined and converted to RGB. </constant> <constant name="FEED_UNSPECIFIED" value="0" enum="FeedPosition"> diff --git a/doc/classes/CameraServer.xml b/doc/classes/CameraServer.xml index f492bda74f..ee41f08ec6 100644 --- a/doc/classes/CameraServer.xml +++ b/doc/classes/CameraServer.xml @@ -70,13 +70,13 @@ <constant name="FEED_RGBA_IMAGE" value="0" enum="FeedImage"> The RGBA camera image. </constant> - <constant name="FEED_YCbCr_IMAGE" value="0" enum="FeedImage"> + <constant name="FEED_YCBCR_IMAGE" value="0" enum="FeedImage"> The YCbCr camera image. </constant> <constant name="FEED_Y_IMAGE" value="0" enum="FeedImage"> The Y component camera image. </constant> - <constant name="FEED_CbCr_IMAGE" value="1" enum="FeedImage"> + <constant name="FEED_CBCR_IMAGE" value="1" enum="FeedImage"> The CbCr component camera image. </constant> </constants> diff --git a/doc/classes/ColorPicker.xml b/doc/classes/ColorPicker.xml index 1fefc719b7..0ab91e9621 100644 --- a/doc/classes/ColorPicker.xml +++ b/doc/classes/ColorPicker.xml @@ -45,14 +45,14 @@ <member name="edit_alpha" type="bool" setter="set_edit_alpha" getter="is_editing_alpha"> If [code]true[/code], shows an alpha channel slider (transparency). </member> - <member name="presets_enabled" type="bool" setter="set_presets_enabled" getter="are_presets_enabled"> - </member> - <member name="presets_visible" type="bool" setter="set_presets_visible" getter="are_presets_visible"> - </member> <member name="hsv_mode" type="bool" setter="set_hsv_mode" getter="is_hsv_mode"> If [code]true[/code], allows to edit color with Hue/Saturation/Value sliders. [b]Note:[/b] Cannot be enabled if raw mode is on. </member> + <member name="presets_enabled" type="bool" setter="set_presets_enabled" getter="are_presets_enabled"> + </member> + <member name="presets_visible" type="bool" setter="set_presets_visible" getter="are_presets_visible"> + </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). [b]Note:[/b] Cannot be enabled if hsv mode is on. diff --git a/doc/classes/Engine.xml b/doc/classes/Engine.xml index ac46d34198..d446363a83 100644 --- a/doc/classes/Engine.xml +++ b/doc/classes/Engine.xml @@ -85,14 +85,16 @@ </return> <description> Returns the current engine version information in a Dictionary. - "major" - Holds the major version number as an int - "minor" - Holds the minor version number as an int - "patch" - Holds the patch version number as an int - "hex" - Holds the full version number encoded as an hexadecimal int with one byte (2 places) per number (see example below) - "status" - Holds the status (e.g. "beta", "rc1", "rc2", ... "stable") as a String - "build" - Holds the build name (e.g. "custom-build") as a String - "string" - major + minor + patch + status + build in a single String - The "hex" value is encoded as follows, from left to right: one byte for the major, one byte for the minor, one byte for the patch version. For example, "3.1.12" would be [code]0x03010C[/code]. Note that it's still an int internally, and printing it will give you its decimal representation, which is not particularly meaningful. Use hexadecimal literals for easy version comparisons from code: + [code]major[/code] - Holds the major version number as an int + [code]minor[/code] - Holds the minor version number as an int + [code]patch[/code] - Holds the patch version number as an int + [code]hex[/code] - Holds the full version number encoded as an hexadecimal int with one byte (2 places) per number (see example below) + [code]status[/code] - Holds the status (e.g. "beta", "rc1", "rc2", ... "stable") as a String + [code]build[/code] - Holds the build name (e.g. "custom_build") as a String + [code]hash[/code] - Holds the full Git commit hash as a String + [code]year[/code] - Holds the year the version was released in as an int + [code]string[/code] - [code]major[/code] + [code]minor[/code] + [code]patch[/code] + [code]status[/code] + [code]build[/code] in a single String + The [code]hex[/code] value is encoded as follows, from left to right: one byte for the major, one byte for the minor, one byte for the patch version. For example, "3.1.12" would be [code]0x03010C[/code]. Note that it's still an int internally, and printing it will give you its decimal representation, which is not particularly meaningful. Use hexadecimal literals for easy version comparisons from code: [codeblock] if Engine.get_version_info().hex >= 0x030200: # do things specific to version 3.2 or later diff --git a/doc/classes/IP.xml b/doc/classes/IP.xml index 3616a9ec50..65b1700333 100644 --- a/doc/classes/IP.xml +++ b/doc/classes/IP.xml @@ -34,6 +34,22 @@ Returns all of the user's current IPv4 and IPv6 addresses as an array. </description> </method> + <method name="get_local_interfaces" qualifiers="const"> + <return type="Array"> + </return> + <description> + Returns all network adapters as an array. + Each adapter is a dictionary of the form: + [codeblock] + { + "index": "1", # Interface index. + "name": "eth0", # Interface name. + "friendly": "Ethernet One", # A friendly name (might be empty). + "addresses": ["192.168.1.101"], # An array of IP addresses associated to this interface. + } + [/codeblock] + </description> + </method> <method name="get_resolve_item_address" qualifiers="const"> <return type="String"> </return> diff --git a/doc/classes/Object.xml b/doc/classes/Object.xml index c9910360ed..548a0c18bb 100644 --- a/doc/classes/Object.xml +++ b/doc/classes/Object.xml @@ -374,6 +374,7 @@ <argument index="1" name="value" type="Variant"> </argument> <description> + Set property into the object, after the current frame's physics step. This is equivalent to calling [method set] via [method call_deferred], i.e. [code]call_deferred("set", [property, value])[/code]. </description> </method> <method name="set_indexed"> diff --git a/doc/classes/PacketPeerUDP.xml b/doc/classes/PacketPeerUDP.xml index 9843c16108..376818fb86 100644 --- a/doc/classes/PacketPeerUDP.xml +++ b/doc/classes/PacketPeerUDP.xml @@ -37,6 +37,29 @@ Returns whether this [PacketPeerUDP] is listening. </description> </method> + <method name="join_multicast_group"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="multicast_address" type="String"> + </argument> + <argument index="1" name="interface_name" type="String"> + </argument> + <description> + Join the multicast group specified by [code]multicast_address[/code] using the interface identified by [code]interface_name[/code]. + You can join the same multicast group with multiple interfaces. Use [method IP.get_local_interfaces] to know which are available. + </description> + </method> + <method name="leave_multicast_group"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="multicast_address" type="String"> + </argument> + <argument index="1" name="interface_name" type="String"> + </argument> + <description> + Remove the interface identified by [code]interface_name[/code] from the multicast group specified by [code]multicast_address[/code]. + </description> + </method> <method name="listen"> <return type="int" enum="Error"> </return> diff --git a/doc/classes/ReferenceRect.xml b/doc/classes/ReferenceRect.xml index 0e19e35e58..f6025fe2f9 100644 --- a/doc/classes/ReferenceRect.xml +++ b/doc/classes/ReferenceRect.xml @@ -4,7 +4,7 @@ Reference frame for GUI. </brief_description> <description> - Reference frame for GUI. It's just like an empty control, except a red box is displayed while editing around its size at all times. + Reference frame for GUI. It's just like an empty control, except an outline border [member border_color] is displayed while editing around its size at all times. </description> <tutorials> </tutorials> @@ -12,6 +12,7 @@ </methods> <members> <member name="border_color" type="Color" setter="set_border_color" getter="get_border_color"> + Determines the border [Color] of the [ReferenceRect]. </member> </members> <constants> diff --git a/doc/classes/String.xml b/doc/classes/String.xml index ff0572f384..6395fe2ce8 100644 --- a/doc/classes/String.xml +++ b/doc/classes/String.xml @@ -388,6 +388,18 @@ Converts a string containing a hexadecimal number into an integer. </description> </method> + <method name="http_escape"> + <return type="String"> + </return> + <description> + </description> + </method> + <method name="http_unescape"> + <return type="String"> + </return> + <description> + </description> + </method> <method name="insert"> <return type="String"> </return> diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index 8139da3a4c..e818d753d8 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -44,6 +44,12 @@ Returns if the given line is foldable, that is, it has indented lines right below it. </description> </method> + <method name="center_viewport_to_cursor"> + <return type="void"> + </return> + <description> + </description> + </method> <method name="clear_colors"> <return type="void"> </return> diff --git a/doc/classes/VisualShaderNodeGroupBase.xml b/doc/classes/VisualShaderNodeGroupBase.xml index 37d48956f6..c2e9b9503b 100644 --- a/doc/classes/VisualShaderNodeGroupBase.xml +++ b/doc/classes/VisualShaderNodeGroupBase.xml @@ -109,6 +109,14 @@ <description> </description> </method> + <method name="is_valid_port_name" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> <method name="remove_input_port"> <return type="void"> </return> |