Jelajahi Sumber

Sync classref with current source

Rémi Verschelde 7 tahun lalu
induk
melakukan
cf756deffb

+ 6 - 6
classes/[email protected]

@@ -42,7 +42,7 @@ Member Functions
 +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | :ref:`String<class_string>`                                | :ref:`char<class_@GDScript_char>` **(** :ref:`int<class_int>` ascii **)**                                                                                                                                                       |
 +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| :ref:`float<class_float>`                                  | :ref:`clamp<class_@GDScript_clamp>` **(** :ref:`float<class_float>` val, :ref:`float<class_float>` min, :ref:`float<class_float>` max **)**                                                                                     |
+| :ref:`float<class_float>`                                  | :ref:`clamp<class_@GDScript_clamp>` **(** :ref:`float<class_float>` value, :ref:`float<class_float>` min, :ref:`float<class_float>` max **)**                                                                                   |
 +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | :ref:`Object<class_object>`                                | :ref:`convert<class_@GDScript_convert>` **(** :ref:`Variant<class_variant>` what, :ref:`int<class_int>` type **)**                                                                                                              |
 +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -78,7 +78,7 @@ Member Functions
 +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | :ref:`Object<class_object>`                                | :ref:`instance_from_id<class_@GDScript_instance_from_id>` **(** :ref:`int<class_int>` instance_id **)**                                                                                                                         |
 +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| :ref:`float<class_float>`                                  | :ref:`inverse_lerp<class_@GDScript_inverse_lerp>` **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to, :ref:`float<class_float>` value **)**                                                                     |
+| :ref:`float<class_float>`                                  | :ref:`inverse_lerp<class_@GDScript_inverse_lerp>` **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to, :ref:`float<class_float>` weight **)**                                                                    |
 +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | :ref:`bool<class_bool>`                                    | :ref:`is_inf<class_@GDScript_is_inf>` **(** :ref:`float<class_float>` s **)**                                                                                                                                                   |
 +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -98,7 +98,7 @@ Member Functions
 +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | :ref:`float<class_float>`                                  | :ref:`min<class_@GDScript_min>` **(** :ref:`float<class_float>` a, :ref:`float<class_float>` b **)**                                                                                                                            |
 +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| :ref:`int<class_int>`                                      | :ref:`nearest_po2<class_@GDScript_nearest_po2>` **(** :ref:`int<class_int>` val **)**                                                                                                                                           |
+| :ref:`int<class_int>`                                      | :ref:`nearest_po2<class_@GDScript_nearest_po2>` **(** :ref:`int<class_int>` value **)**                                                                                                                                         |
 +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | :ref:`Variant<class_variant>`                              | :ref:`parse_json<class_@GDScript_parse_json>` **(** :ref:`String<class_string>` json **)**                                                                                                                                      |
 +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -336,7 +336,7 @@ Returns a character as a String of the given ASCII code.
 
 .. _class_@GDScript_clamp:
 
-- :ref:`float<class_float>` **clamp** **(** :ref:`float<class_float>` val, :ref:`float<class_float>` min, :ref:`float<class_float>` max **)**
+- :ref:`float<class_float>` **clamp** **(** :ref:`float<class_float>` value, :ref:`float<class_float>` min, :ref:`float<class_float>` max **)**
 
 Clamps ``val`` and returns a value not less than ``min`` and not more than ``max``.
 
@@ -563,7 +563,7 @@ Returns the Object that corresponds to ``instance_id``. All Objects have a uniqu
 
 .. _class_@GDScript_inverse_lerp:
 
-- :ref:`float<class_float>` **inverse_lerp** **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to, :ref:`float<class_float>` value **)**
+- :ref:`float<class_float>` **inverse_lerp** **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to, :ref:`float<class_float>` weight **)**
 
 Returns a normalized value considering the given range.
 
@@ -655,7 +655,7 @@ Returns the minimum of two values.
 
 .. _class_@GDScript_nearest_po2:
 
-- :ref:`int<class_int>` **nearest_po2** **(** :ref:`int<class_int>` val **)**
+- :ref:`int<class_int>` **nearest_po2** **(** :ref:`int<class_int>` value **)**
 
 Returns the nearest larger power of 2 for integer ``val``.
 

+ 1 - 1
classes/[email protected]

@@ -59,7 +59,7 @@ Member Variables
 
   .. _class_@GlobalScope_JavaScript:
 
-- :ref:`JavaScript<class_javascript>` **JavaScript**
+- :ref:`JavaScript<class_javascript>` **JavaScript** - :ref:`JavaScript<class_javascript>` singleton
 
   .. _class_@GlobalScope_Marshalls:
 

+ 6 - 2
classes/class_animationplayer.rst

@@ -72,13 +72,13 @@ If the currently being played animation changes, this signal will notify of such
 
 .. _class_AnimationPlayer_animation_finished:
 
-- **animation_finished** **(** :ref:`String<class_string>` name **)**
+- **animation_finished** **(** :ref:`String<class_string>` anim_name **)**
 
 Notifies when an animation finished playing.
 
 .. _class_AnimationPlayer_animation_started:
 
-- **animation_started** **(** :ref:`String<class_string>` name **)**
+- **animation_started** **(** :ref:`String<class_string>` anim_name **)**
 
 Notifies when an animation starts playing.
 
@@ -86,6 +86,10 @@ Notifies when an animation starts playing.
 Member Variables
 ----------------
 
+  .. _class_AnimationPlayer_assigned_animation:
+
+- :ref:`String<class_string>` **assigned_animation** - If playing, the current animation; otherwise, the animation last played. When set, would change the animation, but would not play it unless currently playing. See also :ref:`current_animation<class_AnimationPlayer_current_animation>`.
+
   .. _class_AnimationPlayer_autoplay:
 
 - :ref:`String<class_string>` **autoplay** - The name of the animation to play when the scene loads. Default value: ``""``.

+ 46 - 8
classes/class_animationtreeplayer.rst

@@ -14,7 +14,7 @@ AnimationTreePlayer
 Brief Description
 -----------------
 
-Animation Player that uses a node graph for the blending.
+Animation Player that uses a node graph for blending Animations.
 
 Member Functions
 ----------------
@@ -144,10 +144,14 @@ Member Variables
 
 - :ref:`NodePath<class_nodepath>` **base_path** - The node from which to relatively access other nodes. Default value: ``".."``.
 
+It accesses the Bones, so it should point to the same Node the AnimationPlayer would point its Root Node at.
+
   .. _class_AnimationTreePlayer_master_player:
 
 - :ref:`NodePath<class_nodepath>` **master_player** - The path to the :ref:`AnimationPlayer<class_animationplayer>` from which this ``AnimationTreePlayer`` binds animations to animation nodes.
 
+Once set, Animation nodes can be added to the AnimationTreePlayer.
+
   .. _class_AnimationTreePlayer_playback_process_mode:
 
 - :ref:`AnimationProcessMode<enum_animationtreeplayer_animationprocessmode>` **playback_process_mode** - The thread in which to update animations. Default value: enum ANIMATION_PROCESS_IDLE.
@@ -184,6 +188,8 @@ Description
 
 A node graph tool for blending multiple animations bound to an :ref:`AnimationPlayer<class_animationplayer>`. Especially useful for animating characters or other skeleton-based rigs. It can combine several animations to form a desired pose.
 
+It takes :ref:`Animation<class_animation>`\ s from an :ref:`AnimationPlayer<class_animationplayer>` node and mixes them depending on the graph.
+
 Member Function Description
 ---------------------------
 
@@ -203,19 +209,19 @@ Shifts position in the animation timeline. Delta is the time in seconds to shift
 
 - :ref:`Animation<class_animation>` **animation_node_get_animation** **(** :ref:`String<class_string>` id **)** const
 
-Returns the :ref:`AnimationPlayer<class_animationplayer>`'s animation bound to the ``AnimationTreePlayer``'s animation node with name ``id``.
+Returns the :ref:`AnimationPlayer<class_animationplayer>`'s :ref:`Animation<class_animation>` bound to the ``AnimationTreePlayer``'s animation node with name ``id``.
 
 .. _class_AnimationTreePlayer_animation_node_get_master_animation:
 
 - :ref:`String<class_string>` **animation_node_get_master_animation** **(** :ref:`String<class_string>` id **)** const
 
-Returns the name of the :ref:`master_player<class_AnimationTreePlayer_master_player>`'s animation bound to this animation node.
+Returns the name of the :ref:`master_player<class_AnimationTreePlayer_master_player>`'s :ref:`Animation<class_animation>` bound to this animation node.
 
 .. _class_AnimationTreePlayer_animation_node_set_animation:
 
 - void **animation_node_set_animation** **(** :ref:`String<class_string>` id, :ref:`Animation<class_animation>` animation **)**
 
-Binds a new animation from the :ref:`master_player<class_AnimationTreePlayer_master_player>` to the ``AnimationTreePlayer``'s animation node with name ``id``.
+Binds a new :ref:`Animation<class_animation>` from the :ref:`master_player<class_AnimationTreePlayer_master_player>` to the ``AnimationTreePlayer``'s animation node with name ``id``.
 
 .. _class_AnimationTreePlayer_animation_node_set_filter_path:
 
@@ -227,7 +233,7 @@ If ``enable`` is ``true``, the animation node with ID ``id`` turns off the track
 
 - void **animation_node_set_master_animation** **(** :ref:`String<class_string>` id, :ref:`String<class_string>` source **)**
 
-Binds the animation named ``source`` from :ref:`master_player<class_AnimationTreePlayer_master_player>` to the animation node ``id``. Recalculates caches.
+Binds the :ref:`Animation<class_animation>` named ``source`` from :ref:`master_player<class_AnimationTreePlayer_master_player>` to the animation node ``id``. Recalculates caches.
 
 .. _class_AnimationTreePlayer_are_nodes_connected:
 
@@ -247,6 +253,14 @@ Returns the blend amount of a Blend2 node given its name.
 
 Sets the blend amount of a Blend2 node given its name and value.
 
+A Blend2 Node blends two animations with the amount between 0 and 1.
+
+At 0, Output is input a.
+
+Towards 1, the influence of a gets lessened, the influence of b gets raised.
+
+At 1, Output is input b.
+
 .. _class_AnimationTreePlayer_blend2_node_set_filter_path:
 
 - void **blend2_node_set_filter_path** **(** :ref:`String<class_string>` id, :ref:`NodePath<class_nodepath>` path, :ref:`bool<class_bool>` enable **)**
@@ -265,6 +279,18 @@ Returns the blend amount of a Blend3 node given its name.
 
 Sets the blend amount of a Blend3 node given its name and value.
 
+A Blend3 Node blends three animations with the amount between -1 and 1.
+
+At -1, Output is input b-.
+
+From -1 to 0, the influence of b- gets lessened, the influence of a gets raised and the influence of b+ is 0.
+
+At 0, Output is input a.
+
+From 0 to 1, the influence of a gets lessened, the influence of b+ gets raised and the influence of b+ is 0.
+
+At 1, Output is input b+.
+
 .. _class_AnimationTreePlayer_blend4_node_get_amount:
 
 - :ref:`Vector2<class_vector2>` **blend4_node_get_amount** **(** :ref:`String<class_string>` id **)** const
@@ -277,6 +303,10 @@ Returns the blend amount of a Blend4 node given its name.
 
 Sets the blend amount of a Blend4 node given its name and value.
 
+A Blend4 Node blends two pairs of animations.
+
+The two pairs are blended like blend2 and then added together.
+
 .. _class_AnimationTreePlayer_connect_nodes:
 
 - :ref:`int<class_int>` **connect_nodes** **(** :ref:`String<class_string>` id, :ref:`String<class_string>` dst_id, :ref:`int<class_int>` dst_input_idx **)**
@@ -293,7 +323,7 @@ Disconnects nodes connected to ``id`` at the specified input slot.
 
 - :ref:`PoolStringArray<class_poolstringarray>` **get_node_list** **(** **)**
 
-Returns a PoolStringArray containing the name of all nodes.
+Returns a :ref:`PoolStringArray<class_poolstringarray>` containing the name of all nodes.
 
 .. _class_AnimationTreePlayer_mix_node_get_amount:
 
@@ -307,6 +337,8 @@ Returns mix amount of a Mix node given its name.
 
 Sets mix amount of a Mix node given its name and value.
 
+A Mix node adds input b to input a by a the amount given by ratio.
+
 .. _class_AnimationTreePlayer_node_exists:
 
 - :ref:`bool<class_bool>` **node_exists** **(** :ref:`String<class_string>` node **)** const
@@ -449,7 +481,7 @@ Removes the animation node with name ``id``.
 
 - void **reset** **(** **)**
 
-Resets this AnimationTreePlayer.
+Resets this ``AnimationTreePlayer``.
 
 .. _class_AnimationTreePlayer_timescale_node_get_scale:
 
@@ -463,12 +495,18 @@ Returns time scale value of the TimeScale node with name ``id``.
 
 Sets the time scale of the TimeScale node with name ``id`` to ``scale``.
 
+The timescale node is used to speed :ref:`Animation<class_animation>`\ s up if the scale is above 1 or slow them down if it is below 1.
+
+If applied after a blend or mix, affects all input animations to that blend or mix.
+
 .. _class_AnimationTreePlayer_timeseek_node_seek:
 
 - void **timeseek_node_seek** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` seconds **)**
 
 Sets the time seek value of the TimeSeek node with name ``id`` to ``seconds``
 
+This functions as a seek in the :ref:`Animation<class_animation>` or the blend or mix of :ref:`Animation<class_animation>`\ s input in it.
+
 .. _class_AnimationTreePlayer_transition_node_delete_input:
 
 - void **transition_node_delete_input** **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx **)**
@@ -485,7 +523,7 @@ Returns the index of the currently evaluated input for the transition node with
 
 - :ref:`int<class_int>` **transition_node_get_input_count** **(** :ref:`String<class_string>` id **)** const
 
-Returns the number of inputs for the transition node with name ``id``.
+Returns the number of inputs for the transition node with name ``id``. You can add inputs by rightclicking on the transition node.
 
 .. _class_AnimationTreePlayer_transition_node_get_xfade_time:
 

+ 4 - 4
classes/class_arvrserver.rst

@@ -44,25 +44,25 @@ Signals
 
 .. _class_ARVRServer_interface_added:
 
-- **interface_added** **(** :ref:`String<class_string>` name **)**
+- **interface_added** **(** :ref:`String<class_string>` interface_name **)**
 
 Signal send when a new interface has been added.
 
 .. _class_ARVRServer_interface_removed:
 
-- **interface_removed** **(** :ref:`String<class_string>` name **)**
+- **interface_removed** **(** :ref:`String<class_string>` interface_name **)**
 
 Signal send when an interface is removed.
 
 .. _class_ARVRServer_tracker_added:
 
-- **tracker_added** **(** :ref:`String<class_string>` name, :ref:`int<class_int>` type, :ref:`int<class_int>` id **)**
+- **tracker_added** **(** :ref:`String<class_string>` tracker_name, :ref:`int<class_int>` type, :ref:`int<class_int>` id **)**
 
 Signal send when a new tracker has been added. If you don't use a fixed number of controllers or if you're using ARVRAnchors for an AR solution it is important to react to this signal and add the appropriate ARVRController or ARVRAnchor node related to this new tracker.
 
 .. _class_ARVRServer_tracker_removed:
 
-- **tracker_removed** **(** :ref:`String<class_string>` name, :ref:`int<class_int>` type, :ref:`int<class_int>` id **)**
+- **tracker_removed** **(** :ref:`String<class_string>` tracker_name, :ref:`int<class_int>` type, :ref:`int<class_int>` id **)**
 
 Signal send when a tracker is removed, you should remove any ARVRController or ARVRAnchor points if applicable. This is not mandatory, the nodes simply become inactive and will be made active again when a new tracker becomes available (i.e. a new controller is switched on that takes the place of the previous one).
 

+ 9 - 3
classes/class_control.rst

@@ -38,7 +38,7 @@ Member Functions
 +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | void                             | :ref:`add_shader_override<class_Control_add_shader_override>` **(** :ref:`String<class_string>` name, :ref:`Shader<class_shader>` shader **)**                                                                                     |
 +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| void                             | :ref:`add_style_override<class_Control_add_style_override>` **(** :ref:`String<class_string>` name, :ref:`StyleBox<class_stylebox>` stylebox **)**                                                                                 |
+| void                             | :ref:`add_stylebox_override<class_Control_add_stylebox_override>` **(** :ref:`String<class_string>` name, :ref:`StyleBox<class_stylebox>` stylebox **)**                                                                           |
 +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | :ref:`bool<class_bool>`          | :ref:`can_drop_data<class_Control_can_drop_data>` **(** :ref:`Vector2<class_vector2>` position, :ref:`Variant<class_variant>` data **)** virtual                                                                                   |
 +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -106,6 +106,8 @@ Member Functions
 +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | :ref:`bool<class_bool>`          | :ref:`has_point<class_Control_has_point>` **(** :ref:`Vector2<class_vector2>` point **)** virtual                                                                                                                                  |
 +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| :ref:`bool<class_bool>`          | :ref:`has_shader_override<class_Control_has_shader_override>` **(** :ref:`String<class_string>` name **)** const                                                                                                                   |
++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | :ref:`bool<class_bool>`          | :ref:`has_stylebox<class_Control_has_stylebox>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const                                                                                            |
 +----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | :ref:`bool<class_bool>`          | :ref:`has_stylebox_override<class_Control_has_stylebox_override>` **(** :ref:`String<class_string>` name **)** const                                                                                                               |
@@ -510,9 +512,9 @@ Overrides the ``name`` icon in the theme resource the node uses. If ``icon`` is
 
 Overrides the ``name`` shader in the theme resource the node uses. If ``shader`` is empty, Godot clears the override.
 
-.. _class_Control_add_style_override:
+.. _class_Control_add_stylebox_override:
 
-- void **add_style_override** **(** :ref:`String<class_string>` name, :ref:`StyleBox<class_stylebox>` stylebox **)**
+- void **add_stylebox_override** **(** :ref:`String<class_string>` name, :ref:`StyleBox<class_stylebox>` stylebox **)**
 
 Overrides the ``name`` Stylebox in the theme resource the node uses. If ``stylebox`` is empty, Godot clears the override.
 
@@ -668,6 +670,10 @@ Return whether the Control is the current focused control (see :ref:`set_focus_m
 
 - :ref:`bool<class_bool>` **has_point** **(** :ref:`Vector2<class_vector2>` point **)** virtual
 
+.. _class_Control_has_shader_override:
+
+- :ref:`bool<class_bool>` **has_shader_override** **(** :ref:`String<class_string>` name **)** const
+
 .. _class_Control_has_stylebox:
 
 - :ref:`bool<class_bool>` **has_stylebox** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type="" **)** const

+ 1 - 1
classes/class_engine.rst

@@ -48,7 +48,7 @@ Member Variables
 
   .. _class_Engine_target_fps:
 
-- :ref:`float<class_float>` **target_fps** - The desired frames per second. If the hardware cannot keep up, this setting may not be respected. Defaults to 0, which indicates no limit.
+- :ref:`int<class_int>` **target_fps** - The desired frames per second. If the hardware cannot keep up, this setting may not be respected. Defaults to 0, which indicates no limit.
 
   .. _class_Engine_time_scale:
 

+ 10 - 4
classes/class_node.rst

@@ -198,7 +198,13 @@ Emitted when the node enters the tree.
 
 - **tree_exited** **(** **)**
 
-Emitted when the node exits the tree.
+Emitted after the node exits the tree and is no longer active.
+
+.. _class_Node_tree_exiting:
+
+- **tree_exiting** **(** **)**
+
+Emitted when the node is still active but about to exit the tree. This is the right place for de-initialization.
 
 
 Member Variables
@@ -227,7 +233,7 @@ Numeric Constants
 -----------------
 
 - **NOTIFICATION_ENTER_TREE** = **10** --- Notification received when the node enters a :ref:`SceneTree<class_scenetree>`.
-- **NOTIFICATION_EXIT_TREE** = **11** --- Notification received when the node exits a :ref:`SceneTree<class_scenetree>`.
+- **NOTIFICATION_EXIT_TREE** = **11** --- Notification received when the node is about to exit a :ref:`SceneTree<class_scenetree>`.
 - **NOTIFICATION_MOVED_IN_PARENT** = **12** --- Notification received when the node is moved in the parent.
 - **NOTIFICATION_READY** = **13** --- Notification received when the node is ready. See :ref:`_ready<class_Node__ready>`.
 - **NOTIFICATION_PAUSED** = **14** --- Notification received when the node is paused.
@@ -313,9 +319,9 @@ Corresponds to the NOTIFICATION_ENTER_TREE notification in :ref:`Object._notific
 
 - void **_exit_tree** **(** **)** virtual
 
-Called when the node leaves the :ref:`SceneTree<class_scenetree>` (e.g. upon freeing, scene changing, or after calling :ref:`remove_child<class_Node_remove_child>` in a script). If the node has children, its :ref:`_exit_tree<class_Node__exit_tree>` callback will be called last, after all its children have left the tree.
+Called when the node is about to leave the :ref:`SceneTree<class_scenetree>` (e.g. upon freeing, scene changing, or after calling :ref:`remove_child<class_Node_remove_child>` in a script). If the node has children, its :ref:`_exit_tree<class_Node__exit_tree>` callback will be called last, after all its children have left the tree.
 
-Corresponds to the NOTIFICATION_EXIT_TREE notification in :ref:`Object._notification<class_Object__notification>`.
+Corresponds to the NOTIFICATION_EXIT_TREE notification in :ref:`Object._notification<class_Object__notification>` and signal :ref:`tree_exiting<class_Node_tree_exiting>`. To get notified when the node has already left the active tree, connect to the :ref:`tree_exited<class_Node_tree_exited>`
 
 .. _class_Node__input:
 

+ 1 - 1
classes/class_proximitygroup.rst

@@ -28,7 +28,7 @@ Signals
 
 .. _class_ProximityGroup_broadcast:
 
-- **broadcast** **(** :ref:`String<class_string>` name, :ref:`Array<class_array>` parameters **)**
+- **broadcast** **(** :ref:`String<class_string>` group_name, :ref:`Array<class_array>` parameters **)**
 
 
 Member Variables

+ 24 - 24
classes/class_streampeer.rst

@@ -54,33 +54,33 @@ Member Functions
 +--------------------------------+-----------------------------------------------------------------------------------------------------------------------+
 | :ref:`Variant<class_variant>`  | :ref:`get_var<class_StreamPeer_get_var>` **(** **)**                                                                  |
 +--------------------------------+-----------------------------------------------------------------------------------------------------------------------+
-| void                           | :ref:`put_16<class_StreamPeer_put_16>` **(** :ref:`int<class_int>` val **)**                                          |
+| void                           | :ref:`put_16<class_StreamPeer_put_16>` **(** :ref:`int<class_int>` value **)**                                        |
 +--------------------------------+-----------------------------------------------------------------------------------------------------------------------+
-| void                           | :ref:`put_32<class_StreamPeer_put_32>` **(** :ref:`int<class_int>` val **)**                                          |
+| void                           | :ref:`put_32<class_StreamPeer_put_32>` **(** :ref:`int<class_int>` value **)**                                        |
 +--------------------------------+-----------------------------------------------------------------------------------------------------------------------+
-| void                           | :ref:`put_64<class_StreamPeer_put_64>` **(** :ref:`int<class_int>` val **)**                                          |
+| void                           | :ref:`put_64<class_StreamPeer_put_64>` **(** :ref:`int<class_int>` value **)**                                        |
 +--------------------------------+-----------------------------------------------------------------------------------------------------------------------+
-| void                           | :ref:`put_8<class_StreamPeer_put_8>` **(** :ref:`int<class_int>` val **)**                                            |
+| void                           | :ref:`put_8<class_StreamPeer_put_8>` **(** :ref:`int<class_int>` value **)**                                          |
 +--------------------------------+-----------------------------------------------------------------------------------------------------------------------+
 | :ref:`int<class_int>`          | :ref:`put_data<class_StreamPeer_put_data>` **(** :ref:`PoolByteArray<class_poolbytearray>` data **)**                 |
 +--------------------------------+-----------------------------------------------------------------------------------------------------------------------+
-| void                           | :ref:`put_double<class_StreamPeer_put_double>` **(** :ref:`float<class_float>` val **)**                              |
+| void                           | :ref:`put_double<class_StreamPeer_put_double>` **(** :ref:`float<class_float>` value **)**                            |
 +--------------------------------+-----------------------------------------------------------------------------------------------------------------------+
-| void                           | :ref:`put_float<class_StreamPeer_put_float>` **(** :ref:`float<class_float>` val **)**                                |
+| void                           | :ref:`put_float<class_StreamPeer_put_float>` **(** :ref:`float<class_float>` value **)**                              |
 +--------------------------------+-----------------------------------------------------------------------------------------------------------------------+
 | :ref:`Array<class_array>`      | :ref:`put_partial_data<class_StreamPeer_put_partial_data>` **(** :ref:`PoolByteArray<class_poolbytearray>` data **)** |
 +--------------------------------+-----------------------------------------------------------------------------------------------------------------------+
-| void                           | :ref:`put_u16<class_StreamPeer_put_u16>` **(** :ref:`int<class_int>` val **)**                                        |
+| void                           | :ref:`put_u16<class_StreamPeer_put_u16>` **(** :ref:`int<class_int>` value **)**                                      |
 +--------------------------------+-----------------------------------------------------------------------------------------------------------------------+
-| void                           | :ref:`put_u32<class_StreamPeer_put_u32>` **(** :ref:`int<class_int>` val **)**                                        |
+| void                           | :ref:`put_u32<class_StreamPeer_put_u32>` **(** :ref:`int<class_int>` value **)**                                      |
 +--------------------------------+-----------------------------------------------------------------------------------------------------------------------+
-| void                           | :ref:`put_u64<class_StreamPeer_put_u64>` **(** :ref:`int<class_int>` val **)**                                        |
+| void                           | :ref:`put_u64<class_StreamPeer_put_u64>` **(** :ref:`int<class_int>` value **)**                                      |
 +--------------------------------+-----------------------------------------------------------------------------------------------------------------------+
-| void                           | :ref:`put_u8<class_StreamPeer_put_u8>` **(** :ref:`int<class_int>` val **)**                                          |
+| void                           | :ref:`put_u8<class_StreamPeer_put_u8>` **(** :ref:`int<class_int>` value **)**                                        |
 +--------------------------------+-----------------------------------------------------------------------------------------------------------------------+
-| void                           | :ref:`put_utf8_string<class_StreamPeer_put_utf8_string>` **(** :ref:`String<class_string>` val **)**                  |
+| void                           | :ref:`put_utf8_string<class_StreamPeer_put_utf8_string>` **(** :ref:`String<class_string>` value **)**                |
 +--------------------------------+-----------------------------------------------------------------------------------------------------------------------+
-| void                           | :ref:`put_var<class_StreamPeer_put_var>` **(** :ref:`Variant<class_variant>` val **)**                                |
+| void                           | :ref:`put_var<class_StreamPeer_put_var>` **(** :ref:`Variant<class_variant>` value **)**                              |
 +--------------------------------+-----------------------------------------------------------------------------------------------------------------------+
 
 Member Variables
@@ -197,25 +197,25 @@ Get a Variant from the stream.
 
 .. _class_StreamPeer_put_16:
 
-- void **put_16** **(** :ref:`int<class_int>` val **)**
+- void **put_16** **(** :ref:`int<class_int>` value **)**
 
 Put a signed 16 bit value into the stream.
 
 .. _class_StreamPeer_put_32:
 
-- void **put_32** **(** :ref:`int<class_int>` val **)**
+- void **put_32** **(** :ref:`int<class_int>` value **)**
 
 Put a signed 32 bit value into the stream.
 
 .. _class_StreamPeer_put_64:
 
-- void **put_64** **(** :ref:`int<class_int>` val **)**
+- void **put_64** **(** :ref:`int<class_int>` value **)**
 
 Put a signed 64 bit value into the stream.
 
 .. _class_StreamPeer_put_8:
 
-- void **put_8** **(** :ref:`int<class_int>` val **)**
+- void **put_8** **(** :ref:`int<class_int>` value **)**
 
 Put a signed byte into the stream.
 
@@ -227,13 +227,13 @@ Send a chunk of data through the connection, blocking if necessary until the dat
 
 .. _class_StreamPeer_put_double:
 
-- void **put_double** **(** :ref:`float<class_float>` val **)**
+- void **put_double** **(** :ref:`float<class_float>` value **)**
 
 Put a double-precision float into the stream.
 
 .. _class_StreamPeer_put_float:
 
-- void **put_float** **(** :ref:`float<class_float>` val **)**
+- void **put_float** **(** :ref:`float<class_float>` value **)**
 
 Put a single-precision float into the stream.
 
@@ -245,37 +245,37 @@ Send a chunk of data through the connection, if all the data could not be sent a
 
 .. _class_StreamPeer_put_u16:
 
-- void **put_u16** **(** :ref:`int<class_int>` val **)**
+- void **put_u16** **(** :ref:`int<class_int>` value **)**
 
 Put an unsigned 16 bit value into the stream.
 
 .. _class_StreamPeer_put_u32:
 
-- void **put_u32** **(** :ref:`int<class_int>` val **)**
+- void **put_u32** **(** :ref:`int<class_int>` value **)**
 
 Put an unsigned 32 bit value into the stream.
 
 .. _class_StreamPeer_put_u64:
 
-- void **put_u64** **(** :ref:`int<class_int>` val **)**
+- void **put_u64** **(** :ref:`int<class_int>` value **)**
 
 Put an unsigned 64 bit value into the stream.
 
 .. _class_StreamPeer_put_u8:
 
-- void **put_u8** **(** :ref:`int<class_int>` val **)**
+- void **put_u8** **(** :ref:`int<class_int>` value **)**
 
 Put an unsigned byte into the stream.
 
 .. _class_StreamPeer_put_utf8_string:
 
-- void **put_utf8_string** **(** :ref:`String<class_string>` val **)**
+- void **put_utf8_string** **(** :ref:`String<class_string>` value **)**
 
 Put a zero-terminated utf8 string into the stream.
 
 .. _class_StreamPeer_put_var:
 
-- void **put_var** **(** :ref:`Variant<class_variant>` val **)**
+- void **put_var** **(** :ref:`Variant<class_variant>` value **)**
 
 Put a Variant into the stream.