godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2025-12-31 17:49:03 +03:00
Code Issues Packages Projects Releases Wiki Activity

Sync classref with current source

Browse Source
This commit is contained in:
Rémi Verschelde
2019-03-10 11:31:52 +01:00
parent d0eacac884
commit b53578efd5
26 changed files with 161 additions and 91 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
classes/class_@gdscript.rst
View File

@@ -112,19 +112,19 @@ Methods
+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Resource<class_Resource>` | :ref:`preload<class_@GDScript_method_preload>` **(** :ref:`String<class_String>` path **)** |
+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`print<class_@GDScript_method_print>` **(** **)** vararg |
| void | :ref:`print<class_@GDScript_method_print>` **(** ... **)** vararg |
+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`print_debug<class_@GDScript_method_print_debug>` **(** **)** vararg |
| void | :ref:`print_debug<class_@GDScript_method_print_debug>` **(** ... **)** vararg |
+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`print_stack<class_@GDScript_method_print_stack>` **(** **)** |
+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`printerr<class_@GDScript_method_printerr>` **(** **)** vararg |
| void | :ref:`printerr<class_@GDScript_method_printerr>` **(** ... **)** vararg |
+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`printraw<class_@GDScript_method_printraw>` **(** **)** vararg |
| void | :ref:`printraw<class_@GDScript_method_printraw>` **(** ... **)** vararg |
+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`prints<class_@GDScript_method_prints>` **(** **)** vararg |
| void | :ref:`prints<class_@GDScript_method_prints>` **(** ... **)** vararg |
+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`printt<class_@GDScript_method_printt>` **(** **)** vararg |
| void | :ref:`printt<class_@GDScript_method_printt>` **(** ... **)** vararg |
+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`push_error<class_@GDScript_method_push_error>` **(** :ref:`String<class_String>` message **)** |
+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -142,7 +142,7 @@ Methods
+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`randomize<class_@GDScript_method_randomize>` **(** **)** |
+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_Array>` | :ref:`range<class_@GDScript_method_range>` **(** **)** vararg |
| :ref:`Array<class_Array>` | :ref:`range<class_@GDScript_method_range>` **(** ... **)** vararg |
+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`range_lerp<class_@GDScript_method_range_lerp>` **(** :ref:`float<class_float>` value, :ref:`float<class_float>` istart, :ref:`float<class_float>` istop, :ref:`float<class_float>` ostart, :ref:`float<class_float>` ostop **)** |
+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -160,7 +160,7 @@ Methods
+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`stepify<class_@GDScript_method_stepify>` **(** :ref:`float<class_float>` s, :ref:`float<class_float>` step **)** |
+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`str<class_@GDScript_method_str>` **(** **)** vararg |
| :ref:`String<class_String>` | :ref:`str<class_@GDScript_method_str>` **(** ... **)** vararg |
+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_Variant>` | :ref:`str2var<class_@GDScript_method_str2var>` **(** :ref:`String<class_String>` string **)** |
+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -777,7 +777,7 @@ Returns a resource from the filesystem that is loaded during script parsing.
.. _class_@GDScript_method_print:
- void **print** **(** **)** vararg
- void **print** **(** ... **)** vararg
Converts one or more arguments to strings in the best way possible and prints them to the console.
@@ -788,7 +788,7 @@ Converts one or more arguments to strings in the best way possible and prints th
.. _class_@GDScript_method_print_debug:
- void **print_debug** **(** **)** vararg
- void **print_debug** **(** ... **)** vararg
Like :ref:`print<class_@GDScript_method_print>`, but prints only when used in debug mode.
@@ -806,7 +806,7 @@ Output in the console would look something like this:
.. _class_@GDScript_method_printerr:
- void **printerr** **(** **)** vararg
- void **printerr** **(** ... **)** vararg
Prints one or more arguments to strings in the best way possible to standard error line.
@@ -816,7 +816,7 @@ Prints one or more arguments to strings in the best way possible to standard err
.. _class_@GDScript_method_printraw:
- void **printraw** **(** **)** vararg
- void **printraw** **(** ... **)** vararg
Prints one or more arguments to strings in the best way possible to console. No newline is added at the end.
@@ -828,7 +828,7 @@ Prints one or more arguments to strings in the best way possible to console. No
.. _class_@GDScript_method_prints:
- void **prints** **(** **)** vararg
- void **prints** **(** ... **)** vararg
Prints one or more arguments to the console with a space between each argument.
@@ -838,7 +838,7 @@ Prints one or more arguments to the console with a space between each argument.
.. _class_@GDScript_method_printt:
- void **printt** **(** **)** vararg
- void **printt** **(** ... **)** vararg
Prints one or more arguments to the console with a tab between each argument.
@@ -928,7 +928,7 @@ Randomizes the seed (or the internal state) of the random number generator. Curr
.. _class_@GDScript_method_range:
- :ref:`Array<class_Array>` **range** **(** **)** vararg
- :ref:`Array<class_Array>` **range** **(** ... **)** vararg
Returns an array with the given range. Range can be 1 argument N (0 to N-1), two arguments (initial, final-1) or three arguments (initial, final-1, increment).
@@ -1040,7 +1040,7 @@ Snaps float value ``s`` to a given ``step``.
.. _class_@GDScript_method_str:
- :ref:`String<class_String>` **str** **(** **)** vararg
- :ref:`String<class_String>` **str** **(** ... **)** vararg
Converts one or more arguments to string in the best way possible.

4
classes/class_animationplayer.rst
View File

@@ -278,7 +278,7 @@ Adds ``animation`` to the player accessible with the key ``name``.
- void **advance** **(** :ref:`float<class_float>` delta **)**
Shifts position in the animation timeline. Delta is the time in seconds to shift.
Shifts position in the animation timeline. Delta is the time in seconds to shift. Events between the current frame and ``delta`` are handled.
.. _class_AnimationPlayer_method_animation_get_next:
@@ -388,7 +388,7 @@ Rename an existing animation with key ``name`` to ``newname``.
- void **seek** **(** :ref:`float<class_float>` seconds, :ref:`bool<class_bool>` update=false **)**
Seek the animation to the ``seconds`` point in time (in seconds). If ``update`` is ``true``, the animation updates too, otherwise it updates at process time.
Seek the animation to the ``seconds`` point in time (in seconds). If ``update`` is ``true``, the animation updates too, otherwise it updates at process time. Events between the current frame and ``seconds`` are skipped.
.. _class_AnimationPlayer_method_set_blend_time:

2
classes/class_animationtreeplayer.rst
View File

@@ -282,7 +282,7 @@ Adds a ``type`` node to the graph with name ``id``.
- void **advance** **(** :ref:`float<class_float>` delta **)**
Shifts position in the animation timeline. Delta is the time in seconds to shift.
Shifts position in the animation timeline. Delta is the time in seconds to shift. Events between the current frame and ``delta`` are handled.
.. _class_AnimationTreePlayer_method_animation_node_get_animation:

8
classes/class_arraymesh.rst
View File

@@ -33,8 +33,6 @@ Methods
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_surface_from_arrays<class_ArrayMesh_method_add_surface_from_arrays>` **(** :ref:`PrimitiveType<enum_Mesh_PrimitiveType>` primitive, :ref:`Array<class_Array>` arrays, :ref:`Array<class_Array>` blend_shapes=[ ], :ref:`int<class_int>` compress_flags=97280 **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`center_geometry<class_ArrayMesh_method_center_geometry>` **(** **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_blend_shapes<class_ArrayMesh_method_clear_blend_shapes>` **(** **)** |
+-----------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_blend_shape_count<class_ArrayMesh_method_get_blend_shape_count>` **(** **)** const |
@@ -235,12 +233,6 @@ Adding an index array puts this function into "index mode" where the vertex and
Godot uses clockwise winding order for front faces of triangle primitive modes.
.. _class_ArrayMesh_method_center_geometry:
- void **center_geometry** **(** **)**
Centers the geometry.
.. _class_ArrayMesh_method_clear_blend_shapes:
- void **clear_blend_shapes** **(** **)**

8
classes/class_csharpscript.rst
View File

@@ -19,14 +19,14 @@ Brief Description
Methods
-------
+-----------------------------+--------------------------------------------------------------+
| :ref:`Object<class_Object>` | :ref:`new<class_CSharpScript_method_new>` **(** **)** vararg |
+-----------------------------+--------------------------------------------------------------+
+-----------------------------+------------------------------------------------------------------+
| :ref:`Object<class_Object>` | :ref:`new<class_CSharpScript_method_new>` **(** ... **)** vararg |
+-----------------------------+------------------------------------------------------------------+
Method Descriptions
-------------------
.. _class_CSharpScript_method_new:
- :ref:`Object<class_Object>` **new** **(** **)** vararg
- :ref:`Object<class_Object>` **new** **(** ... **)** vararg

2
classes/class_font.rst
View File

@@ -44,7 +44,7 @@ Methods
Description
-----------
Font contains a unicode compatible character set, as well as the ability to draw it with variable width, ascent, descent and kerning. For creating fonts from TTF files (or other font formats), see the editor support for fonts. TODO check wikipedia for graph of ascent/baseline/descent/height/etc.
Font contains a unicode compatible character set, as well as the ability to draw it with variable width, ascent, descent and kerning. For creating fonts from TTF files (or other font formats), see the editor support for fonts.
Method Descriptions
-------------------

4
classes/class_funcref.rst
View File

@@ -20,7 +20,7 @@ Methods
-------
+-------------------------------+---------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_Variant>` | :ref:`call_func<class_FuncRef_method_call_func>` **(** **)** vararg |
| :ref:`Variant<class_Variant>` | :ref:`call_func<class_FuncRef_method_call_func>` **(** ... **)** vararg |
+-------------------------------+---------------------------------------------------------------------------------------------------------+
| void | :ref:`set_function<class_FuncRef_method_set_function>` **(** :ref:`String<class_String>` name **)** |
+-------------------------------+---------------------------------------------------------------------------------------------------------+
@@ -39,7 +39,7 @@ Method Descriptions
.. _class_FuncRef_method_call_func:
- :ref:`Variant<class_Variant>` **call_func** **(** **)** vararg
- :ref:`Variant<class_Variant>` **call_func** **(** ... **)** vararg
Calls the referenced function previously set by :ref:`set_function<class_FuncRef_method_set_function>` or :ref:`@GDScript.funcref<class_@GDScript_method_funcref>`.

4
classes/class_gdscript.rst
View File

@@ -22,7 +22,7 @@ Methods
+-------------------------------------------+-----------------------------------------------------------------------------------+
| :ref:`PoolByteArray<class_PoolByteArray>` | :ref:`get_as_byte_code<class_GDScript_method_get_as_byte_code>` **(** **)** const |
+-------------------------------------------+-----------------------------------------------------------------------------------+
| :ref:`Object<class_Object>` | :ref:`new<class_GDScript_method_new>` **(** **)** vararg |
| :ref:`Object<class_Object>` | :ref:`new<class_GDScript_method_new>` **(** ... **)** vararg |
+-------------------------------------------+-----------------------------------------------------------------------------------+
Description
@@ -48,7 +48,7 @@ Returns byte code for the script source code.
.. _class_GDScript_method_new:
- :ref:`Object<class_Object>` **new** **(** **)** vararg
- :ref:`Object<class_Object>` **new** **(** ... **)** vararg
Returns a new instance of the script.

8
classes/class_input.rst
View File

@@ -90,6 +90,8 @@ Methods
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_mouse_mode<class_Input_method_set_mouse_mode>` **(** :ref:`MouseMode<enum_Input_MouseMode>` mode **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_use_accumulated_input<class_Input_method_set_use_accumulated_input>` **(** :ref:`bool<class_bool>` enable **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`start_joy_vibration<class_Input_method_start_joy_vibration>` **(** :ref:`int<class_int>` device, :ref:`float<class_float>` weak_magnitude, :ref:`float<class_float>` strong_magnitude, :ref:`float<class_float>` duration=0 **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`stop_joy_vibration<class_Input_method_stop_joy_vibration>` **(** :ref:`int<class_int>` device **)** |
@@ -428,6 +430,12 @@ Note that if you want to change the default cursor shape for :ref:`Control<class
Set the mouse mode. See the constants for more information.
.. _class_Input_method_set_use_accumulated_input:
- void **set_use_accumulated_input** **(** :ref:`bool<class_bool>` enable **)**
Whether to accumulate similar input events sent by the operating system. Defaults to ``true``.
.. _class_Input_method_start_joy_vibration:
- void **start_joy_vibration** **(** :ref:`int<class_int>` device, :ref:`float<class_float>` weak_magnitude, :ref:`float<class_float>` strong_magnitude, :ref:`float<class_float>` duration=0 **)**

6
classes/class_inputevent.rst
View File

@@ -28,6 +28,8 @@ Properties
Methods
-------
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`accumulate<class_InputEvent_method_accumulate>` **(** :ref:`InputEvent<class_InputEvent>` with_event **)** |
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`as_text<class_InputEvent_method_as_text>` **(** **)** const |
+-------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -80,6 +82,10 @@ The event's device ID.
Method Descriptions
-------------------
.. _class_InputEvent_method_accumulate:
- :ref:`bool<class_bool>` **accumulate** **(** :ref:`InputEvent<class_InputEvent>` with_event **)**
.. _class_InputEvent_method_as_text:
- :ref:`String<class_String>` **as_text** **(** **)** const

6
classes/class_kinematicbody.rst
View File

@@ -45,7 +45,7 @@ Methods
+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_on_wall<class_KinematicBody_method_is_on_wall>` **(** **)** const |
+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`KinematicCollision<class_KinematicCollision>` | :ref:`move_and_collide<class_KinematicBody_method_move_and_collide>` **(** :ref:`Vector3<class_Vector3>` rel_vec, :ref:`bool<class_bool>` infinite_inertia=true, :ref:`bool<class_bool>` test_only=false **)** |
| :ref:`KinematicCollision<class_KinematicCollision>` | :ref:`move_and_collide<class_KinematicBody_method_move_and_collide>` **(** :ref:`Vector3<class_Vector3>` rel_vec, :ref:`bool<class_bool>` infinite_inertia=true, :ref:`bool<class_bool>` exclude_raycast_shapes=true, :ref:`bool<class_bool>` test_only=false **)** |
+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`move_and_slide<class_KinematicBody_method_move_and_slide>` **(** :ref:`Vector3<class_Vector3>` linear_velocity, :ref:`Vector3<class_Vector3>` floor_normal=Vector3( 0, 0, 0 ), :ref:`bool<class_bool>` stop_on_slope=false, :ref:`int<class_int>` max_slides=4, :ref:`float<class_float>` floor_max_angle=0.785398, :ref:`bool<class_bool>` infinite_inertia=true **)** |
+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -160,7 +160,7 @@ Returns ``true`` if the body is on a wall. Only updates when calling :ref:`move_
.. _class_KinematicBody_method_move_and_collide:
- :ref:`KinematicCollision<class_KinematicCollision>` **move_and_collide** **(** :ref:`Vector3<class_Vector3>` rel_vec, :ref:`bool<class_bool>` infinite_inertia=true, :ref:`bool<class_bool>` test_only=false **)**
- :ref:`KinematicCollision<class_KinematicCollision>` **move_and_collide** **(** :ref:`Vector3<class_Vector3>` rel_vec, :ref:`bool<class_bool>` infinite_inertia=true, :ref:`bool<class_bool>` exclude_raycast_shapes=true, :ref:`bool<class_bool>` test_only=false **)**
Moves the body along the vector ``rel_vec``. The body will stop if it collides. Returns a :ref:`KinematicCollision<class_KinematicCollision>`, which contains information about the collision.
@@ -176,7 +176,7 @@ Moves the body along a vector. If the body collides with another, it will slide
``floor_normal`` 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 ``Vector3(0, 0, 0)``, everything is considered a wall. This is useful for topdown games.
*TODO: Update for new stop_on_slode argument.* If the body is standing on a slope and the horizontal speed (relative to the floor's speed) goes below ``slope_stop_min_velocity``, the body will stop completely. This prevents the body from sliding down slopes when you include gravity in ``linear_velocity``. When set to lower values, the body will not be able to stand still on steep slopes.
If the body is standing on a slope and the horizontal speed (relative to the floor's speed) goes below ``slope_stop_min_velocity``, the body will stop completely. This prevents the body from sliding down slopes when you include gravity in ``linear_velocity``. 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 ``max_slides`` times before it stops.

4
classes/class_kinematicbody2d.rst
View File

@@ -84,7 +84,7 @@ If the body is at least this close to another body, this body will consider them
| *Getter* | is_sync_to_physics_enabled() |
+----------+------------------------------+
If ``true``, the body's movement will be synchronized to the physics frame. This is useful when animating movement via :ref:`AnimationPlayer<class_AnimationPlayer>`, for example on moving platforms.
If ``true``, the body's movement will be synchronized to the physics frame. This is useful when animating movement via :ref:`AnimationPlayer<class_AnimationPlayer>`, for example on moving platforms. Do **not** use together with :ref:`move_and_slide<class_KinematicBody2D_method_move_and_slide>` or :ref:`move_and_collide<class_KinematicBody2D_method_move_and_collide>` functions.
Method Descriptions
-------------------
@@ -141,7 +141,7 @@ Moves the body along a vector. If the body collides with another, it will slide
``floor_normal`` 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 ``Vector2(0, 0)``, everything is considered a wall. This is useful for topdown games.
*TODO: Update for stop_on_slope argument.* If the body is standing on a slope and the horizontal speed (relative to the floor's speed) goes below ``slope_stop_min_velocity``, the body will stop completely. This prevents the body from sliding down slopes when you include gravity in ``linear_velocity``. When set to lower values, the body will not be able to stand still on steep slopes.
If the body is standing on a slope and the horizontal speed (relative to the floor's speed) goes below ``slope_stop_min_velocity``, the body will stop completely. This prevents the body from sliding down slopes when you include gravity in ``linear_velocity``. 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 ``max_slides`` times before it stops.

2
classes/class_multimesh.rst
View File

@@ -212,6 +212,8 @@ Return the transform of a specific instance.
Set the color of a specific instance.
For the color to take effect, ensure that :ref:`color_format<class_MultiMesh_property_color_format>` is non-``null`` on the ``MultiMesh`` and :ref:`SpatialMaterial.vertex_color_use_as_albedo<class_SpatialMaterial_property_vertex_color_use_as_albedo>` is ``true`` on the material.
.. _class_MultiMesh_method_set_instance_custom_data:
- void **set_instance_custom_data** **(** :ref:`int<class_int>` instance, :ref:`Color<class_Color>` custom_data **)**

4
classes/class_nativescript.rst
View File

@@ -41,7 +41,7 @@ Methods
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_signal_documentation<class_NativeScript_method_get_signal_documentation>` **(** :ref:`String<class_String>` signal_name **)** const |
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_Object>` | :ref:`new<class_NativeScript_method_new>` **(** **)** vararg |
| :ref:`Object<class_Object>` | :ref:`new<class_NativeScript_method_new>` **(** ... **)** vararg |
+-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
Property Descriptions
@@ -116,7 +116,7 @@ Returns the documentation string that was previously set with ``godot_nativescri
.. _class_NativeScript_method_new:
- :ref:`Object<class_Object>` **new** **(** **)** vararg
- :ref:`Object<class_Object>` **new** **(** ... **)** vararg
Constructs a new object of the base type with a script of this type already attached.

16
classes/class_node.rst
View File

@@ -163,15 +163,15 @@ Methods
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`request_ready<class_Node_method_request_ready>` **(** **)** |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_Variant>` | :ref:`rpc<class_Node_method_rpc>` **(** :ref:`String<class_String>` method **)** vararg |
| :ref:`Variant<class_Variant>` | :ref:`rpc<class_Node_method_rpc>` **(** :ref:`String<class_String>` method, ... **)** vararg |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`rpc_config<class_Node_method_rpc_config>` **(** :ref:`String<class_String>` method, :ref:`RPCMode<enum_MultiplayerAPI_RPCMode>` mode **)** |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_Variant>` | :ref:`rpc_id<class_Node_method_rpc_id>` **(** :ref:`int<class_int>` peer_id, :ref:`String<class_String>` method **)** vararg |
| :ref:`Variant<class_Variant>` | :ref:`rpc_id<class_Node_method_rpc_id>` **(** :ref:`int<class_int>` peer_id, :ref:`String<class_String>` method, ... **)** vararg |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_Variant>` | :ref:`rpc_unreliable<class_Node_method_rpc_unreliable>` **(** :ref:`String<class_String>` method **)** vararg |
| :ref:`Variant<class_Variant>` | :ref:`rpc_unreliable<class_Node_method_rpc_unreliable>` **(** :ref:`String<class_String>` method, ... **)** vararg |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_Variant>` | :ref:`rpc_unreliable_id<class_Node_method_rpc_unreliable_id>` **(** :ref:`int<class_int>` peer_id, :ref:`String<class_String>` method **)** vararg |
| :ref:`Variant<class_Variant>` | :ref:`rpc_unreliable_id<class_Node_method_rpc_unreliable_id>` **(** :ref:`int<class_int>` peer_id, :ref:`String<class_String>` method, ... **)** vararg |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`rset<class_Node_method_rset>` **(** :ref:`String<class_String>` property, :ref:`Variant<class_Variant>` value **)** |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -909,7 +909,7 @@ Requests that ``_ready`` be called again.
.. _class_Node_method_rpc:
- :ref:`Variant<class_Variant>` **rpc** **(** :ref:`String<class_String>` method **)** vararg
- :ref:`Variant<class_Variant>` **rpc** **(** :ref:`String<class_String>` method, ... **)** vararg
Sends a remote procedure call request for the given ``method`` to peers on the network (and locally), optionally sending all additional arguments as arguments to the method called by the RPC. The call request will only be received by nodes with the same :ref:`NodePath<class_NodePath>`, including the exact same node name. Behaviour depends on the RPC configuration for the given method, see :ref:`rpc_config<class_Node_method_rpc_config>`. Methods are not exposed to RPCs by default. Also see :ref:`rset<class_Node_method_rset>` and :ref:`rset_config<class_Node_method_rset_config>` for properties. Returns an empty :ref:`Variant<class_Variant>`. Note that you can only safely use RPCs on clients after you received the ``connected_to_server`` signal from the :ref:`SceneTree<class_SceneTree>`. You also need to keep track of the connection state, either by the :ref:`SceneTree<class_SceneTree>` signals like ``server_disconnected`` or by checking ``SceneTree.network_peer.get_connection_status() == CONNECTION_CONNECTED``.
@@ -921,19 +921,19 @@ Changes the RPC mode for the given ``method`` to the given ``mode``. See :ref:`R
.. _class_Node_method_rpc_id:
- :ref:`Variant<class_Variant>` **rpc_id** **(** :ref:`int<class_int>` peer_id, :ref:`String<class_String>` method **)** vararg
- :ref:`Variant<class_Variant>` **rpc_id** **(** :ref:`int<class_int>` peer_id, :ref:`String<class_String>` method, ... **)** vararg
Sends a :ref:`rpc<class_Node_method_rpc>` to a specific peer identified by ``peer_id`` (see :ref:`NetworkedMultiplayerPeer.set_target_peer<class_NetworkedMultiplayerPeer_method_set_target_peer>`). Returns an empty :ref:`Variant<class_Variant>`.
.. _class_Node_method_rpc_unreliable:
- :ref:`Variant<class_Variant>` **rpc_unreliable** **(** :ref:`String<class_String>` method **)** vararg
- :ref:`Variant<class_Variant>` **rpc_unreliable** **(** :ref:`String<class_String>` method, ... **)** vararg
Sends a :ref:`rpc<class_Node_method_rpc>` using an unreliable protocol. Returns an empty :ref:`Variant<class_Variant>`.
.. _class_Node_method_rpc_unreliable_id:
- :ref:`Variant<class_Variant>` **rpc_unreliable_id** **(** :ref:`int<class_int>` peer_id, :ref:`String<class_String>` method **)** vararg
- :ref:`Variant<class_Variant>` **rpc_unreliable_id** **(** :ref:`int<class_int>` peer_id, :ref:`String<class_String>` method, ... **)** vararg
Sends a :ref:`rpc<class_Node_method_rpc>` to a specific peer identified by ``peer_id`` using an unreliable protocol (see :ref:`NetworkedMultiplayerPeer.set_target_peer<class_NetworkedMultiplayerPeer_method_set_target_peer>`). Returns an empty :ref:`Variant<class_Variant>`.

34
classes/class_noisetexture.rst
View File

@@ -19,17 +19,19 @@ Brief Description
Properties
----------
+-------------------------------------------------+---------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`as_normalmap<class_NoiseTexture_property_as_normalmap>` |
+-------------------------------------------------+---------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`height<class_NoiseTexture_property_height>` |
+-------------------------------------------------+---------------------------------------------------------------+
| :ref:`OpenSimplexNoise<class_OpenSimplexNoise>` | :ref:`noise<class_NoiseTexture_property_noise>` |
+-------------------------------------------------+---------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`seamless<class_NoiseTexture_property_seamless>` |
+-------------------------------------------------+---------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`width<class_NoiseTexture_property_width>` |
+-------------------------------------------------+---------------------------------------------------------------+
+-------------------------------------------------+-----------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`as_normalmap<class_NoiseTexture_property_as_normalmap>` |
+-------------------------------------------------+-----------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`bump_strength<class_NoiseTexture_property_bump_strength>` |
+-------------------------------------------------+-----------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`height<class_NoiseTexture_property_height>` |
+-------------------------------------------------+-----------------------------------------------------------------+
| :ref:`OpenSimplexNoise<class_OpenSimplexNoise>` | :ref:`noise<class_NoiseTexture_property_noise>` |
+-------------------------------------------------+-----------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`seamless<class_NoiseTexture_property_seamless>` |
+-------------------------------------------------+-----------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`width<class_NoiseTexture_property_width>` |
+-------------------------------------------------+-----------------------------------------------------------------+
Description
-----------
@@ -53,6 +55,16 @@ Property Descriptions
If true, the resulting texture contains a normal map created from the original noise interpreted as a bump map.
.. _class_NoiseTexture_property_bump_strength:
- :ref:`float<class_float>` **bump_strength**
+----------+--------------------------+
| *Setter* | set_bump_strength(value) |
+----------+--------------------------+
| *Getter* | get_bump_strength() |
+----------+--------------------------+
.. _class_NoiseTexture_property_height:
- :ref:`int<class_int>` **height**

12
classes/class_object.rst
View File

@@ -32,9 +32,9 @@ Methods
+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_user_signal<class_Object_method_add_user_signal>` **(** :ref:`String<class_String>` signal, :ref:`Array<class_Array>` arguments=[ ] **)** |
+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_Variant>` | :ref:`call<class_Object_method_call>` **(** :ref:`String<class_String>` method **)** vararg |
| :ref:`Variant<class_Variant>` | :ref:`call<class_Object_method_call>` **(** :ref:`String<class_String>` method, ... **)** vararg |
+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_Variant>` | :ref:`call_deferred<class_Object_method_call_deferred>` **(** :ref:`String<class_String>` method **)** vararg |
| :ref:`Variant<class_Variant>` | :ref:`call_deferred<class_Object_method_call_deferred>` **(** :ref:`String<class_String>` method, ... **)** vararg |
+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_Variant>` | :ref:`callv<class_Object_method_callv>` **(** :ref:`String<class_String>` method, :ref:`Array<class_Array>` arg_array **)** |
+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -44,7 +44,7 @@ Methods
+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`disconnect<class_Object_method_disconnect>` **(** :ref:`String<class_String>` signal, :ref:`Object<class_Object>` target, :ref:`String<class_String>` method **)** |
+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_Variant>` | :ref:`emit_signal<class_Object_method_emit_signal>` **(** :ref:`String<class_String>` signal **)** vararg |
| :ref:`Variant<class_Variant>` | :ref:`emit_signal<class_Object_method_emit_signal>` **(** :ref:`String<class_String>` signal, ... **)** vararg |
+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`free<class_Object_method_free>` **(** **)** |
+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -206,13 +206,13 @@ Adds a user-defined ``signal``. Arguments are optional, but can be added as an :
.. _class_Object_method_call:
- :ref:`Variant<class_Variant>` **call** **(** :ref:`String<class_String>` method **)** vararg
- :ref:`Variant<class_Variant>` **call** **(** :ref:`String<class_String>` method, ... **)** vararg
Calls the ``method`` on the object and returns a result. Pass parameters as a comma separated list.
.. _class_Object_method_call_deferred:
- :ref:`Variant<class_Variant>` **call_deferred** **(** :ref:`String<class_String>` method **)** vararg
- :ref:`Variant<class_Variant>` **call_deferred** **(** :ref:`String<class_String>` method, ... **)** vararg
Calls the ``method`` on the object during idle time and returns a result. Pass parameters as a comma separated list.
@@ -242,7 +242,7 @@ Disconnects a ``signal`` from a ``method`` on the given ``target``.
.. _class_Object_method_emit_signal:
- :ref:`Variant<class_Variant>` **emit_signal** **(** :ref:`String<class_String>` signal **)** vararg
- :ref:`Variant<class_Variant>` **emit_signal** **(** :ref:`String<class_String>` signal, ... **)** vararg
Emits the given ``signal``.

8
classes/class_os.rst
View File

@@ -217,6 +217,8 @@ Methods
+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`request_attention<class_OS_method_request_attention>` **(** **)** |
+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`request_permission<class_OS_method_request_permission>` **(** :ref:`String<class_String>` name **)** |
+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_icon<class_OS_method_set_icon>` **(** :ref:`Image<class_Image>` icon **)** |
+-----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_ime_active<class_OS_method_set_ime_active>` **(** :ref:`bool<class_bool>` active **)** |
@@ -1167,6 +1169,12 @@ Shows all resources currently used by the game.
Request the user attention to the window. It'll flash the taskbar button on Windows or bounce the dock icon on OSX.
.. _class_OS_method_request_permission:
- :ref:`bool<class_bool>` **request_permission** **(** :ref:`String<class_String>` name **)**
At the moment this function is only used by ``AudioDriverOpenSL`` to request permission for ``RECORD_AUDIO`` on Android.
.. _class_OS_method_set_icon:
- void **set_icon** **(** :ref:`Image<class_Image>` icon **)**

8
classes/class_pluginscript.rst
View File

@@ -19,16 +19,16 @@ Brief Description
Methods
-------
+-----------------------------+--------------------------------------------------------------+
| :ref:`Object<class_Object>` | :ref:`new<class_PluginScript_method_new>` **(** **)** vararg |
+-----------------------------+--------------------------------------------------------------+
+-----------------------------+------------------------------------------------------------------+
| :ref:`Object<class_Object>` | :ref:`new<class_PluginScript_method_new>` **(** ... **)** vararg |
+-----------------------------+------------------------------------------------------------------+
Method Descriptions
-------------------
.. _class_PluginScript_method_new:
- :ref:`Object<class_Object>` **new** **(** **)** vararg
- :ref:`Object<class_Object>` **new** **(** ... **)** vararg
Returns a new instance of the script.

32
classes/class_projectsettings.rst
View File

@@ -19,6 +19,8 @@ Contains global variables accessible from everywhere.
Properties
----------
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`android/modules<class_ProjectSettings_property_android/modules>` |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`application/boot_splash/bg_color<class_ProjectSettings_property_application/boot_splash/bg_color>` |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -466,10 +468,10 @@ Properties
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`rendering/quality/directional_shadow/size.mobile<class_ProjectSettings_property_rendering/quality/directional_shadow/size.mobile>` |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`rendering/quality/driver/driver_fallback<class_ProjectSettings_property_rendering/quality/driver/driver_fallback>` |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`rendering/quality/driver/driver_name<class_ProjectSettings_property_rendering/quality/driver/driver_name>` |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`rendering/quality/driver/fallback_to_gles2<class_ProjectSettings_property_rendering/quality/driver/fallback_to_gles2>` |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`rendering/quality/filters/anisotropic_filter_level<class_ProjectSettings_property_rendering/quality/filters/anisotropic_filter_level>` |
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`rendering/quality/filters/use_nearest_mipmap_filter<class_ProjectSettings_property_rendering/quality/filters/use_nearest_mipmap_filter>` |
@@ -582,10 +584,18 @@ Contains global variables accessible from everywhere. Use "ProjectSettings.get_s
Property Descriptions
---------------------
.. _class_ProjectSettings_property_android/modules:
- :ref:`String<class_String>` **android/modules**
Comma-separated list of custom Android modules (which must have been built in the Android export templates) using their Java package path, e.g. ``org/godotengine/org/GodotPaymentV3,org/godotengine/godot/MyCustomSingleton"``.
.. _class_ProjectSettings_property_application/boot_splash/bg_color:
- :ref:`Color<class_Color>` **application/boot_splash/bg_color**
Background color for the boot splash.
.. _class_ProjectSettings_property_application/boot_splash/fullsize:
- :ref:`bool<class_bool>` **application/boot_splash/fullsize**
@@ -1632,16 +1642,22 @@ Size in pixels of the directional shadow.
- :ref:`int<class_int>` **rendering/quality/directional_shadow/size.mobile**
.. _class_ProjectSettings_property_rendering/quality/driver/driver_fallback:
- :ref:`String<class_String>` **rendering/quality/driver/driver_fallback**
Whether to allow falling back to other graphics drivers if the preferred driver is not available. Best means use the best working driver (this is the default). Never means never fall back to another driver even if it does not work. This means the project will not run if the preferred driver does not function.
.. _class_ProjectSettings_property_rendering/quality/driver/driver_name:
- :ref:`String<class_String>` **rendering/quality/driver/driver_name**
Name of the configured video driver ("GLES2" or "GLES3").
Note that the backend in use can be overridden at runtime via the ``--video-driver`` command line argument, or by the :ref:`rendering/quality/driver/fallback_to_gles2<class_ProjectSettings_property_rendering/quality/driver/fallback_to_gles2>` option if the target system does not support GLES3 and falls back to GLES2. In such cases, this property is not updated, so use :ref:`OS.get_current_video_driver<class_OS_method_get_current_video_driver>` to query it at runtime.
.. _class_ProjectSettings_property_rendering/quality/driver/fallback_to_gles2:
- :ref:`bool<class_bool>` **rendering/quality/driver/fallback_to_gles2**
Whether to allow falling back to the GLES2 driver if the GLES3 driver is not supported. Default value: ``false``.
Note that the two video drivers are not drop-in replacements for each other, so a game designed for GLES3 might not work properly when falling back to GLES2. In particular, some features of the GLES3 backend are not available in GLES2. Enabling this setting also means that both ETC and ETC2 VRAM-compressed textures will be exported on Android and iOS, increasing the size of the game data pack.
.. _class_ProjectSettings_property_rendering/quality/filters/anisotropic_filter_level:
- :ref:`int<class_int>` **rendering/quality/filters/anisotropic_filter_level**

8
classes/class_scenetree.rst
View File

@@ -47,9 +47,9 @@ Methods
-------
+---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_Variant>` | :ref:`call_group<class_SceneTree_method_call_group>` **(** :ref:`String<class_String>` group, :ref:`String<class_String>` method **)** vararg |
| :ref:`Variant<class_Variant>` | :ref:`call_group<class_SceneTree_method_call_group>` **(** :ref:`String<class_String>` group, :ref:`String<class_String>` method, ... **)** vararg |
+---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_Variant>` | :ref:`call_group_flags<class_SceneTree_method_call_group_flags>` **(** :ref:`int<class_int>` flags, :ref:`String<class_String>` group, :ref:`String<class_String>` method **)** vararg |
| :ref:`Variant<class_Variant>` | :ref:`call_group_flags<class_SceneTree_method_call_group_flags>` **(** :ref:`int<class_int>` flags, :ref:`String<class_String>` group, :ref:`String<class_String>` method, ... **)** vararg |
+---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`change_scene<class_SceneTree_method_change_scene>` **(** :ref:`String<class_String>` path **)** |
+---------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -400,13 +400,13 @@ Method Descriptions
.. _class_SceneTree_method_call_group:
- :ref:`Variant<class_Variant>` **call_group** **(** :ref:`String<class_String>` group, :ref:`String<class_String>` method **)** vararg
- :ref:`Variant<class_Variant>` **call_group** **(** :ref:`String<class_String>` group, :ref:`String<class_String>` method, ... **)** vararg
Calls ``method`` on each member of the given group.
.. _class_SceneTree_method_call_group_flags:
- :ref:`Variant<class_Variant>` **call_group_flags** **(** :ref:`int<class_int>` flags, :ref:`String<class_String>` group, :ref:`String<class_String>` method **)** vararg
- :ref:`Variant<class_Variant>` **call_group_flags** **(** :ref:`int<class_int>` flags, :ref:`String<class_String>` group, :ref:`String<class_String>` method, ... **)** vararg
Calls ``method`` on each member of the given group, respecting the given :ref:`GroupCallFlags<enum_SceneTree_GroupCallFlags>`.

2
classes/class_scrollcontainer.rst
View File

@@ -67,7 +67,7 @@ Emitted whenever scrolling is started.
Description
-----------
A ScrollContainer node with a :ref:`Control<class_Control>` child and scrollbar child (:ref:`HScrollBar<class_HScrollBar>`, :ref:`VScrollBar<class_VScrollBar>`, or both) will only draw the Control within the ScrollContainer area. Scrollbars will automatically be drawn at the right (for vertical) or bottom (for horizontal) and will enable dragging to move the viewable Control (and its children) within the ScrollContainer. Scrollbars will also automatically resize the grabber based on the minimum_size of the Control relative to the ScrollContainer. Works great with a :ref:`Panel<class_Panel>` control. You can set EXPAND on children size flags, so they will upscale to ScrollContainer size if ScrollContainer size is bigger (scroll is invisible for chosen dimension).
A ScrollContainer node meant to contain a :ref:`Control<class_Control>` child. ScrollContainers will automatically create a scrollbar child (:ref:`HScrollBar<class_HScrollBar>`, :ref:`VScrollBar<class_VScrollBar>`, or both) when needed and will only draw the Control within the ScrollContainer area. Scrollbars will automatically be drawn at the right (for vertical) or bottom (for horizontal) and will enable dragging to move the viewable Control (and its children) within the ScrollContainer. Scrollbars will also automatically resize the grabber based on the minimum_size of the Control relative to the ScrollContainer. Works great with a :ref:`Panel<class_Panel>` control. You can set EXPAND on children size flags, so they will upscale to ScrollContainer size if ScrollContainer size is bigger (scroll is invisible for chosen dimension).
Property Descriptions
---------------------

20
classes/class_skeleton.rst
View File

@@ -16,6 +16,13 @@ Brief Description
Skeleton for characters and animated objects.
Properties
----------
+-------------------------+-----------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`bones_in_world_transform<class_Skeleton_property_bones_in_world_transform>` |
+-------------------------+-----------------------------------------------------------------------------------+
Methods
-------
@@ -91,6 +98,19 @@ The overall transform of a bone with respect to the skeleton is determined by th
Note that "global pose" below refers to the overall transform of the bone with respect to skeleton, so it not the actual global/world transform of the bone.
Property Descriptions
---------------------
.. _class_Skeleton_property_bones_in_world_transform:
- :ref:`bool<class_bool>` **bones_in_world_transform**
+----------+-----------------------------------------+
| *Setter* | set_use_bones_in_world_transform(value) |
+----------+-----------------------------------------+
| *Getter* | is_using_bones_in_world_transform() |
+----------+-----------------------------------------+
Method Descriptions
-------------------

2
classes/class_spotlight.rst
View File

@@ -32,7 +32,7 @@ Properties
Description
-----------
A SpotLight light is a type of :ref:`Light<class_Light>` node that emits lights in a specific direction, in the shape of a cone. The light is attenuated through the distance and this attenuation can be configured by changing the energy, radius and attenuation parameters of :ref:`Light<class_Light>`. TODO: Image of a spotlight.
A SpotLight light is a type of :ref:`Light<class_Light>` node that emits lights in a specific direction, in the shape of a cone. The light is attenuated through the distance and this attenuation can be configured by changing the energy, radius and attenuation parameters of :ref:`Light<class_Light>`.
Tutorials
---------

2
classes/class_tween.rst
View File

@@ -195,7 +195,7 @@ Here is a brief usage example that causes a 2D node to move smoothly between two
Tween.TRANS_LINEAR, Tween.EASE_IN_OUT)
tween.start()
Many methods require a property name, such as "position" above. You can find the correct property name by hovering over the property in the Inspector.
Many methods require a property name, such as "position" above. You can find the correct property name by hovering over the property in the Inspector. You can also provide the components of a property directly by using "property:component" (eg. ``position:x``), where it would only apply to that particular component.
Many of the methods accept ``trans_type`` and ``ease_type``. The first accepts an :ref:`TransitionType<enum_Tween_TransitionType>` constant, and refers to the way the timing of the animation is handled (see ``http://easings.net/`` for some examples). The second accepts an :ref:`EaseType<enum_Tween_EaseType>` constant, and controls the where ``trans_type`` is applied to the interpolation (in the beginning, the end, or both). If you don't know which transition and easing to pick, you can try different :ref:`TransitionType<enum_Tween_TransitionType>` constants with ``EASE_IN_OUT``, and use the one that looks best.

14
classes/class_undoredo.rst
View File

@@ -20,13 +20,13 @@ Methods
-------
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_Variant>` | :ref:`add_do_method<class_UndoRedo_method_add_do_method>` **(** :ref:`Object<class_Object>` object, :ref:`String<class_String>` method **)** vararg |
| :ref:`Variant<class_Variant>` | :ref:`add_do_method<class_UndoRedo_method_add_do_method>` **(** :ref:`Object<class_Object>` object, :ref:`String<class_String>` method, ... **)** vararg |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_do_property<class_UndoRedo_method_add_do_property>` **(** :ref:`Object<class_Object>` object, :ref:`String<class_String>` property, :ref:`Variant<class_Variant>` value **)** |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_do_reference<class_UndoRedo_method_add_do_reference>` **(** :ref:`Object<class_Object>` object **)** |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_Variant>` | :ref:`add_undo_method<class_UndoRedo_method_add_undo_method>` **(** :ref:`Object<class_Object>` object, :ref:`String<class_String>` method **)** vararg |
| :ref:`Variant<class_Variant>` | :ref:`add_undo_method<class_UndoRedo_method_add_undo_method>` **(** :ref:`Object<class_Object>` object, :ref:`String<class_String>` method, ... **)** vararg |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_undo_property<class_UndoRedo_method_add_undo_property>` **(** :ref:`Object<class_Object>` object, :ref:`String<class_String>` property, :ref:`Variant<class_Variant>` value **)** |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -42,6 +42,8 @@ Methods
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_version<class_UndoRedo_method_get_version>` **(** **)** const |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_commiting_action<class_UndoRedo_method_is_commiting_action>` **(** **)** const |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`redo<class_UndoRedo_method_redo>` **(** **)** |
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`undo<class_UndoRedo_method_undo>` **(** **)** |
@@ -103,7 +105,7 @@ Method Descriptions
.. _class_UndoRedo_method_add_do_method:
- :ref:`Variant<class_Variant>` **add_do_method** **(** :ref:`Object<class_Object>` object, :ref:`String<class_String>` method **)** vararg
- :ref:`Variant<class_Variant>` **add_do_method** **(** :ref:`Object<class_Object>` object, :ref:`String<class_String>` method, ... **)** vararg
Register a method that will be called when the action is committed.
@@ -121,7 +123,7 @@ Register a reference for 'do' that will be erased if the 'do' history is lost. T
.. _class_UndoRedo_method_add_undo_method:
- :ref:`Variant<class_Variant>` **add_undo_method** **(** :ref:`Object<class_Object>` object, :ref:`String<class_String>` method **)** vararg
- :ref:`Variant<class_Variant>` **add_undo_method** **(** :ref:`Object<class_Object>` object, :ref:`String<class_String>` method, ... **)** vararg
Register a method that will be called when the action is undone.
@@ -173,6 +175,10 @@ Get the version, each time a new action is committed, the version number of the
This is useful mostly to check if something changed from a saved version.
.. _class_UndoRedo_method_is_commiting_action:
- :ref:`bool<class_bool>` **is_commiting_action** **(** **)** const
.. _class_UndoRedo_method_redo:
- :ref:`bool<class_bool>` **redo** **(** **)**