stan220/godot-docs
1
0
Fork 0
mirror of https://github.com/stan220/godot-docs.git synced 2026-09-08 17:28:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Sync classref with current source

Browse Source
This commit is contained in:
Rémi Verschelde
2019-11-22 09:22:56 +01:00
parent b842f77aad
commit 42790f850d
15 changed files with 184 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files
classes/class_camera.rst
+3 -3
View File
@@ -71,7 +71,7 @@ Methods
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`project_local_ray_normal<class_Camera_method_project_local_ray_normal>` **(** :ref:`Vector2<class_Vector2>` screen_point **)** const |
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`project_position<class_Camera_method_project_position>` **(** :ref:`Vector2<class_Vector2>` screen_point, :ref:`float<class_float>` z_depth=0 **)** const |
| :ref:`Vector3<class_Vector3>` | :ref:`project_position<class_Camera_method_project_position>` **(** :ref:`Vector2<class_Vector2>` screen_point, :ref:`float<class_float>` z_depth **)** const |
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`project_ray_normal<class_Camera_method_project_ray_normal>` **(** :ref:`Vector2<class_Vector2>` screen_point **)** const |
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -416,9 +416,9 @@ Returns a normal vector from the screen point location directed along the camera
.. _class_Camera_method_project_position:
- :ref:`Vector3<class_Vector3>` **project_position** **(** :ref:`Vector2<class_Vector2>` screen_point, :ref:`float<class_float>` z_depth=0 **)** const
- :ref:`Vector3<class_Vector3>` **project_position** **(** :ref:`Vector2<class_Vector2>` screen_point, :ref:`float<class_float>` z_depth **)** const
Returns the 3D point in worldspace that maps to the given 2D coordinate in the :ref:`Viewport<class_Viewport>` rectangle on a plane that is the given distance into the scene away from the camera.
Returns the 3D point in worldspace that maps to the given 2D coordinate in the :ref:`Viewport<class_Viewport>` rectangle on a plane that is the given ``z_depth`` distance into the scene away from the camera.
----
classes/class_dictionary.rst
+8 -1
View File
@@ -131,7 +131,14 @@ Returns ``true`` if the dictionary has all of the keys in the given array.
- :ref:`int<class_int>` **hash** **(** **)**
Returns a hashed integer value representing the dictionary contents.
Returns a hashed integer value representing the dictionary contents. This can be used to compare dictionaries by value:
::
var dict1 = {0: 10}
var dict2 = {0: 10}
# The line below prints `true`, whereas it would have printed `false` if both variables were compared directly.
print(dict1.hash() == dict2.hash())
----
classes/class_editorscript.rst
+1 -1
View File
@@ -36,7 +36,7 @@ Description
Scripts extending this class and implementing its :ref:`_run<class_EditorScript_method__run>` method can be executed from the Script Editor's **File > Run** menu option (or by pressing ``Ctrl+Shift+X``) while the editor is running. This is useful for adding custom in-editor functionality to Godot. For more complex additions, consider using :ref:`EditorPlugin<class_EditorPlugin>`\ s instead.
**Note:** Extending scripts need to have ``tool mode`` enabled.
**Note:** Extending scripts need to have ``tool`` mode enabled.
**Example script:**
classes/class_editorvcsinterface.rst
+10 -10
View File
@@ -26,8 +26,6 @@ Methods
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_Array>` | :ref:`get_file_diff<class_EditorVCSInterface_method_get_file_diff>` **(** :ref:`String<class_String>` file_path **)** |
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_is_vcs_intialized<class_EditorVCSInterface_method_get_is_vcs_intialized>` **(** **)** |
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_Dictionary>` | :ref:`get_modified_files_data<class_EditorVCSInterface_method_get_modified_files_data>` **(** **)** |
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_project_name<class_EditorVCSInterface_method_get_project_name>` **(** **)** |
@@ -38,6 +36,8 @@ Methods
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_addon_ready<class_EditorVCSInterface_method_is_addon_ready>` **(** **)** |
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_vcs_initialized<class_EditorVCSInterface_method_is_vcs_initialized>` **(** **)** |
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`shut_down<class_EditorVCSInterface_method_shut_down>` **(** **)** |
+-------------------------------------+-------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`stage_file<class_EditorVCSInterface_method_stage_file>` **(** :ref:`String<class_String>` file_path **)** |
@@ -83,14 +83,6 @@ Each :ref:`Dictionary<class_Dictionary>` object has the line diff contents under
----
.. _class_EditorVCSInterface_method_get_is_vcs_intialized:
- :ref:`bool<class_bool>` **get_is_vcs_intialized** **(** **)**
Returns ``true`` if the VCS addon has been initialized, else returns ``false``.
----
.. _class_EditorVCSInterface_method_get_modified_files_data:
- :ref:`Dictionary<class_Dictionary>` **get_modified_files_data** **(** **)**
@@ -143,6 +135,14 @@ Returns ``true`` if the addon is ready to respond to function calls, else return
----
.. _class_EditorVCSInterface_method_is_vcs_initialized:
- :ref:`bool<class_bool>` **is_vcs_initialized** **(** **)**
Returns ``true`` if the VCS addon has been initialized, else returns ``false``.
----
.. _class_EditorVCSInterface_method_shut_down:
- :ref:`bool<class_bool>` **shut_down** **(** **)**
classes/class_image.rst
+1 -1
View File
@@ -791,7 +791,7 @@ Resizes the image to the nearest power of 2 for the width and height. If ``squar
- :ref:`Error<enum_@GlobalScope_Error>` **save_exr** **(** :ref:`String<class_String>` path, :ref:`bool<class_bool>` grayscale=false **)** const
Saves the image as an EXR file to ``path``. If grayscale is ``true`` and the image has only one channel, it will be saved explicitly as monochrome rather than one red channel. This function will return :ref:`@GlobalScope.ERR_UNAVAILABLE<class_@GlobalScope_constant_ERR_UNAVAILABLE>` if Godot was compiled without the TinyEXR module.
Saves the image as an EXR file to ``path``. If ``grayscale`` is ``true`` and the image has only one channel, it will be saved explicitly as monochrome rather than one red channel. This function will return :ref:`@GlobalScope.ERR_UNAVAILABLE<class_@GlobalScope_constant_ERR_UNAVAILABLE>` if Godot was compiled without the TinyEXR module.
----
classes/class_node.rst
+18 -10
View File
@@ -36,6 +36,8 @@ Properties
+---------------------------------------------+-------------------------------------------------------------------+---+
| :ref:`PauseMode<enum_Node_PauseMode>` | :ref:`pause_mode<class_Node_property_pause_mode>` | 0 |
+---------------------------------------------+-------------------------------------------------------------------+---+
| :ref:`int<class_int>` | :ref:`process_priority<class_Node_property_process_priority>` | 0 |
+---------------------------------------------+-------------------------------------------------------------------+---+
Methods
-------
@@ -199,8 +201,6 @@ Methods
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_process_internal<class_Node_method_set_process_internal>` **(** :ref:`bool<class_bool>` enable **)** |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_process_priority<class_Node_method_set_process_priority>` **(** :ref:`int<class_int>` priority **)** |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_process_unhandled_input<class_Node_method_set_process_unhandled_input>` **(** :ref:`bool<class_bool>` enable **)** |
+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_process_unhandled_key_input<class_Node_method_set_process_unhandled_key_input>` **(** :ref:`bool<class_bool>` enable **)** |
@@ -558,6 +558,22 @@ The node owner. A node can have any other node as owner (as long as it is a vali
Pause mode. How the node will behave if the :ref:`SceneTree<class_SceneTree>` is paused.
----
.. _class_Node_property_process_priority:
- :ref:`int<class_int>` **process_priority**
+-----------+-----------------------------+
| *Default* | 0 |
+-----------+-----------------------------+
| *Setter* | set_process_priority(value) |
+-----------+-----------------------------+
| *Getter* | get_process_priority() |
+-----------+-----------------------------+
The node's priority in the execution order of the enabled processing callbacks (i.e. :ref:`NOTIFICATION_PROCESS<class_Node_constant_NOTIFICATION_PROCESS>`, :ref:`NOTIFICATION_PHYSICS_PROCESS<class_Node_constant_NOTIFICATION_PHYSICS_PROCESS>` and their internal counterparts). Nodes with a higher process priority will have their processing callbacks executed first.
Method Descriptions
-------------------
@@ -1317,14 +1333,6 @@ Enables or disabled internal processing for this node. Internal processing happe
----
.. _class_Node_method_set_process_priority:
- void **set_process_priority** **(** :ref:`int<class_int>` priority **)**
Sets the node's priority in the execution order of the enabled processing callbacks (i.e. :ref:`NOTIFICATION_PROCESS<class_Node_constant_NOTIFICATION_PROCESS>`, :ref:`NOTIFICATION_PHYSICS_PROCESS<class_Node_constant_NOTIFICATION_PHYSICS_PROCESS>` and their internal counterparts). Nodes with a higher process priority will have their processing callbacks executed first.
----
.. _class_Node_method_set_process_unhandled_input:
- void **set_process_unhandled_input** **(** :ref:`bool<class_bool>` enable **)**
classes/class_nodepath.rst
+15
View File
@@ -48,6 +48,21 @@ You will usually just pass a string to :ref:`Node.get_node<class_Node_method_get
A ``NodePath`` is composed of a list of slash-separated node names (like a filesystem path) and an optional colon-separated list of "subnames" which can be resources or properties.
Some examples of NodePaths include the following:
::
# No leading slash means it is relative to the current node.
@"A" # Immediate child A
@"A/B" # A's child B
@"." # The current node.
@".." # The parent node.
@"../C" # A sibling node C.
# A leading slash means it is absolute from the SceneTree.
@"/root" # Equivalent to get_tree().get_root().
@"/root/Main" # If your main scene's root node were named "Main".
@"/root/MyAutoload" # If you have an autoloaded node or scene.
Method Descriptions
-------------------
classes/class_object.rst
+10 -1
View File
@@ -290,7 +290,7 @@ Returns ``true`` if the object can translate strings. See :ref:`set_message_tran
- :ref:`Error<enum_@GlobalScope_Error>` **connect** **(** :ref:`String<class_String>` signal, :ref:`Object<class_Object>` target, :ref:`String<class_String>` method, :ref:`Array<class_Array>` binds=[ ], :ref:`int<class_int>` flags=0 **)**
Connects a ``signal`` to a ``method`` on a ``target`` object. Pass optional ``binds`` to the call as an :ref:`Array<class_Array>` of parameters. Use ``flags`` to set deferred or one-shot connections. See :ref:`ConnectFlags<enum_Object_ConnectFlags>` constants.
Connects a ``signal`` to a ``method`` on a ``target`` object. Pass optional ``binds`` to the call as an :ref:`Array<class_Array>` of parameters. These parameters will be passed to the method after any parameter used in the call to :ref:`emit_signal<class_Object_method_emit_signal>`. Use ``flags`` to set deferred or one-shot connections. See :ref:`ConnectFlags<enum_Object_ConnectFlags>` constants.
A ``signal`` can only be connected once to a ``method``. It will throw an error if already connected, unless the signal was connected with :ref:`CONNECT_REFERENCE_COUNTED<class_Object_constant_CONNECT_REFERENCE_COUNTED>`. To avoid this, first, use :ref:`is_connected<class_Object_method_is_connected>` to check for existing connections.
@@ -304,6 +304,15 @@ Examples:
connect("text_entered", self, "_on_LineEdit_text_entered") # LineEdit signal
connect("hit", self, "_on_Player_hit", [ weapon_type, damage ]) # User-defined signal
An example of the relationship between ``binds`` passed to :ref:`connect<class_Object_method_connect>` and parameters used when calling :ref:`emit_signal<class_Object_method_emit_signal>`:
::
connect("hit", self, "_on_Player_hit", [ weapon_type, damage ]) # weapon_type and damage are passed last
emit_signal("hit", "Dark lord", 5) # "Dark lord" and 5 are passed first
func _on_Player_hit(hit_by, level, weapon_type, damage):
print("Hit by %s (lvl %d) with weapon %s for %d damage" % [hit_by, level, weapon_type, damage])
----
.. _class_Object_method_disconnect:
classes/class_os.rst
+18
View File
@@ -32,6 +32,8 @@ Properties
+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------+
| :ref:`bool<class_bool>` | :ref:`low_processor_usage_mode<class_OS_property_low_processor_usage_mode>` | false |
+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------+
| :ref:`int<class_int>` | :ref:`low_processor_usage_mode_sleep_usec<class_OS_property_low_processor_usage_mode_sleep_usec>` | 6900 |
+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------+
| :ref:`Vector2<class_Vector2>` | :ref:`max_window_size<class_OS_property_max_window_size>` | Vector2( 0, 0 ) |
+-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------+
| :ref:`Vector2<class_Vector2>` | :ref:`min_window_size<class_OS_property_min_window_size>` | Vector2( 0, 0 ) |
@@ -547,6 +549,22 @@ If ``true``, the engine optimizes for low processor usage by only refreshing the
----
.. _class_OS_property_low_processor_usage_mode_sleep_usec:
- :ref:`int<class_int>` **low_processor_usage_mode_sleep_usec**
+-----------+------------------------------------------------+
| *Default* | 6900 |
+-----------+------------------------------------------------+
| *Setter* | set_low_processor_usage_mode_sleep_usec(value) |
+-----------+------------------------------------------------+
| *Getter* | get_low_processor_usage_mode_sleep_usec() |
+-----------+------------------------------------------------+
The amount of sleeping between frames when the low-processor usage mode is enabled (in microseconds). Higher values will result in lower CPU usage.
----
.. _class_OS_property_max_window_size:
- :ref:`Vector2<class_Vector2>` **max_window_size**
classes/class_pckpacker.rst
+16
View File
@@ -29,6 +29,20 @@ Methods
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`pck_start<class_PCKPacker_method_pck_start>` **(** :ref:`String<class_String>` pck_name, :ref:`int<class_int>` alignment **)** |
+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
Description
-----------
The ``PCKPacker`` is used to create packages in application runtime.
::
var packer = PCKPacker.new()
packer.pck_start("test.pck", 0)
packer.add_file("res://text.txt", "text.txt")
packer.flush(false)
The above ``PCKPacker`` creates package **test.pck**, then adds a file named **text.txt** in the root of the package.
Method Descriptions
-------------------
@@ -36,6 +50,8 @@ Method Descriptions
- :ref:`Error<enum_@GlobalScope_Error>` **add_file** **(** :ref:`String<class_String>` pck_path, :ref:`String<class_String>` source_path **)**
Adds the ``source_path`` file to the current PCK package at the ``pck_path`` internal path (should start with ``res://``).
----
.. _class_PCKPacker_method_flush:
classes/class_scenetree.rst
+5 -1
View File
@@ -651,7 +651,7 @@ Quits the application.
Reloads the currently active scene.
Returns an :ref:`Error<enum_@GlobalScope_Error>` code as described in :ref:`change_scene<class_SceneTree_method_change_scene>`, with the addition of :ref:`@GlobalScope.ERR_UNCONFIGURED<class_@GlobalScope_constant_ERR_UNCONFIGURED>` if no :ref:`current_scene<class_SceneTree_property_current_scene>` was defined yet.
Returns :ref:`@GlobalScope.OK<class_@GlobalScope_constant_OK>` on success, :ref:`@GlobalScope.ERR_UNCONFIGURED<class_@GlobalScope_constant_ERR_UNCONFIGURED>` if no :ref:`current_scene<class_SceneTree_property_current_scene>` was defined yet, :ref:`@GlobalScope.ERR_CANT_OPEN<class_@GlobalScope_constant_ERR_CANT_OPEN>` if :ref:`current_scene<class_SceneTree_property_current_scene>` cannot be loaded into a :ref:`PackedScene<class_PackedScene>`, or :ref:`@GlobalScope.ERR_CANT_CREATE<class_@GlobalScope_constant_ERR_CANT_CREATE>` if the scene cannot be instantiated.
----
@@ -661,6 +661,8 @@ Returns an :ref:`Error<enum_@GlobalScope_Error>` code as described in :ref:`chan
If ``true``, the application automatically accepts quitting. Enabled by default.
For mobile platforms, see :ref:`set_quit_on_go_back<class_SceneTree_method_set_quit_on_go_back>`.
----
.. _class_SceneTree_method_set_group:
@@ -693,6 +695,8 @@ Marks the most recent :ref:`InputEvent<class_InputEvent>` as handled.
If ``true``, the application quits automatically on going back (e.g. on Android). Enabled by default.
To handle 'Go Back' button when this option is disabled, use :ref:`MainLoop.NOTIFICATION_WM_GO_BACK_REQUEST<class_MainLoop_constant_NOTIFICATION_WM_GO_BACK_REQUEST>`.
----
.. _class_SceneTree_method_set_screen_stretch:
classes/class_springarm.rst
+36 -1
View File
@@ -16,7 +16,7 @@ SpringArm
Brief Description
-----------------
A helper node, mostly used in 3rd person cameras.
Properties
----------
@@ -44,6 +44,17 @@ Methods
| :ref:`bool<class_bool>` | :ref:`remove_excluded_object<class_SpringArm_method_remove_excluded_object>` **(** :ref:`RID<class_RID>` RID **)** |
+---------------------------+--------------------------------------------------------------------------------------------------------------------+
Description
-----------
The SpringArm node is a node that casts a ray (or collision shape) along its z axis and moves all its direct children to the collision point, minus a margin.
The most common use case for this is to make a 3rd person camera that reacts to collisions in the environment.
The SpringArm will either cast a ray, or if a shape is given, it will cast the shape in the direction of its z axis.
If you use the SpringArm as a camera controller for your player, you might need to exclude the player's collider from the SpringArm's collision check.
Property Descriptions
---------------------
@@ -59,6 +70,8 @@ Property Descriptions
| *Getter* | get_collision_mask() |
+-----------+---------------------------+
The layers against which the collision check shall be done.
----
.. _class_SpringArm_property_margin:
@@ -73,6 +86,12 @@ Property Descriptions
| *Getter* | get_margin() |
+-----------+-------------------+
When the collision check is made, a candidate length for the SpringArm is given.
The margin is then subtracted to this length and the translation is applied to the child objects of the SpringArm.
This margin is useful for when the SpringArm has a :ref:`Camera<class_Camera>` as a child node: without the margin, the :ref:`Camera<class_Camera>` would be placed on the exact point of collision, while with the margin the :ref:`Camera<class_Camera>` would be placed close to the point of collision.
----
.. _class_SpringArm_property_shape:
@@ -85,6 +104,10 @@ Property Descriptions
| *Getter* | get_shape() |
+----------+------------------+
The :ref:`Shape<class_Shape>` to use for the SpringArm.
When the shape is set, the SpringArm will cast the :ref:`Shape<class_Shape>` on its z axis instead of performing a ray cast.
----
.. _class_SpringArm_property_spring_length:
@@ -99,6 +122,10 @@ Property Descriptions
| *Getter* | get_length() |
+-----------+-------------------+
The maximum extent of the SpringArm. This is used as a length for both the ray and the shape cast used internally to calculate the desired position of the SpringArm's child nodes.
To know more about how to perform a shape cast or a ray cast, please consult the :ref:`PhysicsDirectSpaceState<class_PhysicsDirectSpaceState>` documentation.
Method Descriptions
-------------------
@@ -106,21 +133,29 @@ Method Descriptions
- void **add_excluded_object** **(** :ref:`RID<class_RID>` RID **)**
Adds the object with the given :ref:`RID<class_RID>` to the list of objects excluded from the collision check.
----
.. _class_SpringArm_method_clear_excluded_objects:
- void **clear_excluded_objects** **(** **)**
Clears the list of objects excluded from the collision check.
----
.. _class_SpringArm_method_get_hit_length:
- :ref:`float<class_float>` **get_hit_length** **(** **)**
Returns the proportion between the current arm length (after checking for collisions) and the :ref:`spring_length<class_SpringArm_property_spring_length>`. Ranges from 0 to 1.
----
.. _class_SpringArm_method_remove_excluded_object:
- :ref:`bool<class_bool>` **remove_excluded_object** **(** :ref:`RID<class_RID>` RID **)**
Removes the given :ref:`RID<class_RID>` from the list of objects excluded from the collision check.
classes/class_string.rst
+18 -2
View File
@@ -882,7 +882,15 @@ The splits in the returned array are sorted in the same order as the original st
If ``maxsplit`` is specified, it defines the number of splits to do from the right up to ``maxsplit``. The default value of 0 means that all items are split, thus giving the same result as :ref:`split<class_String_method_split>`.
For example, ``"One,Two,Three,Four"`` will return ``["Three","Four"]`` if split by ``","`` with a ``maxsplit`` value of 2.
Example:
::
var some_string = "One,Two,Three,Four"
var some_array = some_string.rsplit(",", true, 1)
print(some_array.size()) # Prints 2
print(some_array[0]) # Prints "Four"
print(some_array[1]) # Prints "Three,Two,One"
----
@@ -942,7 +950,15 @@ Splits the string by a ``delimiter`` string and returns an array of the substrin
If ``maxsplit`` is specified, it defines the number of splits to do from the left up to ``maxsplit``. The default value of 0 means that all items are split.
For example, ``"One,Two,Three"`` will return ``["One","Two"]`` if split by ``","`` with a ``maxsplit`` value of 2.
Example:
::
var some_string = "One,Two,Three,Four"
var some_array = some_string.split(",", true, 1)
print(some_array.size()) # Prints 2
print(some_array[0]) # Prints "One"
print(some_array[1]) # Prints "Two,Three,Four"
----
classes/class_visualserver.rst
+24
View File
@@ -524,6 +524,10 @@ Methods
+---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`particles_get_emitting<class_VisualServer_method_particles_get_emitting>` **(** :ref:`RID<class_RID>` particles **)** |
+---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`particles_is_inactive<class_VisualServer_method_particles_is_inactive>` **(** :ref:`RID<class_RID>` particles **)** |
+---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`particles_request_process<class_VisualServer_method_particles_request_process>` **(** :ref:`RID<class_RID>` particles **)** |
+---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`particles_restart<class_VisualServer_method_particles_restart>` **(** :ref:`RID<class_RID>` particles **)** |
+---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`particles_set_amount<class_VisualServer_method_particles_set_amount>` **(** :ref:`RID<class_RID>` particles, :ref:`int<class_int>` amount **)** |
@@ -1257,6 +1261,10 @@ enum **ViewportClearMode**:
.. _class_VisualServer_constant_VIEWPORT_MSAA_16X:
.. _class_VisualServer_constant_VIEWPORT_MSAA_EXT_2X:
.. _class_VisualServer_constant_VIEWPORT_MSAA_EXT_4X:
enum **ViewportMSAA**:
- **VIEWPORT_MSAA_DISABLED** = **0** --- Multisample antialiasing is disabled.
@@ -1269,6 +1277,10 @@ enum **ViewportMSAA**:
- **VIEWPORT_MSAA_16X** = **4** --- Multisample antialiasing is set to 16×.
- **VIEWPORT_MSAA_EXT_2X** = **5** --- Multisample antialiasing is set to 2× on external texture. Special mode for GLES2 Android VR (Oculus Quest and Go).
- **VIEWPORT_MSAA_EXT_4X** = **6** --- Multisample antialiasing is set to 4× on external texture. Special mode for GLES2 Android VR (Oculus Quest and Go).
----
.. _enum_VisualServer_ViewportUsage:
@@ -3596,6 +3608,18 @@ Sets a mesh's surface's material.
----
.. _class_VisualServer_method_particles_is_inactive:
- :ref:`bool<class_bool>` **particles_is_inactive** **(** :ref:`RID<class_RID>` particles **)**
----
.. _class_VisualServer_method_particles_request_process:
- void **particles_request_process** **(** :ref:`RID<class_RID>` particles **)**
----
.. _class_VisualServer_method_particles_restart:
- void **particles_restart** **(** :ref:`RID<class_RID>` particles **)**
classes/class_vscrollbar.rst
+1 -1
View File
@@ -16,7 +16,7 @@ VScrollBar
Brief Description
-----------------
Vertical version of :ref:`ScrollBar<class_ScrollBar>`, which goes from left (min) to right (max).
Vertical version of :ref:`ScrollBar<class_ScrollBar>`, which goes from top (min) to bottom (max).
Properties
----------