diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/base/classes.xml | 66 | ||||
| -rw-r--r-- | doc/tools/doc_merge.py | 2 | ||||
| -rwxr-xr-x | doc/tools/doc_status.py | 2 | ||||
| -rw-r--r-- | doc/tools/makedocs.py | 2 | ||||
| -rw-r--r-- | doc/tools/makedoku.py | 2 | ||||
| -rw-r--r-- | doc/tools/makehtml.py | 2 | ||||
| -rw-r--r-- | doc/tools/makemd.py | 2 | ||||
| -rw-r--r-- | doc/tools/makerst.py | 2 |
8 files changed, 49 insertions, 31 deletions
diff --git a/doc/base/classes.xml b/doc/base/classes.xml index c18cba09a4..5eb021f6c0 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -5459,18 +5459,6 @@ <constants> </constants> </class> -<class name="AudioStreamSpeex" inherits="AudioStream" category="Core"> - <brief_description> - Speex audio stream driver. - </brief_description> - <description> - Speex audio stream driver. Speex is very useful for compressed speech. It allows loading a very large amount of speech in memory at little IO/latency cost. - </description> - <methods> - </methods> - <constants> - </constants> -</class> <class name="BackBufferCopy" inherits="Node2D" category="Core"> <brief_description> Copies a region of the screen (or the whole screen) to a buffer so it can be accessed with the texscreen() shader instruction. @@ -11813,7 +11801,7 @@ <argument index="1" name="canvas" type="Control"> </argument> <description> - This function is called every time the 2D canvas editor draws (which overlays over the edited scene). Drawing over the supplied control will draw over the edited scene. To convert from control coordinates to edited scene coordinates (including zoom and offset), a transform is also provided. If you require this control to be redraw, call [method update_canvas](). + This function is called every time the 2D canvas editor draws (which overlays over the edited scene). Drawing over the supplied control will draw over the edited scene. To convert from control coordinates to edited scene coordinates (including zoom and offset), a transform is also provided. If you require this control to be redraw, call [method update_canvas]. </description> </method> <method name="forward_spatial_input_event" qualifiers="virtual"> @@ -12010,7 +11998,7 @@ </method> <method name="update_canvas"> <description> - Updates the control used to draw the edited scene over the 2D canvas. This is used together with [method forward_canvas_input_event](). + Updates the control used to draw the edited scene over the 2D canvas. This is used together with [method forward_canvas_input_event]. </description> </method> </methods> @@ -22274,8 +22262,10 @@ </class> <class name="NetworkedMultiplayerENet" inherits="NetworkedMultiplayerPeer" category="Core"> <brief_description> + PacketPeer implementation using the ENet library. </brief_description> <description> + A connection (or a listening server) that should be passed to [method SceneTree.set_network_peer]. Socket events can be handled by connecting to [SceneTree] signals. </description> <methods> <method name="close_connection"> @@ -22630,6 +22620,7 @@ Nodes can also process input events. When set, the [method _input] function will be called for each input that the program receives. In many cases, this can be overkill (unless used for simple projects), and the [method _unhandled_input] function might be preferred; it is called when the input event was not handled by anyone else (typically, GUI [Control] nodes), ensuring that the node only receives the events that were meant for it. To keep track of the scene hierarchy (especially when instancing scenes into other scenes), an "owner" can be set for the node with [method set_owner]. This keeps track of who instanced what. This is mostly useful when writing editors and tools, though. Finally, when a node is freed with [method free] or [method queue_free], it will also free all its children. + [b]Networking with nodes:[/b] After connecting to a server (or making one, see [NetworkedMultiplayerENet]) it is possible to use the built-in RPC (remote procedure call) system to easily communicate over the network. By calling [method rpc] with a method name, it will be called locally, and in all connected peers (peers = clients and the server that accepts connections), with behaviour varying depending on the network mode ([method set_network_mode]) on the receiving peer. To identify which [Node] receives the RPC call Godot will use it's [NodePath] (make sure node names are the same on all peers). </description> <methods> <method name="_enter_tree" qualifiers="virtual"> @@ -23067,6 +23058,7 @@ <argument index="0" name="method" type="String"> </argument> <description> + Send a remote procedure call request to all peers on the network (and locally), optionally sending additional data as arguments. Call request will be received by nodes with the same [NodePath]. </description> </method> <method name="rpc_config"> @@ -23075,6 +23067,7 @@ <argument index="1" name="mode" type="int"> </argument> <description> + Change the method's RPC mode (one of RPC_MODE_* constants). </description> </method> <method name="rpc_id" qualifiers="vararg"> @@ -23083,12 +23076,14 @@ <argument index="1" name="method" type="String"> </argument> <description> + Send a [method rpc] to a specific peer identified by [i]peer_id[/i]. </description> </method> <method name="rpc_unreliable" qualifiers="vararg"> <argument index="0" name="method" type="String"> </argument> <description> + Send a [method rpc] using an unreliable protocol. </description> </method> <method name="rpc_unreliable_id" qualifiers="vararg"> @@ -23097,6 +23092,7 @@ <argument index="1" name="method" type="String"> </argument> <description> + Send a [method rpc] to a specific peer identified by [i]peer_id[/i] using an unreliable protocol. </description> </method> <method name="rset"> @@ -23105,6 +23101,7 @@ <argument index="1" name="value" type="Variant"> </argument> <description> + Remotely change property's value on other peers (and locally). </description> </method> <method name="rset_config"> @@ -23113,6 +23110,7 @@ <argument index="1" name="mode" type="int"> </argument> <description> + Change the property's RPC mode (one of RPC_MODE_* constants). </description> </method> <method name="rset_id"> @@ -23123,6 +23121,7 @@ <argument index="2" name="value" type="Variant"> </argument> <description> + Remotely change property's value on a specific peer identified by [i]peer_id[/i]. </description> </method> <method name="rset_unreliable"> @@ -23131,6 +23130,7 @@ <argument index="1" name="value" type="Variant"> </argument> <description> + Remotely change property's value on other peers (and locally) using an unreliable protocol. </description> </method> <method name="rset_unreliable_id"> @@ -23141,6 +23141,7 @@ <argument index="2" name="value" type="Variant"> </argument> <description> + Remotely change property's value on a specific peer identified by [i]peer_id[/i] using an unreliable protocol. </description> </method> <method name="set_display_folded"> @@ -23174,6 +23175,7 @@ <argument index="0" name="mode" type="int"> </argument> <description> + Change the networking mode of the [Node], where [i]mode[/i] is one of the constants NETWORK_MODE_*. Master nodes will only call gdscript methods defined as [i]master func[/i] if a RPC call is received (slave nodes will only call [i]slave func[/i]; both will call [i]remote func[/i] if the call is not local, and [i]sync func[/i] in any case). Inherit mode looks at the parent node to determine the value (root node depends on the [SceneTree] having a networking peer set with [method SceneTree.set_network_peer]) </description> </method> <method name="set_owner"> @@ -26265,7 +26267,7 @@ </methods> <constants> <constant name="PARAM_DIRECTION" value="0"> - Direction in radians at which the particles will be launched, Notice that when the direction is set to 0 the particles will be launched to the negative + Direction in degrees at which the particles will be launched, Notice that when the direction is set to 0 the particles will be launched to the negative </constant> <constant name="PARAM_SPREAD" value="1"> </constant> @@ -26279,7 +26281,7 @@ Velocity at which the particles will orbit around the emitter center </constant> <constant name="PARAM_GRAVITY_DIRECTION" value="5"> - Direction in radians at which the particles will be attracted + Direction in degrees at which the particles will be attracted </constant> <constant name="PARAM_GRAVITY_STRENGTH" value="6"> Strength of the gravitation attraction for each particle @@ -31869,6 +31871,8 @@ RayCast can ignore some objects by adding them to the exception list via [code]add_exception[/code], setting proper filtering with layers, or by filtering object types with type masks. Only enabled raycasts will be able to query the space and report collisions! + + RayCast calculates intersection every fixed frame (see [Node]), and the result is cached so it can be used later until the next frame. If multiple queries are required between fixed frames (or during the same frame) use [method force_raycast_update] after adjusting the raycast. </description> <methods> <method name="add_exception"> @@ -31889,6 +31893,11 @@ Removes all collision exception for this ray. </description> </method> + <method name="force_raycast_update"> + <description> + Updates the collision information in case if this object's properties changed during the current frame (for example position, rotation or the cast_point). Note, [code]set_enabled[/code] is not required for this to work. + </description> + </method> <method name="get_cast_to" qualifiers="const"> <return type="Vector3"> </return> @@ -32007,6 +32016,8 @@ RayCast2D can ignore some objects by adding them to the exception list via [code]add_exception[/code], setting proper filtering with layers, or by filtering object types with type masks. Only enabled raycasts will be able to query the space and report collisions! + + RayCast2D calculates intersection every fixed frame (see [Node]), and the result is cached so it can be used later until the next frame. If multiple queries are required between fixed frames (or during the same frame) use [method force_raycast_update] after adjusting the raycast. </description> <methods> <method name="add_exception"> @@ -32027,6 +32038,11 @@ Removes all collision exception for this ray. </description> </method> + <method name="force_raycast_update"> + <description> + Updates the collision information in case if this object's properties changed during the current frame (for example position, rotation or the cast_point). Note, [code]set_enabled[/code] is not required for this to work. + </description> + </method> <method name="get_cast_to" qualifiers="const"> <return type="Vector2"> </return> @@ -35273,6 +35289,7 @@ <return type="bool"> </return> <description> + Returns true if this SceneTree's [NetworkedMultiplayerPeer] is in server mode (listening for connections). </description> </method> <method name="is_paused" qualifiers="const"> @@ -35369,6 +35386,7 @@ <argument index="0" name="peer" type="NetworkedMultiplayerPeer"> </argument> <description> + Set the peer object to handle the RPC system (effectively enabling networking). Depending on the peer itself, the SceneTree will become a network server (check with [method is_network_server()]) and will set root node's network mode to master (see NETWORK_MODE_* constants in [Node]), or it will become a regular peer with root node set to slave. All child nodes are set to inherit the network mode by default. Handling of networking-related events (connection, disconnection, new clients) is done by connecting to SceneTree's signals. </description> </method> <method name="set_pause"> @@ -44206,10 +44224,10 @@ </return> <argument index="0" name="object" type="Object"> </argument> - <argument index="1" name="key" type="String"> + <argument index="1" name="key" type="String" default=""""> </argument> <description> - Stop animating and completely remove a tween, given its object and property/method pair. + Stop animating and completely remove a tween, given its object and property/method pair. Passing empty String as key will remove all tweens for given object. </description> </method> <method name="remove_all"> @@ -44224,10 +44242,10 @@ </return> <argument index="0" name="object" type="Object"> </argument> - <argument index="1" name="key" type="String"> + <argument index="1" name="key" type="String" default=""""> </argument> <description> - Resets a tween to the initial value (the one given, not the one before the tween), given its object and property/method pair. + Resets a tween to the initial value (the one given, not the one before the tween), given its object and property/method pair. Passing empty String as key will reset all tweens for given object. </description> </method> <method name="reset_all"> @@ -44242,10 +44260,10 @@ </return> <argument index="0" name="object" type="Object"> </argument> - <argument index="1" name="key" type="String"> + <argument index="1" name="key" type="String" default=""""> </argument> <description> - Continue animating a stopped tween, given its object and property/method pair. + Continue animating a stopped tween, given its object and property/method pair. Passing empty String as key will resume all tweens for given object. </description> </method> <method name="resume_all"> @@ -44304,10 +44322,10 @@ </return> <argument index="0" name="object" type="Object"> </argument> - <argument index="1" name="key" type="String"> + <argument index="1" name="key" type="String" default=""""> </argument> <description> - Stop animating a tween, given its object and property/method pair. + Stop animating a tween, given its object and property/method pair. Passing empty String as key will stop all tweens for given object. </description> </method> <method name="stop_all"> diff --git a/doc/tools/doc_merge.py b/doc/tools/doc_merge.py index b55902ce4f..536770bee4 100644 --- a/doc/tools/doc_merge.py +++ b/doc/tools/doc_merge.py @@ -1,4 +1,4 @@ -#!/usr/bin/python +#!/usr/bin/env python # -*- coding: utf-8 -*- import sys diff --git a/doc/tools/doc_status.py b/doc/tools/doc_status.py index 35a6bc8bc4..f0ede405ce 100755 --- a/doc/tools/doc_status.py +++ b/doc/tools/doc_status.py @@ -1,4 +1,4 @@ -#!/usr/bin/python3 +#!/usr/bin/env python3 import sys import re diff --git a/doc/tools/makedocs.py b/doc/tools/makedocs.py index 063ee29002..731e04f6fc 100644 --- a/doc/tools/makedocs.py +++ b/doc/tools/makedocs.py @@ -1,4 +1,4 @@ -#!/usr/bin/python3 +#!/usr/bin/env python3 # -*- coding: utf-8 -*- # diff --git a/doc/tools/makedoku.py b/doc/tools/makedoku.py index 97819d7da3..7c3ca29af8 100644 --- a/doc/tools/makedoku.py +++ b/doc/tools/makedoku.py @@ -1,4 +1,4 @@ -#!/usr/bin/python +#!/usr/bin/env python # -*- coding: utf-8 -*- import sys diff --git a/doc/tools/makehtml.py b/doc/tools/makehtml.py index 26edda0935..b0a8cbda88 100644 --- a/doc/tools/makehtml.py +++ b/doc/tools/makehtml.py @@ -1,4 +1,4 @@ -#!/usr/bin/python +#!/usr/bin/env python # -*- coding: utf-8 -*- import sys diff --git a/doc/tools/makemd.py b/doc/tools/makemd.py index 38b493b0bf..e0fbe9af03 100644 --- a/doc/tools/makemd.py +++ b/doc/tools/makemd.py @@ -1,4 +1,4 @@ -#!/usr/bin/python +#!/usr/bin/env python # -*- coding: utf-8 -*- import sys diff --git a/doc/tools/makerst.py b/doc/tools/makerst.py index 45e690cb65..718cf4a275 100644 --- a/doc/tools/makerst.py +++ b/doc/tools/makerst.py @@ -1,4 +1,4 @@ -#!/usr/bin/python +#!/usr/bin/env python # -*- coding: utf-8 -*- import codecs |