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-06-01 12:35:12 +02:00
parent 9be500afe1
commit a9c7282d31
23 changed files with 700 additions and 590 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
classes/class_@gdscript.rst
View File

@@ -106,6 +106,8 @@ Methods
+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`min<class_@GDScript_method_min>` **(** :ref:`float<class_float>` a, :ref:`float<class_float>` b **)** |
+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`move_toward<class_@GDScript_method_move_toward>` **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to, :ref:`float<class_float>` delta **)** |
+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`nearest_po2<class_@GDScript_method_nearest_po2>` **(** :ref:`int<class_int>` value **)** |
+-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Variant<class_Variant>` | :ref:`parse_json<class_@GDScript_method_parse_json>` **(** :ref:`String<class_String>` json **)** |
@@ -733,6 +735,18 @@ Returns the minimum of two values.
min(1, 2) # returns 1
min(-3.99, -4) # returns -4
.. _class_@GDScript_method_move_toward:
- :ref:`float<class_float>` **move_toward** **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to, :ref:`float<class_float>` delta **)**
Moves ``from`` toward ``to`` by the ``delta`` value.
Use a negative ``delta`` value to move away.
::
move_toward(10, 5, 4) # returns 6
.. _class_@GDScript_method_nearest_po2:
- :ref:`int<class_int>` **nearest_po2** **(** :ref:`int<class_int>` value **)**

8
classes/class_animation.rst
View File

@@ -127,6 +127,8 @@ Methods
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_set_interpolation_type<class_Animation_method_track_set_interpolation_type>` **(** :ref:`int<class_int>` idx, :ref:`InterpolationType<enum_Animation_InterpolationType>` interpolation **)** |
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_set_key_time<class_Animation_method_track_set_key_time>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`float<class_float>` time **)** |
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_set_key_transition<class_Animation_method_track_set_key_transition>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`float<class_float>` transition **)** |
+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_set_key_value<class_Animation_method_track_set_key_value>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key, :ref:`Variant<class_Variant>` value **)** |
@@ -536,6 +538,12 @@ If ``true``, the track at ``idx`` wraps the interpolation loop.
Set the interpolation type of a given track, from the INTERPOLATION\_\* enum.
.. _class_Animation_method_track_set_key_time:
- void **track_set_key_time** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`float<class_float>` time **)**
Set the time of an existing key.
.. _class_Animation_method_track_set_key_transition:
- void **track_set_key_transition** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`float<class_float>` transition **)**

6
classes/class_audiostreamsample.rst
View File

@@ -14,7 +14,7 @@ AudioStreamSample
Brief Description
-----------------
Plays audio.
Stores audio data loaded from ``.wav`` files.
Properties
----------
@@ -84,7 +84,9 @@ enum **LoopMode**:
Description
-----------
Plays audio, can loop.
AudioStreamSample stores sound samples loaded from ``.wav`` files. To play the stored sound use an :ref:`AudioStreamPlayer<class_AudioStreamPlayer>` (for background music) or :ref:`AudioStreamPlayer2D<class_AudioStreamPlayer2D>`/:ref:`AudioStreamPlayer3D<class_AudioStreamPlayer3D>` (for positional audio). The sound can be looped.
This class can also be used to store dynamically generated PCM audio data.
Property Descriptions
---------------------

6
classes/class_camera.rst
View File

@@ -69,7 +69,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 **)** 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_ray_normal<class_Camera_method_project_ray_normal>` **(** :ref:`Vector2<class_Vector2>` screen_point **)** const |
+-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -344,9 +344,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 **)** const
- :ref:`Vector3<class_Vector3>` **project_position** **(** :ref:`Vector2<class_Vector2>` screen_point, :ref:`float<class_float>` z_depth=0 **)** const
Returns the 3D point in worldspace that maps to the given 2D coordinate in the :ref:`Viewport<class_Viewport>` rectangle.
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.
.. _class_Camera_method_project_ray_normal:

2
classes/class_control.rst
View File

@@ -566,7 +566,7 @@ Constants
Description
-----------
Base class for all User Interface or *UI* related nodes. ``Control`` features a bounding rectangle that defines its extents, an anchor position relative to its parent and margins that represent an offset to the anchor. The margins update automatically when the node, any of its parents, or the screen size change.
Base class for all User Interface or *UI* related nodes. ``Control`` features a bounding rectangle that defines its extents, an anchor position relative to its parent control or the current viewport, and margins that represent an offset to the anchor. The margins update automatically when the node, any of its parents, or the screen size change.
For more information on Godot's UI system, anchors, margins, and containers, see the related tutorials in the manual. To build flexible UIs, you'll need a mix of UI elements that inherit from ``Control`` and :ref:`Container<class_Container>` nodes.

2
classes/class_cubemesh.rst
View File

@@ -34,6 +34,8 @@ Description
Generate an axis-aligned cuboid :ref:`PrimitiveMesh<class_PrimitiveMesh>`.
The cube's UV layout is arranged in a 3×2 layout that allows texturing each face individually. To apply the same texture on all faces, change the material's UV property to ``Vector3(3, 2, 1)``.
Property Descriptions
---------------------

2
classes/class_cylindermesh.rst
View File

@@ -34,7 +34,7 @@ Properties
Description
-----------
Class representing a cylindrical :ref:`PrimitiveMesh<class_PrimitiveMesh>`.
Class representing a cylindrical :ref:`PrimitiveMesh<class_PrimitiveMesh>`. This class can be used to create cones by setting either the :ref:`top_radius<class_CylinderMesh_property_top_radius>` or :ref:`bottom_radius<class_CylinderMesh_property_bottom_radius>` properties to 0.0.
Property Descriptions
---------------------

8
classes/class_editorplugin.rst
View File

@@ -177,6 +177,10 @@ Enumerations
.. _class_EditorPlugin_constant_CONTAINER_PROPERTY_EDITOR_BOTTOM:
.. _class_EditorPlugin_constant_CONTAINER_PROJECT_SETTING_TAB_LEFT:
.. _class_EditorPlugin_constant_CONTAINER_PROJECT_SETTING_TAB_RIGHT:
enum **CustomControlContainer**:
- **CONTAINER_TOOLBAR** = **0**
@@ -199,6 +203,10 @@ enum **CustomControlContainer**:
- **CONTAINER_PROPERTY_EDITOR_BOTTOM** = **9**
- **CONTAINER_PROJECT_SETTING_TAB_LEFT** = **10**
- **CONTAINER_PROJECT_SETTING_TAB_RIGHT** = **11**
.. _enum_EditorPlugin_DockSlot:
.. _class_EditorPlugin_constant_DOCK_SLOT_LEFT_UL:

16
classes/class_geometryinstance.rst
View File

@@ -39,6 +39,13 @@ Properties
| :ref:`bool<class_bool>` | :ref:`use_in_baked_light<class_GeometryInstance_property_use_in_baked_light>` |
+-------------------------------------------------------------------------+-------------------------------------------------------------------------------+
Methods
-------
+------+----------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_custom_aabb<class_GeometryInstance_method_set_custom_aabb>` **(** :ref:`AABB<class_AABB>` aabb **)** |
+------+----------------------------------------------------------------------------------------------------------------+
Enumerations
------------
@@ -188,3 +195,12 @@ If there is a material in material_override, it will be used instead of any mate
If ``true``, this GeometryInstance will be used when baking lights using a :ref:`GIProbe<class_GIProbe>` and/or any other form of baked lighting.
Method Descriptions
-------------------
.. _class_GeometryInstance_method_set_custom_aabb:
- void **set_custom_aabb** **(** :ref:`AABB<class_AABB>` aabb **)**
Overrides the bounding box of this node with a custom one. To remove it, set an AABB with all fields set to zero.

2
classes/class_lineedit.rst
View File

@@ -163,6 +163,8 @@ enum **MenuItems**:
- **MENU_PASTE** = **2** --- Pastes the clipboard text over the selected text (or at the cursor's position).
Non-printable escape characters are automatically stripped from the OS clipboard via :ref:`String.strip_escapes<class_String_method_strip_escapes>`.
- **MENU_CLEAR** = **3** --- Erases the whole ``LineEdit`` text.
- **MENU_SELECT_ALL** = **4** --- Selects the whole ``LineEdit`` text.

6
classes/class_planemesh.rst
View File

@@ -30,7 +30,7 @@ Properties
Description
-----------
Class representing a planar :ref:`PrimitiveMesh<class_PrimitiveMesh>`. This flat mesh does not have a thickness.
Class representing a planar :ref:`PrimitiveMesh<class_PrimitiveMesh>`. This flat mesh does not have a thickness. By default, this mesh is aligned on the X and Z axes; this default rotation isn't suited for use with billboarded materials. For billboarded materials, use :ref:`QuadMesh<class_QuadMesh>` instead.
Property Descriptions
---------------------
@@ -57,7 +57,7 @@ Size of the generated plane. Defaults to (2.0, 2.0).
| *Getter* | get_subdivide_depth() |
+----------+----------------------------+
Number of subdivision along the z-axis. Defaults to 0.
Number of subdivision along the Z axis. Defaults to 0.
.. _class_PlaneMesh_property_subdivide_width:
@@ -69,5 +69,5 @@ Number of subdivision along the z-axis. Defaults to 0.
| *Getter* | get_subdivide_width() |
+----------+----------------------------+
Number of subdivision along the x-axis. Defaults to 0.
Number of subdivision along the X axis. Defaults to 0.

14
classes/class_popupmenu.rst
View File

@@ -19,6 +19,8 @@ PopupMenu displays a list of options.
Properties
----------
+---------------------------+----------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`allow_search<class_PopupMenu_property_allow_search>` |
+---------------------------+----------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`hide_on_checkable_item_selection<class_PopupMenu_property_hide_on_checkable_item_selection>` |
+---------------------------+----------------------------------------------------------------------------------------------------+
@@ -202,6 +204,18 @@ PopupMenu is the typical Control that displays a list of options. They are popul
Property Descriptions
---------------------
.. _class_PopupMenu_property_allow_search:
- :ref:`bool<class_bool>` **allow_search**
+----------+-------------------------+
| *Setter* | set_allow_search(value) |
+----------+-------------------------+
| *Getter* | get_allow_search() |
+----------+-------------------------+
If ``true``, allows to navigate ``PopupMenu`` with letter keys. Default value: ``false``.
.. _class_PopupMenu_property_hide_on_checkable_item_selection:
- :ref:`bool<class_bool>` **hide_on_checkable_item_selection**

8
classes/class_prismmesh.rst
View File

@@ -49,7 +49,7 @@ Property Descriptions
| *Getter* | get_left_to_right() |
+----------+--------------------------+
Displacement of the upper edge along the x-axis. 0.0 positions edge straight above the bottom left edge. Defaults to 0.5 (positioned on the midpoint).
Displacement of the upper edge along the X axis. 0.0 positions edge straight above the bottom-left edge. Defaults to 0.5 (positioned on the midpoint).
.. _class_PrismMesh_property_size:
@@ -73,7 +73,7 @@ Size of the prism. Defaults to (2.0, 2.0, 2.0).
| *Getter* | get_subdivide_depth() |
+----------+----------------------------+
Number of added edge loops along the z-axis. Defaults to 0.
Number of added edge loops along the Z axis. Defaults to 0.
.. _class_PrismMesh_property_subdivide_height:
@@ -85,7 +85,7 @@ Number of added edge loops along the z-axis. Defaults to 0.
| *Getter* | get_subdivide_height() |
+----------+-----------------------------+
Number of added edge loops along the y-axis. Defaults to 0.
Number of added edge loops along the Y axis. Defaults to 0.
.. _class_PrismMesh_property_subdivide_width:
@@ -97,5 +97,5 @@ Number of added edge loops along the y-axis. Defaults to 0.
| *Getter* | get_subdivide_width() |
+----------+----------------------------+
Number of added edge loops along the x-axis. Defaults to 0.
Number of added edge loops along the X axis. Defaults to 0.

1068
classes/class_projectsettings.rst
View File

File diff suppressed because it is too large Load Diff

2
classes/class_quadmesh.rst
View File

@@ -26,7 +26,7 @@ Properties
Description
-----------
Class representing a square mesh with size (2,2,0). Consider using a :ref:`PlaneMesh<class_PlaneMesh>` if you require a differently sized plane.
Class representing a square :ref:`PrimitiveMesh<class_PrimitiveMesh>`. This flat mesh does not have a thickness. By default, this mesh is aligned on the X and Y axes; this default rotation is more suited for use with billboarded materials. Unlike :ref:`PlaneMesh<class_PlaneMesh>`, this mesh doesn't provide subdivision options.
Property Descriptions
---------------------

4
classes/class_rigidbody.rst
View File

@@ -253,7 +253,7 @@ Lock the body's movement in the x-axis.
| *Getter* | get_axis_lock() |
+----------+----------------------+
Lock the body's movement in the x-axis.
Lock the body's movement in the y-axis.
.. _class_RigidBody_property_axis_lock_linear_z:
@@ -265,7 +265,7 @@ Lock the body's movement in the x-axis.
| *Getter* | get_axis_lock() |
+----------+----------------------+
Lock the body's movement in the x-axis.
Lock the body's movement in the z-axis.
.. _class_RigidBody_property_bounce:

2
classes/class_spheremesh.rst
View File

@@ -61,7 +61,7 @@ Full height of the sphere. Defaults to 2.0.
| *Getter* | get_is_hemisphere() |
+----------+--------------------------+
Determines whether a full sphere or a hemisphere is created. Attention: To get a regular hemisphere the height and radius of the sphere have to equal. Defaults to ``false``.
Determines whether a full sphere or a hemisphere is created. Attention: To get a regular hemisphere, the height and radius of the sphere have to equal. Defaults to ``false``.
.. _class_SphereMesh_property_radial_segments:

10
classes/class_string.rst
View File

@@ -186,6 +186,8 @@ Methods
+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`strip_edges<class_String_method_strip_edges>` **(** :ref:`bool<class_bool>` left=True, :ref:`bool<class_bool>` right=True **)** |
+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`strip_escapes<class_String_method_strip_escapes>` **(** **)** |
+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`substr<class_String_method_substr>` **(** :ref:`int<class_int>` from, :ref:`int<class_int>` len **)** |
+-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolByteArray<class_PoolByteArray>` | :ref:`to_ascii<class_String_method_to_ascii>` **(** **)** |
@@ -690,7 +692,13 @@ Splits the string in floats by using a divisor string and returns an array of th
- :ref:`String<class_String>` **strip_edges** **(** :ref:`bool<class_bool>` left=True, :ref:`bool<class_bool>` right=True **)**
Returns a copy of the string stripped of any non-printable character at the beginning and the end. The optional arguments are used to toggle stripping on the left and right edges respectively.
Returns a copy of the string stripped of any non-printable character (including tabulations, spaces and line breaks) at the beginning and the end. The optional arguments are used to toggle stripping on the left and right edges respectively.
.. _class_String_method_strip_escapes:
- :ref:`String<class_String>` **strip_escapes** **(** **)**
Returns a copy of the string stripped of any escape character. These include all non-printable control characters of the first page of the ASCII table (< 32), such as tabulation (``\t`` in C) and newline (``\n`` and ``\r``) characters, but not spaces.
.. _class_String_method_substr:

6
classes/class_tileset.rst
View File

@@ -19,6 +19,8 @@ Tile library for tilemaps.
Methods
-------
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`_forward_atlas_subtile_selection<class_TileSet_method__forward_atlas_subtile_selection>` **(** :ref:`int<class_int>` atlastile_id, :ref:`Object<class_Object>` tilemap, :ref:`Vector2<class_Vector2>` tile_location **)** virtual |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`_forward_subtile_selection<class_TileSet_method__forward_subtile_selection>` **(** :ref:`int<class_int>` autotile_id, :ref:`int<class_int>` bitmask, :ref:`Object<class_Object>` tilemap, :ref:`Vector2<class_Vector2>` tile_location **)** virtual |
+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -236,6 +238,10 @@ Tiles are referenced by a unique integer ID.
Method Descriptions
-------------------
.. _class_TileSet_method__forward_atlas_subtile_selection:
- :ref:`Vector2<class_Vector2>` **_forward_atlas_subtile_selection** **(** :ref:`int<class_int>` atlastile_id, :ref:`Object<class_Object>` tilemap, :ref:`Vector2<class_Vector2>` tile_location **)** virtual
.. _class_TileSet_method__forward_subtile_selection:
- :ref:`Vector2<class_Vector2>` **_forward_subtile_selection** **(** :ref:`int<class_int>` autotile_id, :ref:`int<class_int>` bitmask, :ref:`Object<class_Object>` tilemap, :ref:`Vector2<class_Vector2>` tile_location **)** virtual

12
classes/class_treeitem.rst
View File

@@ -63,13 +63,13 @@ Methods
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`TreeItem<class_TreeItem>` | :ref:`get_next<class_TreeItem_method_get_next>` **(** **)** |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`TreeItem<class_TreeItem>` | :ref:`get_next_visible<class_TreeItem_method_get_next_visible>` **(** **)** |
| :ref:`TreeItem<class_TreeItem>` | :ref:`get_next_visible<class_TreeItem_method_get_next_visible>` **(** :ref:`bool<class_bool>` wrap=false **)** |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`TreeItem<class_TreeItem>` | :ref:`get_parent<class_TreeItem_method_get_parent>` **(** **)** |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`TreeItem<class_TreeItem>` | :ref:`get_prev<class_TreeItem_method_get_prev>` **(** **)** |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`TreeItem<class_TreeItem>` | :ref:`get_prev_visible<class_TreeItem_method_get_prev_visible>` **(** **)** |
| :ref:`TreeItem<class_TreeItem>` | :ref:`get_prev_visible<class_TreeItem_method_get_prev_visible>` **(** :ref:`bool<class_bool>` wrap=false **)** |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_range<class_TreeItem_method_get_range>` **(** :ref:`int<class_int>` column **)** const |
+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -326,10 +326,12 @@ Returns the next TreeItem in the tree.
.. _class_TreeItem_method_get_next_visible:
- :ref:`TreeItem<class_TreeItem>` **get_next_visible** **(** **)**
- :ref:`TreeItem<class_TreeItem>` **get_next_visible** **(** :ref:`bool<class_bool>` wrap=false **)**
Returns the next visible TreeItem in the tree.
If ``wrap`` is enabled, the method will wrap around to the first visible element in the tree when called on the last visible element, otherwise it returns ``null``.
.. _class_TreeItem_method_get_parent:
- :ref:`TreeItem<class_TreeItem>` **get_parent** **(** **)**
@@ -344,10 +346,12 @@ Returns the previous TreeItem in the tree.
.. _class_TreeItem_method_get_prev_visible:
- :ref:`TreeItem<class_TreeItem>` **get_prev_visible** **(** **)**
- :ref:`TreeItem<class_TreeItem>` **get_prev_visible** **(** :ref:`bool<class_bool>` wrap=false **)**
Returns the previous visible TreeItem in the tree.
If ``wrap`` is enabled, the method will wrap around to the last visible element in the tree when called on the first visible element, otherwise it returns ``null``.
.. _class_TreeItem_method_get_range:
- :ref:`float<class_float>` **get_range** **(** :ref:`int<class_int>` column **)** const

8
classes/class_vector2.rst
View File

@@ -67,6 +67,8 @@ Methods
+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`linear_interpolate<class_Vector2_method_linear_interpolate>` **(** :ref:`Vector2<class_Vector2>` b, :ref:`float<class_float>` t **)** |
+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`move_toward<class_Vector2_method_move_toward>` **(** :ref:`Vector2<class_Vector2>` to, :ref:`float<class_float>` delta **)** |
+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`normalized<class_Vector2_method_normalized>` **(** **)** |
+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`project<class_Vector2_method_project>` **(** :ref:`Vector2<class_Vector2>` b **)** |
@@ -267,6 +269,12 @@ Returns the vector's length squared. Prefer this method over :ref:`length<class_
Returns the result of the linear interpolation between this vector and ``b`` by amount ``t``. ``t`` is in the range of ``0.0 - 1.0``, representing the amount of interpolation.
.. _class_Vector2_method_move_toward:
- :ref:`Vector2<class_Vector2>` **move_toward** **(** :ref:`Vector2<class_Vector2>` to, :ref:`float<class_float>` delta **)**
Moves the vector toward ``to`` by the fixed ``delta`` amount.
.. _class_Vector2_method_normalized:
- :ref:`Vector2<class_Vector2>` **normalized** **(** **)**

8
classes/class_vector3.rst
View File

@@ -67,6 +67,8 @@ Methods
+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`min_axis<class_Vector3_method_min_axis>` **(** **)** |
+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`move_toward<class_Vector3_method_move_toward>` **(** :ref:`Vector3<class_Vector3>` to, :ref:`float<class_float>` delta **)** |
+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`normalized<class_Vector3_method_normalized>` **(** **)** |
+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Basis<class_Basis>` | :ref:`outer<class_Vector3_method_outer>` **(** :ref:`Vector3<class_Vector3>` b **)** |
@@ -287,6 +289,12 @@ Returns the axis of the vector's largest value. See ``AXIS_*`` constants.
Returns the axis of the vector's smallest value. See ``AXIS_*`` constants.
.. _class_Vector3_method_move_toward:
- :ref:`Vector3<class_Vector3>` **move_toward** **(** :ref:`Vector3<class_Vector3>` to, :ref:`float<class_float>` delta **)**
Moves the vector toward ``to`` by the fixed ``delta`` amount.
.. _class_Vector3_method_normalized:
- :ref:`Vector3<class_Vector3>` **normalized** **(** **)**

76
classes/class_visualscriptbuiltinfunc.rst
View File

@@ -86,6 +86,8 @@ Enumerations
.. _class_VisualScriptBuiltinFunc_constant_MATH_RANGE_LERP:
.. _class_VisualScriptBuiltinFunc_constant_MATH_MOVE_TOWARD:
.. _class_VisualScriptBuiltinFunc_constant_MATH_DECTIME:
.. _class_VisualScriptBuiltinFunc_constant_MATH_RANDOMIZE:
@@ -218,82 +220,84 @@ enum **BuiltinFunc**:
- **MATH_RANGE_LERP** = **28**
- **MATH_DECTIME** = **29** --- Return the result of 'value' decreased by 'step' \* 'amount'.
- **MATH_MOVE_TOWARD** = **29** --- Moves the number toward a value, based on the third input.
- **MATH_RANDOMIZE** = **30** --- Randomize the seed (or the internal state) of the random number generator. Current implementation reseeds using a number based on time.
- **MATH_DECTIME** = **30** --- Return the result of 'value' decreased by 'step' \* 'amount'.
- **MATH_RAND** = **31** --- Return a random 32 bits integer value. To obtain a random value between 0 to N (where N is smaller than 2^32 - 1), you can use it with the remainder function.
- **MATH_RANDOMIZE** = **31** --- Randomize the seed (or the internal state) of the random number generator. Current implementation reseeds using a number based on time.
- **MATH_RANDF** = **32** --- Return a random floating-point value between 0 and 1. To obtain a random value between 0 to N, you can use it with multiplication.
- **MATH_RAND** = **32** --- Return a random 32 bits integer value. To obtain a random value between 0 to N (where N is smaller than 2^32 - 1), you can use it with the remainder function.
- **MATH_RANDOM** = **33** --- Return a random floating-point value between the two inputs.
- **MATH_RANDF** = **33** --- Return a random floating-point value between 0 and 1. To obtain a random value between 0 to N, you can use it with multiplication.
- **MATH_SEED** = **34** --- Set the seed for the random number generator.
- **MATH_RANDOM** = **34** --- Return a random floating-point value between the two inputs.
- **MATH_RANDSEED** = **35** --- Return a random value from the given seed, along with the new seed.
- **MATH_SEED** = **35** --- Set the seed for the random number generator.
- **MATH_DEG2RAD** = **36** --- Convert the input from degrees to radians.
- **MATH_RANDSEED** = **36** --- Return a random value from the given seed, along with the new seed.
- **MATH_RAD2DEG** = **37** --- Convert the input from radians to degrees.
- **MATH_DEG2RAD** = **37** --- Convert the input from degrees to radians.
- **MATH_LINEAR2DB** = **38** --- Convert the input from linear volume to decibel volume.
- **MATH_RAD2DEG** = **38** --- Convert the input from radians to degrees.
- **MATH_DB2LINEAR** = **39** --- Convert the input from decibel volume to linear volume.
- **MATH_LINEAR2DB** = **39** --- Convert the input from linear volume to decibel volume.
- **MATH_POLAR2CARTESIAN** = **40** --- Converts a 2D point expressed in the polar coordinate system (a distance from the origin ``r`` and an angle ``th``) to the cartesian coordinate system (x and y axis).
- **MATH_DB2LINEAR** = **40** --- Convert the input from decibel volume to linear volume.
- **MATH_CARTESIAN2POLAR** = **41** --- Converts a 2D point expressed in the cartesian coordinate system (x and y axis) to the polar coordinate system (a distance from the origin and an angle).
- **MATH_POLAR2CARTESIAN** = **41** --- Converts a 2D point expressed in the polar coordinate system (a distance from the origin ``r`` and an angle ``th``) to the cartesian coordinate system (x and y axis).
- **MATH_WRAP** = **42**
- **MATH_CARTESIAN2POLAR** = **42** --- Converts a 2D point expressed in the cartesian coordinate system (x and y axis) to the polar coordinate system (a distance from the origin and an angle).
- **MATH_WRAPF** = **43**
- **MATH_WRAP** = **43**
- **LOGIC_MAX** = **44** --- Return the greater of the two numbers, also known as their maximum.
- **MATH_WRAPF** = **44**
- **LOGIC_MIN** = **45** --- Return the lesser of the two numbers, also known as their minimum.
- **LOGIC_MAX** = **45** --- Return the greater of the two numbers, also known as their maximum.
- **LOGIC_CLAMP** = **46** --- Return the input clamped inside the given range, ensuring the result is never outside it. Equivalent to ``min(max(input, range_low), range_high)``.
- **LOGIC_MIN** = **46** --- Return the lesser of the two numbers, also known as their minimum.
- **LOGIC_NEAREST_PO2** = **47** --- Return the nearest power of 2 to the input.
- **LOGIC_CLAMP** = **47** --- Return the input clamped inside the given range, ensuring the result is never outside it. Equivalent to ``min(max(input, range_low), range_high)``.
- **OBJ_WEAKREF** = **48** --- Create a :ref:`WeakRef<class_WeakRef>` from the input.
- **LOGIC_NEAREST_PO2** = **48** --- Return the nearest power of 2 to the input.
- **FUNC_FUNCREF** = **49** --- Create a :ref:`FuncRef<class_FuncRef>` from the input.
- **OBJ_WEAKREF** = **49** --- Create a :ref:`WeakRef<class_WeakRef>` from the input.
- **TYPE_CONVERT** = **50** --- Convert between types.
- **FUNC_FUNCREF** = **50** --- Create a :ref:`FuncRef<class_FuncRef>` from the input.
- **TYPE_OF** = **51** --- Return the type of the input as an integer. Check :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` for the integers that might be returned.
- **TYPE_CONVERT** = **51** --- Convert between types.
- **TYPE_EXISTS** = **52** --- Checks if a type is registered in the :ref:`ClassDB<class_ClassDB>`.
- **TYPE_OF** = **52** --- Return the type of the input as an integer. Check :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` for the integers that might be returned.
- **TEXT_CHAR** = **53** --- Return a character with the given ascii value.
- **TYPE_EXISTS** = **53** --- Checks if a type is registered in the :ref:`ClassDB<class_ClassDB>`.
- **TEXT_STR** = **54** --- Convert the input to a string.
- **TEXT_CHAR** = **54** --- Return a character with the given ascii value.
- **TEXT_PRINT** = **55** --- Print the given string to the output window.
- **TEXT_STR** = **55** --- Convert the input to a string.
- **TEXT_PRINTERR** = **56** --- Print the given string to the standard error output.
- **TEXT_PRINT** = **56** --- Print the given string to the output window.
- **TEXT_PRINTRAW** = **57** --- Print the given string to the standard output, without adding a newline.
- **TEXT_PRINTERR** = **57** --- Print the given string to the standard error output.
- **VAR_TO_STR** = **58** --- Serialize a :ref:`Variant<class_Variant>` to a string.
- **TEXT_PRINTRAW** = **58** --- Print the given string to the standard output, without adding a newline.
- **STR_TO_VAR** = **59** --- Deserialize a :ref:`Variant<class_Variant>` from a string serialized using ``VAR_TO_STR``.
- **VAR_TO_STR** = **59** --- Serialize a :ref:`Variant<class_Variant>` to a string.
- **VAR_TO_BYTES** = **60** --- Serialize a :ref:`Variant<class_Variant>` to a :ref:`PoolByteArray<class_PoolByteArray>`.
- **STR_TO_VAR** = **60** --- Deserialize a :ref:`Variant<class_Variant>` from a string serialized using ``VAR_TO_STR``.
- **BYTES_TO_VAR** = **61** --- Deserialize a :ref:`Variant<class_Variant>` from a :ref:`PoolByteArray<class_PoolByteArray>` serialized using ``VAR_TO_BYTES``.
- **VAR_TO_BYTES** = **61** --- Serialize a :ref:`Variant<class_Variant>` to a :ref:`PoolByteArray<class_PoolByteArray>`.
- **COLORN** = **62** --- Return the :ref:`Color<class_Color>` with the given name and alpha ranging from 0 to 1. Note: names are defined in color_names.inc.
- **BYTES_TO_VAR** = **62** --- Deserialize a :ref:`Variant<class_Variant>` from a :ref:`PoolByteArray<class_PoolByteArray>` serialized using ``VAR_TO_BYTES``.
- **MATH_SMOOTHSTEP** = **63** --- Return a number smoothly interpolated between the first two inputs, based on the third input. Similar to ``MATH_LERP``, but interpolates faster at the beginning and slower at the end. Using Hermite interpolation formula:
- **COLORN** = **63** --- Return the :ref:`Color<class_Color>` with the given name and alpha ranging from 0 to 1. Note: names are defined in color_names.inc.
- **MATH_SMOOTHSTEP** = **64** --- Return a number smoothly interpolated between the first two inputs, based on the third input. Similar to ``MATH_LERP``, but interpolates faster at the beginning and slower at the end. Using Hermite interpolation formula:
::
var t = clamp((weight - from) / (to - from), 0.0, 1.0)
return t * t * (3.0 - 2.0 * t)
- **FUNC_MAX** = **64** --- The maximum value the :ref:`function<class_VisualScriptBuiltinFunc_property_function>` property can have.
- **FUNC_MAX** = **65** --- The maximum value the :ref:`function<class_VisualScriptBuiltinFunc_property_function>` property can have.
Description
-----------