diff --git a/classes/class_@gdscript.rst b/classes/class_@gdscript.rst index 733942fb8..4838430d6 100644 --- a/classes/class_@gdscript.rst +++ b/classes/class_@gdscript.rst @@ -34,7 +34,7 @@ Methods +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`atan2` **(** :ref:`float` y, :ref:`float` x **)** | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`bytes2var` **(** :ref:`PoolByteArray` bytes **)** | +| :ref:`Variant` | :ref:`bytes2var` **(** :ref:`PoolByteArray` bytes, :ref:`bool` allow_objects=false **)** | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`cartesian2polar` **(** :ref:`float` x, :ref:`float` y **)** | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -156,6 +156,8 @@ Methods +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`sinh` **(** :ref:`float` s **)** | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`smoothstep` **(** :ref:`float` from, :ref:`float` to, :ref:`float` weight **)** | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`sqrt` **(** :ref:`float` s **)** | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`stepify` **(** :ref:`float` s, :ref:`float` step **)** | @@ -176,7 +178,7 @@ Methods +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`validate_json` **(** :ref:`String` json **)** | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`var2bytes` **(** :ref:`Variant` var **)** | +| :ref:`PoolByteArray` | :ref:`var2bytes` **(** :ref:`Variant` var, :ref:`bool` full_objects=false **)** | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`var2str` **(** :ref:`Variant` var **)** | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -287,7 +289,7 @@ Returns the arc sine of ``s`` in radians. Use to get the angle of sine ``s``. - void **assert** **(** :ref:`bool` condition **)** -Assert that the ``condition`` is true. If the ``condition`` is false a fatal error is generated and the program is halted. Useful for debugging to make sure a value is always true. +Assert that the ``condition`` is ``true`` . If the ``condition`` is ``false`` a fatal error is generated and the program is halted. Useful for debugging to make sure a value is always ``true``. :: @@ -321,9 +323,11 @@ Returns the arc tangent of ``y/x`` in radians. Use to get the angle of tangent ` .. _class_@GDScript_method_bytes2var: -- :ref:`Variant` **bytes2var** **(** :ref:`PoolByteArray` bytes **)** +- :ref:`Variant` **bytes2var** **(** :ref:`PoolByteArray` bytes, :ref:`bool` allow_objects=false **)** -Decodes a byte array back to a value. +Decodes a byte array back to a value. When ``allow_objects`` is ``true`` decoding objects is allowed. + +**WARNING:** Deserialized object can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats (remote code execution). .. _class_@GDScript_method_cartesian2polar: @@ -1022,6 +1026,18 @@ Returns the hyperbolic sine of ``s``. a = log(2.0) # returns 0.693147 sinh(a) # returns 0.75 +.. _class_@GDScript_method_smoothstep: + +- :ref:`float` **smoothstep** **(** :ref:`float` from, :ref:`float` to, :ref:`float` weight **)** + +Returns a number smoothly interpolated between the ``from`` and ``to``, based on the ``weight``. Similar to :ref:`lerp`, but interpolates faster at the beginning and slower at the end. + +:: + + smoothstep(0, 2, 0.5) # returns 0.15 + smoothstep(0, 2, 1.0) # returns 0.5 + smoothstep(0, 2, 2.0) # returns 1.0 + .. _class_@GDScript_method_sqrt: - :ref:`float` **sqrt** **(** :ref:`float` s **)** @@ -1138,9 +1154,9 @@ Checks that ``json`` is valid JSON data. Returns empty string if valid. Returns .. _class_@GDScript_method_var2bytes: -- :ref:`PoolByteArray` **var2bytes** **(** :ref:`Variant` var **)** +- :ref:`PoolByteArray` **var2bytes** **(** :ref:`Variant` var, :ref:`bool` full_objects=false **)** -Encodes a variable value to a byte array. +Encodes a variable value to a byte array. When ``full_objects`` is ``true`` encoding objects is allowed (and can potentially include code). .. _class_@GDScript_method_var2str: diff --git a/classes/class_animatedsprite.rst b/classes/class_animatedsprite.rst index 8996a625c..7ea380172 100644 --- a/classes/class_animatedsprite.rst +++ b/classes/class_animatedsprite.rst @@ -42,13 +42,13 @@ Properties Methods ------- -+-------------------------+-----------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_playing` **(** **)** const | -+-------------------------+-----------------------------------------------------------------------------------------------+ -| void | :ref:`play` **(** :ref:`String` anim="" **)** | -+-------------------------+-----------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** **)** | -+-------------------------+-----------------------------------------------------------------------------------------------+ ++-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_playing` **(** **)** const | ++-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`play` **(** :ref:`String` anim="", :ref:`bool` backwards=false **)** | ++-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++-------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -180,13 +180,13 @@ Method Descriptions - :ref:`bool` **is_playing** **(** **)** const -Return true if an animation if currently being played. +Return ``true`` if an animation if currently being played. .. _class_AnimatedSprite_method_play: -- void **play** **(** :ref:`String` anim="" **)** +- void **play** **(** :ref:`String` anim="", :ref:`bool` backwards=false **)** -Play the animation set in parameter. If no parameter is provided, the current animation is played. +Play the animation set in parameter. If no parameter is provided, the current animation is played. Property ``backwards`` plays the animation in reverse if set to ``true``. .. _class_AnimatedSprite_method_stop: diff --git a/classes/class_animatedsprite3d.rst b/classes/class_animatedsprite3d.rst index 30991abe3..e74778758 100644 --- a/classes/class_animatedsprite3d.rst +++ b/classes/class_animatedsprite3d.rst @@ -106,7 +106,7 @@ Method Descriptions - :ref:`bool` **is_playing** **(** **)** const -Return true if an animation if currently being played. +Return ``true`` if an animation if currently being played. .. _class_AnimatedSprite3D_method_play: diff --git a/classes/class_animation.rst b/classes/class_animation.rst index d7a0233c2..b279265e3 100644 --- a/classes/class_animation.rst +++ b/classes/class_animation.rst @@ -478,7 +478,7 @@ Returns ``true`` if the track at index ``idx`` is enabled. - :ref:`bool` **track_is_imported** **(** :ref:`int` idx **)** const -Return true if the given track is imported. Else, return false. +Return ``true`` if the given track is imported. Else, return ``false``. .. _class_Animation_method_track_move_down: diff --git a/classes/class_animationnode.rst b/classes/class_animationnode.rst index 1d93d7a35..57f7bb9bd 100644 --- a/classes/class_animationnode.rst +++ b/classes/class_animationnode.rst @@ -143,7 +143,7 @@ Blend an animation by "blend" amount (name must be valid in the linked :ref:`Ani - :ref:`float` **blend_input** **(** :ref:`int` input_index, :ref:`float` time, :ref:`bool` seek, :ref:`float` blend, :ref:`FilterAction` filter=0, :ref:`bool` optimize=true **)** -Blend an input. This is only useful for nodes created for an :ref:`AnimationNodeBlendTree`. Time is a delta, unless "seek" is true, in which case it is absolute. A filter mode may be optionally passed. +Blend an input. This is only useful for nodes created for an :ref:`AnimationNodeBlendTree`. Time is a delta, unless "seek" is ``true``, in which case it is absolute. A filter mode may be optionally passed. .. _class_AnimationNode_method_blend_node: @@ -203,19 +203,19 @@ Get the property information for parameter. Parameters are custom local memory u - :ref:`String` **has_filter** **(** **)** virtual -Return true whether you want the blend tree editor to display filter editing on this node. +Return ``true`` whether you want the blend tree editor to display filter editing on this node. .. _class_AnimationNode_method_is_path_filtered: - :ref:`bool` **is_path_filtered** **(** :ref:`NodePath` path **)** const -Return true wether a given path is filtered. +Return ``true`` wether a given path is filtered. .. _class_AnimationNode_method_process: - void **process** **(** :ref:`float` time, :ref:`bool` seek **)** virtual -Called when a custom node is processed. The argument "time" is relative, unless "seek" is true (in which case it is absolute). +Called when a custom node is processed. The argument "time" is relative, unless "seek" is ``true`` (in which case it is absolute). Here, call the :ref:`blend_input`, :ref:`blend_node` or :ref:`blend_animation` functions. diff --git a/classes/class_animationnodeblendspace2d.rst b/classes/class_animationnodeblendspace2d.rst index 73fb77bf0..18ef5c6bc 100644 --- a/classes/class_animationnodeblendspace2d.rst +++ b/classes/class_animationnodeblendspace2d.rst @@ -84,9 +84,9 @@ enum **BlendMode**: - **BLEND_MODE_INTERPOLATED** = **0** -- **BLEND_MODE_DISCRETE** = **1** +- **BLEND_MODE_DISCRETE** = **1** --- Useful for frame-by-frame 2D animations. -- **BLEND_MODE_DISCRETE_CARRY** = **2** +- **BLEND_MODE_DISCRETE_CARRY** = **2** --- Keep the current play position when switching between discrete animations. Property Descriptions --------------------- diff --git a/classes/class_animationnodestatemachine.rst b/classes/class_animationnodestatemachine.rst index 46dde5a86..5669a7b65 100644 --- a/classes/class_animationnodestatemachine.rst +++ b/classes/class_animationnodestatemachine.rst @@ -58,13 +58,18 @@ Methods +---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_end_node` **(** :ref:`String` name **)** | +---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_graph_offset` **(** :ref:`Vector2` name **)** | +| void | :ref:`set_graph_offset` **(** :ref:`Vector2` offset **)** | +---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_node_position` **(** :ref:`String` name, :ref:`Vector2` position **)** | +---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_start_node` **(** :ref:`String` name **)** | +---------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +Description +----------- + + + Method Descriptions ------------------- @@ -146,7 +151,7 @@ Method Descriptions .. _class_AnimationNodeStateMachine_method_set_graph_offset: -- void **set_graph_offset** **(** :ref:`Vector2` name **)** +- void **set_graph_offset** **(** :ref:`Vector2` offset **)** .. _class_AnimationNodeStateMachine_method_set_node_position: diff --git a/classes/class_animationnodestatemachineplayback.rst b/classes/class_animationnodestatemachineplayback.rst index fbc61c644..20baa1263 100644 --- a/classes/class_animationnodestatemachineplayback.rst +++ b/classes/class_animationnodestatemachineplayback.rst @@ -60,3 +60,5 @@ Method Descriptions - void **travel** **(** :ref:`String` to_node **)** +Transition from the current state to another one, while visiting all the intermediate ones. This is done via the A\* algorithm. + diff --git a/classes/class_animationnodestatemachinetransition.rst b/classes/class_animationnodestatemachinetransition.rst index 09363ec6c..d2fa69397 100644 --- a/classes/class_animationnodestatemachinetransition.rst +++ b/classes/class_animationnodestatemachinetransition.rst @@ -53,11 +53,11 @@ Enumerations enum **SwitchMode**: -- **SWITCH_MODE_IMMEDIATE** = **0** +- **SWITCH_MODE_IMMEDIATE** = **0** --- Switch to the next state immediately. The current state will end and blend into the beginning of the new one. -- **SWITCH_MODE_SYNC** = **1** +- **SWITCH_MODE_SYNC** = **1** --- Switch to the next state immediately, but will seek the new state to the playback position of the old state. -- **SWITCH_MODE_AT_END** = **2** +- **SWITCH_MODE_AT_END** = **2** --- Wait for the current state playback to end, then switch to the beginning of the next state animation. Property Descriptions --------------------- @@ -72,6 +72,8 @@ Property Descriptions | *Getter* | get_advance_condition() | +----------+------------------------------+ +Turn on auto advance when this condition is set. This is a custom text field that can be filled with a variable name. The variable can be modified from code. + .. _class_AnimationNodeStateMachineTransition_property_auto_advance: - :ref:`bool` **auto_advance** @@ -82,6 +84,8 @@ Property Descriptions | *Getter* | has_auto_advance() | +----------+-------------------------+ +Turn on the transition automatically when this state is reached. This works best with ``SWITCH_MODE_AT_END``. + .. _class_AnimationNodeStateMachineTransition_property_disabled: - :ref:`bool` **disabled** @@ -92,6 +96,8 @@ Property Descriptions | *Getter* | is_disabled() | +----------+---------------------+ +Don't use this transition during :ref:`AnimationNodeStateMachinePlayback.travel` or :ref:`auto_advance`. + .. _class_AnimationNodeStateMachineTransition_property_priority: - :ref:`int` **priority** @@ -102,6 +108,8 @@ Property Descriptions | *Getter* | get_priority() | +----------+---------------------+ +Lower priority transitions are preferred when travelling through the tree via :ref:`AnimationNodeStateMachinePlayback.travel` or :ref:`auto_advance`. + .. _class_AnimationNodeStateMachineTransition_property_switch_mode: - :ref:`SwitchMode` **switch_mode** @@ -112,6 +120,8 @@ Property Descriptions | *Getter* | get_switch_mode() | +----------+------------------------+ +The transition type. + .. _class_AnimationNodeStateMachineTransition_property_xfade_time: - :ref:`float` **xfade_time** @@ -122,3 +132,5 @@ Property Descriptions | *Getter* | get_xfade_time() | +----------+-----------------------+ +The time to cross-fade between this state and the next. + diff --git a/classes/class_animationplayer.rst b/classes/class_animationplayer.rst index d94fceba1..2611391d9 100644 --- a/classes/class_animationplayer.rst +++ b/classes/class_animationplayer.rst @@ -354,7 +354,7 @@ Returns ``true`` if playing an animation. - void **play** **(** :ref:`String` name="", :ref:`float` custom_blend=-1, :ref:`float` custom_speed=1.0, :ref:`bool` from_end=false **)** -Play the animation with key ``name``. Custom speed and blend times can be set. If custom speed is negative (-1), 'from_end' being true can play the animation backwards. +Play the animation with key ``name``. Custom speed and blend times can be set. If custom speed is negative (-1), 'from_end' being ``true`` can play the animation backwards. If the animation has been paused by ``stop(true)`` it will be resumed. Calling ``play()`` without arguments will also resume the animation. diff --git a/classes/class_animationtree.rst b/classes/class_animationtree.rst index 0f1a7ed6b..69b339832 100644 --- a/classes/class_animationtree.rst +++ b/classes/class_animationtree.rst @@ -61,6 +61,13 @@ enum **AnimationProcessMode**: - **ANIMATION_PROCESS_MANUAL** = **2** +Tutorials +--------- + +- :doc:`../tutorials/animation/animation_tree` + +- `https://github.com/godotengine/tps-demo `_ + Property Descriptions --------------------- diff --git a/classes/class_array.rst b/classes/class_array.rst index f05a998fc..ded12d8e0 100644 --- a/classes/class_array.rst +++ b/classes/class_array.rst @@ -156,13 +156,13 @@ Returns the last element of the array if the array is not empty. - :ref:`int` **bsearch** **(** :ref:`Variant` value, :ref:`bool` before=True **)** -Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a before specifier can be passed. If false, the returned index comes after all existing entries of the value in the array. Note that calling bsearch on an unsorted array results in unexpected behavior. +Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a before specifier can be passed. If ``false``, the returned index comes after all existing entries of the value in the array. Note that calling bsearch on an unsorted array results in unexpected behavior. .. _class_Array_method_bsearch_custom: - :ref:`int` **bsearch_custom** **(** :ref:`Variant` value, :ref:`Object` obj, :ref:`String` func, :ref:`bool` before=True **)** -Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search and a custom comparison method. Optionally, a before specifier can be passed. If false, the returned index comes after all existing entries of the value in the array. The custom method receives two arguments (an element from the array and the value searched for) and must return true if the first argument is less than the second, and return false otherwise. Note that calling bsearch on an unsorted array results in unexpected behavior. +Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search and a custom comparison method. Optionally, a before specifier can be passed. If ``false``, the returned index comes after all existing entries of the value in the array. The custom method receives two arguments (an element from the array and the value searched for) and must return ``true`` if the first argument is less than the second, and return ``false`` otherwise. Note that calling bsearch on an unsorted array results in unexpected behavior. .. _class_Array_method_clear: @@ -321,7 +321,7 @@ Sorts the array. Note: strings are sorted in alphabetical, not natural order. - void **sort_custom** **(** :ref:`Object` obj, :ref:`String` func **)** -Sorts the array using a custom method. The arguments are an object that holds the method and the name of such method. The custom method receives two arguments (a pair of elements from the array) and must return true if the first argument is less than the second, and return false otherwise. +Sorts the array using a custom method. The arguments are an object that holds the method and the name of such method. The custom method receives two arguments (a pair of elements from the array) and must return ``true`` if the first argument is less than the second, and return ``false`` otherwise. **Note:** you cannot randomize the return value as the heapsort algorithm expects a deterministic result. Doing so will result in unexpected behavior. diff --git a/classes/class_arvranchor.rst b/classes/class_arvranchor.rst index 774d5b1d6..b214d445f 100644 --- a/classes/class_arvranchor.rst +++ b/classes/class_arvranchor.rst @@ -31,11 +31,22 @@ Methods +-------------------------------+-----------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_is_active` **(** **)** const | +-------------------------------+-----------------------------------------------------------------------------------+ +| :ref:`Mesh` | :ref:`get_mesh` **(** **)** const | ++-------------------------------+-----------------------------------------------------------------------------------+ | :ref:`Plane` | :ref:`get_plane` **(** **)** const | +-------------------------------+-----------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_size` **(** **)** const | +-------------------------------+-----------------------------------------------------------------------------------+ +Signals +------- + +.. _class_ARVRAnchor_signal_mesh_updated: + +- **mesh_updated** **(** :ref:`Mesh` mesh **)** + +Emitted when the mesh associated with the anchor changes or when one becomes available. This is especially important for topology that is constantly being mesh_updated. + Description ----------- @@ -73,7 +84,13 @@ Returns the name given to this anchor. - :ref:`bool` **get_is_active** **(** **)** const -Returns true if the anchor is being tracked and false if no anchor with this id is currently known. +Returns ``true`` if the anchor is being tracked and ``false`` if no anchor with this id is currently known. + +.. _class_ARVRAnchor_method_get_mesh: + +- :ref:`Mesh` **get_mesh** **(** **)** const + +If provided by the ARVR Interface this returns a mesh object for the anchor. For an anchor this can be a shape related to the object being tracked or it can be a mesh that provides topology related to the anchor and can be used to create shadows/reflections on surfaces or for generating collision shapes. .. _class_ARVRAnchor_method_get_plane: diff --git a/classes/class_arvrcontroller.rst b/classes/class_arvrcontroller.rst index fc9d2d48f..74cb286ec 100644 --- a/classes/class_arvrcontroller.rst +++ b/classes/class_arvrcontroller.rst @@ -39,6 +39,8 @@ Methods +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_joystick_id` **(** **)** const | +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Mesh` | :ref:`get_mesh` **(** **)** const | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`is_button_pressed` **(** :ref:`int` button **)** const | +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ @@ -57,6 +59,12 @@ Emitted when a button on this controller is pressed. Emitted when a button on this controller is released. +.. _class_ARVRController_signal_mesh_updated: + +- **mesh_updated** **(** :ref:`Mesh` mesh **)** + +Emitted when the mesh associated with the controller changes or when one becomes available. Generally speaking this will be a static mesh after becoming available. + Description ----------- @@ -132,6 +140,12 @@ Returns the value of the given axis for things like triggers, touchpads, etc. th Returns the ID of the joystick object bound to this. Every controller tracked by the ARVR Server that has buttons and axis will also be registered as a joystick within Godot. This means that all the normal joystick tracking and input mapping will work for buttons and axis found on the AR/VR controllers. This ID is purely offered as information so you can link up the controller with its joystick entry. +.. _class_ARVRController_method_get_mesh: + +- :ref:`Mesh` **get_mesh** **(** **)** const + +If provided by the ARVR Interface this returns a mesh associated with the controller. This can be used to visualise the controller. + .. _class_ARVRController_method_is_button_pressed: - :ref:`int` **is_button_pressed** **(** :ref:`int` button **)** const diff --git a/classes/class_arvrinterface.rst b/classes/class_arvrinterface.rst index 1fb285a8a..e51cc8ca4 100644 --- a/classes/class_arvrinterface.rst +++ b/classes/class_arvrinterface.rst @@ -206,7 +206,7 @@ While currently not used you can activate additional interfaces, you may wish to - :ref:`bool` **is_stereo** **(** **)** -Returns true if the current output of this interface is in stereo. +Returns ``true`` if the current output of this interface is in stereo. .. _class_ARVRInterface_method_uninitialize: diff --git a/classes/class_arvrpositionaltracker.rst b/classes/class_arvrpositionaltracker.rst index 9b38fc186..4192bfa3a 100644 --- a/classes/class_arvrpositionaltracker.rst +++ b/classes/class_arvrpositionaltracker.rst @@ -31,6 +31,8 @@ Methods +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_joy_id` **(** **)** const | +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Mesh` | :ref:`get_mesh` **(** **)** const | ++------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_name` **(** **)** const | +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Basis` | :ref:`get_orientation` **(** **)** const | @@ -104,6 +106,12 @@ Returns the hand holding this tracker, if known. See TRACKER\_\* constants. If this is a controller that is being tracked the controller will also be represented by a joystick entry with this id. +.. _class_ARVRPositionalTracker_method_get_mesh: + +- :ref:`Mesh` **get_mesh** **(** **)** const + +Returns the mesh related to a controller or anchor point if one is available. + .. _class_ARVRPositionalTracker_method_get_name: - :ref:`String` **get_name** **(** **)** const diff --git a/classes/class_arvrserver.rst b/classes/class_arvrserver.rst index 99c7e061e..e433b1d03 100644 --- a/classes/class_arvrserver.rst +++ b/classes/class_arvrserver.rst @@ -199,7 +199,7 @@ Get the interface registered at a given index in our list of interfaces. - :ref:`int` **get_interface_count** **(** **)** const -Get the number of interfaces currently registered with the AR/VR server. If your game supports multiple AR/VR platforms, you can look through the available interface, and either present the user with a selection or simply try an initialize each interface and use the first one that returns true. +Get the number of interfaces currently registered with the AR/VR server. If your game supports multiple AR/VR platforms, you can look through the available interface, and either present the user with a selection or simply try an initialize each interface and use the first one that returns ``true``. .. _class_ARVRServer_method_get_interfaces: diff --git a/classes/class_astar.rst b/classes/class_astar.rst index 50dec7125..671873f8e 100644 --- a/classes/class_astar.rst +++ b/classes/class_astar.rst @@ -54,8 +54,12 @@ Methods +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_point` **(** :ref:`int` id **)** const | +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_point_disabled` **(** :ref:`int` id **)** const | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_point` **(** :ref:`int` id **)** | +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_disabled` **(** :ref:`int` id, :ref:`bool` disabled=true **)** | ++-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_point_position` **(** :ref:`int` id, :ref:`Vector3` position **)** | +-------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_point_weight_scale` **(** :ref:`int` id, :ref:`float` weight_scale **)** | @@ -228,12 +232,24 @@ Returns an array of all points. Returns whether a point associated with the given id exists. +.. _class_AStar_method_is_point_disabled: + +- :ref:`bool` **is_point_disabled** **(** :ref:`int` id **)** const + +Returns whether a point is disabled or not for pathfinding. By default, all points are enabled. + .. _class_AStar_method_remove_point: - void **remove_point** **(** :ref:`int` id **)** Removes the point associated with the given id from the points pool. +.. _class_AStar_method_set_point_disabled: + +- void **set_point_disabled** **(** :ref:`int` id, :ref:`bool` disabled=true **)** + +Disables or enables the specified point for pathfinding. Useful for making a temporary obstacle. + .. _class_AStar_method_set_point_position: - void **set_point_position** **(** :ref:`int` id, :ref:`Vector3` position **)** diff --git a/classes/class_audioeffect.rst b/classes/class_audioeffect.rst index 3a1ead4cb..72dc679fc 100644 --- a/classes/class_audioeffect.rst +++ b/classes/class_audioeffect.rst @@ -9,7 +9,7 @@ AudioEffect **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`AudioEffectAmplify`, :ref:`AudioEffectChorus`, :ref:`AudioEffectCompressor`, :ref:`AudioEffectDelay`, :ref:`AudioEffectDistortion`, :ref:`AudioEffectEQ`, :ref:`AudioEffectFilter`, :ref:`AudioEffectLimiter`, :ref:`AudioEffectPanner`, :ref:`AudioEffectPhaser`, :ref:`AudioEffectPitchShift`, :ref:`AudioEffectRecord`, :ref:`AudioEffectReverb`, :ref:`AudioEffectStereoEnhance` +**Inherited By:** :ref:`AudioEffectAmplify`, :ref:`AudioEffectChorus`, :ref:`AudioEffectCompressor`, :ref:`AudioEffectDelay`, :ref:`AudioEffectDistortion`, :ref:`AudioEffectEQ`, :ref:`AudioEffectFilter`, :ref:`AudioEffectLimiter`, :ref:`AudioEffectPanner`, :ref:`AudioEffectPhaser`, :ref:`AudioEffectPitchShift`, :ref:`AudioEffectRecord`, :ref:`AudioEffectReverb`, :ref:`AudioEffectSpectrumAnalyzer`, :ref:`AudioEffectStereoEnhance` **Category:** Core diff --git a/classes/class_audioeffectinstance.rst b/classes/class_audioeffectinstance.rst new file mode 100644 index 000000000..c7859233f --- /dev/null +++ b/classes/class_audioeffectinstance.rst @@ -0,0 +1,20 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the AudioEffectInstance.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_AudioEffectInstance: + +AudioEffectInstance +=================== + +**Inherits:** :ref:`Reference` **<** :ref:`Object` + +**Inherited By:** :ref:`AudioEffectSpectrumAnalyzerInstance` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_audioeffectspectrumanalyzer.rst b/classes/class_audioeffectspectrumanalyzer.rst new file mode 100644 index 000000000..3b4934473 --- /dev/null +++ b/classes/class_audioeffectspectrumanalyzer.rst @@ -0,0 +1,93 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the AudioEffectSpectrumAnalyzer.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_AudioEffectSpectrumAnalyzer: + +AudioEffectSpectrumAnalyzer +=========================== + +**Inherits:** :ref:`AudioEffect` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Properties +---------- + ++------------------------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`buffer_length` | ++------------------------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`FFT_Size` | :ref:`fft_size` | ++------------------------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`tap_back_pos` | ++------------------------------------------------------------+--------------------------------------------------------------------------------+ + +Enumerations +------------ + +.. _enum_AudioEffectSpectrumAnalyzer_FFT_Size: + +.. _class_AudioEffectSpectrumAnalyzer_constant_FFT_SIZE_256: + +.. _class_AudioEffectSpectrumAnalyzer_constant_FFT_SIZE_512: + +.. _class_AudioEffectSpectrumAnalyzer_constant_FFT_SIZE_1024: + +.. _class_AudioEffectSpectrumAnalyzer_constant_FFT_SIZE_2048: + +.. _class_AudioEffectSpectrumAnalyzer_constant_FFT_SIZE_4096: + +.. _class_AudioEffectSpectrumAnalyzer_constant_FFT_SIZE_MAX: + +enum **FFT_Size**: + +- **FFT_SIZE_256** = **0** + +- **FFT_SIZE_512** = **1** + +- **FFT_SIZE_1024** = **2** + +- **FFT_SIZE_2048** = **3** + +- **FFT_SIZE_4096** = **4** + +- **FFT_SIZE_MAX** = **5** + +Property Descriptions +--------------------- + +.. _class_AudioEffectSpectrumAnalyzer_property_buffer_length: + +- :ref:`float` **buffer_length** + ++----------+--------------------------+ +| *Setter* | set_buffer_length(value) | ++----------+--------------------------+ +| *Getter* | get_buffer_length() | ++----------+--------------------------+ + +.. _class_AudioEffectSpectrumAnalyzer_property_fft_size: + +- :ref:`FFT_Size` **fft_size** + ++----------+---------------------+ +| *Setter* | set_fft_size(value) | ++----------+---------------------+ +| *Getter* | get_fft_size() | ++----------+---------------------+ + +.. _class_AudioEffectSpectrumAnalyzer_property_tap_back_pos: + +- :ref:`float` **tap_back_pos** + ++----------+-------------------------+ +| *Setter* | set_tap_back_pos(value) | ++----------+-------------------------+ +| *Getter* | get_tap_back_pos() | ++----------+-------------------------+ + diff --git a/classes/class_audioeffectspectrumanalyzerinstance.rst b/classes/class_audioeffectspectrumanalyzerinstance.rst new file mode 100644 index 000000000..2ec509710 --- /dev/null +++ b/classes/class_audioeffectspectrumanalyzerinstance.rst @@ -0,0 +1,47 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the AudioEffectSpectrumAnalyzerInstance.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_AudioEffectSpectrumAnalyzerInstance: + +AudioEffectSpectrumAnalyzerInstance +=================================== + +**Inherits:** :ref:`AudioEffectInstance` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Methods +------- + ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_magnitude_for_frequency_range` **(** :ref:`float` from_hz, :ref:`float` to_hz, :ref:`MagnitudeMode` mode=1 **)** const | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Enumerations +------------ + +.. _enum_AudioEffectSpectrumAnalyzerInstance_MagnitudeMode: + +.. _class_AudioEffectSpectrumAnalyzerInstance_constant_MAGNITUDE_AVERAGE: + +.. _class_AudioEffectSpectrumAnalyzerInstance_constant_MAGNITUDE_MAX: + +enum **MagnitudeMode**: + +- **MAGNITUDE_AVERAGE** = **0** + +- **MAGNITUDE_MAX** = **1** + +Method Descriptions +------------------- + +.. _class_AudioEffectSpectrumAnalyzerInstance_method_get_magnitude_for_frequency_range: + +- :ref:`Vector2` **get_magnitude_for_frequency_range** **(** :ref:`float` from_hz, :ref:`float` to_hz, :ref:`MagnitudeMode` mode=1 **)** const + diff --git a/classes/class_audioserver.rst b/classes/class_audioserver.rst index a99b05015..3d471a7a4 100644 --- a/classes/class_audioserver.rst +++ b/classes/class_audioserver.rst @@ -19,87 +19,89 @@ Server interface for low level audio access. Methods ------- -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_bus` **(** :ref:`int` at_position=-1 **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_bus_effect` **(** :ref:`int` bus_idx, :ref:`AudioEffect` effect, :ref:`int` at_position=-1 **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`capture_get_device` **(** **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`capture_get_device_list` **(** **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`capture_set_device` **(** :ref:`String` name **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AudioBusLayout` | :ref:`generate_bus_layout` **(** **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_bus_channels` **(** :ref:`int` bus_idx **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_bus_count` **(** **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AudioEffect` | :ref:`get_bus_effect` **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_bus_effect_count` **(** :ref:`int` bus_idx **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_bus_index` **(** :ref:`String` bus_name **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_bus_name` **(** :ref:`int` bus_idx **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_bus_peak_volume_left_db` **(** :ref:`int` bus_idx, :ref:`int` channel **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_bus_peak_volume_right_db` **(** :ref:`int` bus_idx, :ref:`int` channel **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_bus_send` **(** :ref:`int` bus_idx **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_bus_volume_db` **(** :ref:`int` bus_idx **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_device` **(** **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_device_list` **(** **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_mix_rate` **(** **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`SpeakerMode` | :ref:`get_speaker_mode` **(** **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_bus_bypassing_effects` **(** :ref:`int` bus_idx **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_bus_effect_enabled` **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_bus_mute` **(** :ref:`int` bus_idx **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_bus_solo` **(** :ref:`int` bus_idx **)** const | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`lock` **(** **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`move_bus` **(** :ref:`int` index, :ref:`int` to_index **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_bus` **(** :ref:`int` index **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_bus_effect` **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus_bypass_effects` **(** :ref:`int` bus_idx, :ref:`bool` enable **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus_count` **(** :ref:`int` amount **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus_effect_enabled` **(** :ref:`int` bus_idx, :ref:`int` effect_idx, :ref:`bool` enabled **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus_layout` **(** :ref:`AudioBusLayout` bus_layout **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus_mute` **(** :ref:`int` bus_idx, :ref:`bool` enable **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus_name` **(** :ref:`int` bus_idx, :ref:`String` name **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus_send` **(** :ref:`int` bus_idx, :ref:`String` send **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus_solo` **(** :ref:`int` bus_idx, :ref:`bool` enable **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus_volume_db` **(** :ref:`int` bus_idx, :ref:`float` volume_db **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_device` **(** :ref:`String` device **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`swap_bus_effects` **(** :ref:`int` bus_idx, :ref:`int` effect_idx, :ref:`int` by_effect_idx **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`unlock` **(** **)** | -+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_bus` **(** :ref:`int` at_position=-1 **)** | ++-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_bus_effect` **(** :ref:`int` bus_idx, :ref:`AudioEffect` effect, :ref:`int` at_position=-1 **)** | ++-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`capture_get_device` **(** **)** | ++-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`capture_get_device_list` **(** **)** | ++-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`capture_set_device` **(** :ref:`String` name **)** | ++-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AudioBusLayout` | :ref:`generate_bus_layout` **(** **)** const | ++-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_bus_channels` **(** :ref:`int` bus_idx **)** const | ++-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_bus_count` **(** **)** const | ++-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AudioEffect` | :ref:`get_bus_effect` **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** | ++-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_bus_effect_count` **(** :ref:`int` bus_idx **)** | ++-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AudioEffectInstance` | :ref:`get_bus_effect_instance` **(** :ref:`int` bus_idx, :ref:`int` effect_idx, :ref:`int` channel=0 **)** | ++-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_bus_index` **(** :ref:`String` bus_name **)** const | ++-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_bus_name` **(** :ref:`int` bus_idx **)** const | ++-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_bus_peak_volume_left_db` **(** :ref:`int` bus_idx, :ref:`int` channel **)** const | ++-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_bus_peak_volume_right_db` **(** :ref:`int` bus_idx, :ref:`int` channel **)** const | ++-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_bus_send` **(** :ref:`int` bus_idx **)** const | ++-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_bus_volume_db` **(** :ref:`int` bus_idx **)** const | ++-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_device` **(** **)** | ++-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_device_list` **(** **)** | ++-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_mix_rate` **(** **)** const | ++-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`SpeakerMode` | :ref:`get_speaker_mode` **(** **)** const | ++-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_bus_bypassing_effects` **(** :ref:`int` bus_idx **)** const | ++-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_bus_effect_enabled` **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** const | ++-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_bus_mute` **(** :ref:`int` bus_idx **)** const | ++-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_bus_solo` **(** :ref:`int` bus_idx **)** const | ++-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`lock` **(** **)** | ++-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`move_bus` **(** :ref:`int` index, :ref:`int` to_index **)** | ++-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_bus` **(** :ref:`int` index **)** | ++-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_bus_effect` **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** | ++-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus_bypass_effects` **(** :ref:`int` bus_idx, :ref:`bool` enable **)** | ++-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus_count` **(** :ref:`int` amount **)** | ++-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus_effect_enabled` **(** :ref:`int` bus_idx, :ref:`int` effect_idx, :ref:`bool` enabled **)** | ++-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus_layout` **(** :ref:`AudioBusLayout` bus_layout **)** | ++-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus_mute` **(** :ref:`int` bus_idx, :ref:`bool` enable **)** | ++-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus_name` **(** :ref:`int` bus_idx, :ref:`String` name **)** | ++-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus_send` **(** :ref:`int` bus_idx, :ref:`String` send **)** | ++-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus_solo` **(** :ref:`int` bus_idx, :ref:`bool` enable **)** | ++-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus_volume_db` **(** :ref:`int` bus_idx, :ref:`float` volume_db **)** | ++-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_device` **(** :ref:`String` device **)** | ++-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`swap_bus_effects` **(** :ref:`int` bus_idx, :ref:`int` effect_idx, :ref:`int` by_effect_idx **)** | ++-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`unlock` **(** **)** | ++-------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -200,6 +202,10 @@ Returns the :ref:`AudioEffect` at position ``effect_idx`` in Returns the number of effects on the bus at ``bus_idx``. +.. _class_AudioServer_method_get_bus_effect_instance: + +- :ref:`AudioEffectInstance` **get_bus_effect_instance** **(** :ref:`int` bus_idx, :ref:`int` effect_idx, :ref:`int` channel=0 **)** + .. _class_AudioServer_method_get_bus_index: - :ref:`int` **get_bus_index** **(** :ref:`String` bus_name **)** const diff --git a/classes/class_audiostream.rst b/classes/class_audiostream.rst index 3345a3622..4e6acd1d9 100644 --- a/classes/class_audiostream.rst +++ b/classes/class_audiostream.rst @@ -9,7 +9,7 @@ AudioStream **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`AudioStreamMicrophone`, :ref:`AudioStreamOGGVorbis`, :ref:`AudioStreamRandomPitch`, :ref:`AudioStreamSample` +**Inherited By:** :ref:`AudioStreamGenerator`, :ref:`AudioStreamMicrophone`, :ref:`AudioStreamOGGVorbis`, :ref:`AudioStreamRandomPitch`, :ref:`AudioStreamSample` **Category:** Core diff --git a/classes/class_audiostreamgenerator.rst b/classes/class_audiostreamgenerator.rst new file mode 100644 index 000000000..d7f475d6e --- /dev/null +++ b/classes/class_audiostreamgenerator.rst @@ -0,0 +1,50 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the AudioStreamGenerator.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_AudioStreamGenerator: + +AudioStreamGenerator +==================== + +**Inherits:** :ref:`AudioStream` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Properties +---------- + ++---------------------------+-------------------------------------------------------------------------+ +| :ref:`float` | :ref:`buffer_length` | ++---------------------------+-------------------------------------------------------------------------+ +| :ref:`float` | :ref:`mix_rate` | ++---------------------------+-------------------------------------------------------------------------+ + +Property Descriptions +--------------------- + +.. _class_AudioStreamGenerator_property_buffer_length: + +- :ref:`float` **buffer_length** + ++----------+--------------------------+ +| *Setter* | set_buffer_length(value) | ++----------+--------------------------+ +| *Getter* | get_buffer_length() | ++----------+--------------------------+ + +.. _class_AudioStreamGenerator_property_mix_rate: + +- :ref:`float` **mix_rate** + ++----------+---------------------+ +| *Setter* | set_mix_rate(value) | ++----------+---------------------+ +| *Getter* | get_mix_rate() | ++----------+---------------------+ + diff --git a/classes/class_audiostreamgeneratorplayback.rst b/classes/class_audiostreamgeneratorplayback.rst new file mode 100644 index 000000000..ec90930b2 --- /dev/null +++ b/classes/class_audiostreamgeneratorplayback.rst @@ -0,0 +1,62 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the AudioStreamGeneratorPlayback.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_AudioStreamGeneratorPlayback: + +AudioStreamGeneratorPlayback +============================ + +**Inherits:** :ref:`AudioStreamPlaybackResampled` **<** :ref:`AudioStreamPlayback` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Methods +------- + ++-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`can_push_buffer` **(** :ref:`int` amount **)** const | ++-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_buffer` **(** **)** | ++-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_frames_available` **(** **)** const | ++-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_skips` **(** **)** const | ++-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`push_buffer` **(** :ref:`PoolVector2Array` frames **)** | ++-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`push_frame` **(** :ref:`Vector2` frame **)** | ++-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ + +Method Descriptions +------------------- + +.. _class_AudioStreamGeneratorPlayback_method_can_push_buffer: + +- :ref:`bool` **can_push_buffer** **(** :ref:`int` amount **)** const + +.. _class_AudioStreamGeneratorPlayback_method_clear_buffer: + +- void **clear_buffer** **(** **)** + +.. _class_AudioStreamGeneratorPlayback_method_get_frames_available: + +- :ref:`int` **get_frames_available** **(** **)** const + +.. _class_AudioStreamGeneratorPlayback_method_get_skips: + +- :ref:`int` **get_skips** **(** **)** const + +.. _class_AudioStreamGeneratorPlayback_method_push_buffer: + +- :ref:`bool` **push_buffer** **(** :ref:`PoolVector2Array` frames **)** + +.. _class_AudioStreamGeneratorPlayback_method_push_frame: + +- :ref:`bool` **push_frame** **(** :ref:`Vector2` frame **)** + diff --git a/classes/class_audiostreamplayback.rst b/classes/class_audiostreamplayback.rst index 5ad5a86fa..47eb69160 100644 --- a/classes/class_audiostreamplayback.rst +++ b/classes/class_audiostreamplayback.rst @@ -9,6 +9,8 @@ AudioStreamPlayback **Inherits:** :ref:`Reference` **<** :ref:`Object` +**Inherited By:** :ref:`AudioStreamPlaybackResampled` + **Category:** Core Brief Description diff --git a/classes/class_audiostreamplaybackresampled.rst b/classes/class_audiostreamplaybackresampled.rst new file mode 100644 index 000000000..921fc6a99 --- /dev/null +++ b/classes/class_audiostreamplaybackresampled.rst @@ -0,0 +1,20 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the AudioStreamPlaybackResampled.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_AudioStreamPlaybackResampled: + +AudioStreamPlaybackResampled +============================ + +**Inherits:** :ref:`AudioStreamPlayback` **<** :ref:`Reference` **<** :ref:`Object` + +**Inherited By:** :ref:`AudioStreamGeneratorPlayback` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_audiostreamplayer.rst b/classes/class_audiostreamplayer.rst index 068603eff..63b4524e8 100644 --- a/classes/class_audiostreamplayer.rst +++ b/classes/class_audiostreamplayer.rst @@ -40,15 +40,17 @@ Properties Methods ------- -+---------------------------+----------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_playback_position` **(** **)** | -+---------------------------+----------------------------------------------------------------------------------------------------------+ -| void | :ref:`play` **(** :ref:`float` from_position=0.0 **)** | -+---------------------------+----------------------------------------------------------------------------------------------------------+ -| void | :ref:`seek` **(** :ref:`float` to_position **)** | -+---------------------------+----------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** **)** | -+---------------------------+----------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_playback_position` **(** **)** | ++-------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ +| :ref:`AudioStreamPlayback` | :ref:`get_stream_playback` **(** **)** | ++-------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ +| void | :ref:`play` **(** :ref:`float` from_position=0.0 **)** | ++-------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ +| void | :ref:`seek` **(** :ref:`float` to_position **)** | ++-------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++-------------------------------------------------------+----------------------------------------------------------------------------------------------------------+ Signals ------- @@ -192,6 +194,10 @@ Method Descriptions Returns the position in the :ref:`AudioStream` in seconds. +.. _class_AudioStreamPlayer_method_get_stream_playback: + +- :ref:`AudioStreamPlayback` **get_stream_playback** **(** **)** + .. _class_AudioStreamPlayer_method_play: - void **play** **(** :ref:`float` from_position=0.0 **)** diff --git a/classes/class_audiostreamplayer2d.rst b/classes/class_audiostreamplayer2d.rst index e71ec3591..8e4dd051f 100644 --- a/classes/class_audiostreamplayer2d.rst +++ b/classes/class_audiostreamplayer2d.rst @@ -44,15 +44,17 @@ Properties Methods ------- -+---------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_playback_position` **(** **)** | -+---------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`play` **(** :ref:`float` from_position=0.0 **)** | -+---------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`seek` **(** :ref:`float` to_position **)** | -+---------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** **)** | -+---------------------------+------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_playback_position` **(** **)** | ++-------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`AudioStreamPlayback` | :ref:`get_stream_playback` **(** **)** | ++-------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`play` **(** :ref:`float` from_position=0.0 **)** | ++-------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`seek` **(** :ref:`float` to_position **)** | ++-------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++-------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -201,6 +203,10 @@ Method Descriptions Returns the position in the :ref:`AudioStream`. +.. _class_AudioStreamPlayer2D_method_get_stream_playback: + +- :ref:`AudioStreamPlayback` **get_stream_playback** **(** **)** + .. _class_AudioStreamPlayer2D_method_play: - void **play** **(** :ref:`float` from_position=0.0 **)** diff --git a/classes/class_audiostreamplayer3d.rst b/classes/class_audiostreamplayer3d.rst index 2b63ef94e..4325bd673 100644 --- a/classes/class_audiostreamplayer3d.rst +++ b/classes/class_audiostreamplayer3d.rst @@ -62,15 +62,17 @@ Properties Methods ------- -+---------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_playback_position` **(** **)** | -+---------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`play` **(** :ref:`float` from_position=0.0 **)** | -+---------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`seek` **(** :ref:`float` to_position **)** | -+---------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** **)** | -+---------------------------+------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_playback_position` **(** **)** | ++-------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`AudioStreamPlayback` | :ref:`get_stream_playback` **(** **)** | ++-------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`play` **(** :ref:`float` from_position=0.0 **)** | ++-------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`seek` **(** :ref:`float` to_position **)** | ++-------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++-------------------------------------------------------+------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -92,6 +94,8 @@ Enumerations .. _class_AudioStreamPlayer3D_constant_ATTENUATION_LOGARITHMIC: +.. _class_AudioStreamPlayer3D_constant_ATTENUATION_DISABLED: + enum **AttenuationModel**: - **ATTENUATION_INVERSE_DISTANCE** = **0** --- Linear dampening of loudness according to distance. @@ -100,6 +104,8 @@ enum **AttenuationModel**: - **ATTENUATION_LOGARITHMIC** = **2** --- Logarithmic dampening of loudness according to distance. +- **ATTENUATION_DISABLED** = **3** --- No dampening of loudness according to distance. + .. _enum_AudioStreamPlayer3D_OutOfRangeMode: .. _class_AudioStreamPlayer3D_constant_OUT_OF_RANGE_MIX: @@ -187,7 +193,7 @@ Amount how much the filter affects the loudness, in dB. | *Getter* | get_attenuation_model() | +----------+------------------------------+ -Decides if audio should get quieter with distance linearly, quadratically or logarithmically. +Decides if audio should get quieter with distance linearly, quadratically, logarithmically, or not be affected by distance, effectively disabling attenuation. .. _class_AudioStreamPlayer3D_property_autoplay: @@ -374,6 +380,10 @@ Method Descriptions Returns the position in the :ref:`AudioStream`. +.. _class_AudioStreamPlayer3D_method_get_stream_playback: + +- :ref:`AudioStreamPlayback` **get_stream_playback** **(** **)** + .. _class_AudioStreamPlayer3D_method_play: - void **play** **(** :ref:`float` from_position=0.0 **)** diff --git a/classes/class_basebutton.rst b/classes/class_basebutton.rst index f19e3e048..822d98662 100644 --- a/classes/class_basebutton.rst +++ b/classes/class_basebutton.rst @@ -152,7 +152,7 @@ Determines when the button is considered clicked, one of the ACTION_MODE\_\* con Binary mask to choose which mouse buttons this button will respond to. -To allow both left-click and right-click, set this to 3, because it's BUTTON_MASK_LEFT | BUTTON_MASK_RIGHT. +To allow both left-click and right-click, use ``BUTTON_MASK_LEFT | BUTTON_MASK_RIGHT``. .. _class_BaseButton_property_disabled: @@ -263,5 +263,5 @@ Return the visual state used to draw the button. This is useful mainly when impl - :ref:`bool` **is_hovered** **(** **)** const -Return true if the mouse has entered the button and has not left it yet. +Return ``true`` if the mouse has entered the button and has not left it yet. diff --git a/classes/class_basis.rst b/classes/class_basis.rst index b59e79ac1..8ea6f397a 100644 --- a/classes/class_basis.rst +++ b/classes/class_basis.rst @@ -43,10 +43,14 @@ Methods +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_orthogonal_index` **(** **)** | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Quat` | :ref:`get_rotation_quat` **(** **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_scale` **(** **)** | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Basis` | :ref:`inverse` **(** **)** | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_equal_approx` **(** :ref:`Basis` b, :ref:`float` epsilon=0.00001 **)** | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Basis` | :ref:`orthonormalized` **(** **)** | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Basis` | :ref:`rotated` **(** :ref:`Vector3` axis, :ref:`float` phi **)** | @@ -140,6 +144,10 @@ Assuming that the matrix is a proper rotation matrix (orthonormal matrix with de This function considers a discretization of rotations into 24 points on unit sphere, lying along the vectors (x,y,z) with each component being either -1,0 or 1, and returns the index of the point best representing the orientation of the object. It is mainly used by the grid map editor. For further details, refer to Godot source code. +.. _class_Basis_method_get_rotation_quat: + +- :ref:`Quat` **get_rotation_quat** **(** **)** + .. _class_Basis_method_get_scale: - :ref:`Vector3` **get_scale** **(** **)** @@ -152,6 +160,10 @@ Assuming that the matrix is the combination of a rotation and scaling, return th Return the inverse of the matrix. +.. _class_Basis_method_is_equal_approx: + +- :ref:`bool` **is_equal_approx** **(** :ref:`Basis` b, :ref:`float` epsilon=0.00001 **)** + .. _class_Basis_method_orthonormalized: - :ref:`Basis` **orthonormalized** **(** **)** diff --git a/classes/class_bitmap.rst b/classes/class_bitmap.rst index b7dffd111..c487bbc69 100644 --- a/classes/class_bitmap.rst +++ b/classes/class_bitmap.rst @@ -51,13 +51,13 @@ Method Descriptions - void **create** **(** :ref:`Vector2` size **)** -Creates a bitmap with the specified size, filled with false. +Creates a bitmap with the specified size, filled with ``false``. .. _class_BitMap_method_create_from_image_alpha: - void **create_from_image_alpha** **(** :ref:`Image` image, :ref:`float` threshold=0.1 **)** -Creates a bitmap that matches the given image dimensions, every element of the bitmap is set to false if the alpha value of the image at that position is equal to ``threshold`` or less, and true in other case. +Creates a bitmap that matches the given image dimensions, every element of the bitmap is set to ``false`` if the alpha value of the image at that position is equal to ``threshold`` or less, and ``true`` in other case. .. _class_BitMap_method_get_bit: @@ -75,7 +75,7 @@ Returns bitmap's dimensions. - :ref:`int` **get_true_bit_count** **(** **)** const -Returns the amount of bitmap elements that are set to true. +Returns the amount of bitmap elements that are set to ``true``. .. _class_BitMap_method_grow_mask: diff --git a/classes/class_bool.rst b/classes/class_bool.rst index 2d5ebc8d1..750d10bb6 100644 --- a/classes/class_bool.rst +++ b/classes/class_bool.rst @@ -37,13 +37,13 @@ Method Descriptions - :ref:`bool` **bool** **(** :ref:`int` from **)** -Cast an :ref:`int` value to a boolean value, this method will return true if called with an integer value different to 0 and false in other case. +Cast an :ref:`int` value to a boolean value, this method will return ``true`` if called with an integer value different to 0 and ``false`` in other case. - :ref:`bool` **bool** **(** :ref:`float` from **)** -Cast a :ref:`float` value to a boolean value, this method will return true if called with a floating point value different to 0 and false in other case. +Cast a :ref:`float` value to a boolean value, this method will return ``true`` if called with a floating point value different to 0 and ``false`` in other case. - :ref:`bool` **bool** **(** :ref:`String` from **)** -Cast a :ref:`String` value to a boolean value, this method will return true if called with a non empty string and false in other case. Examples: ``bool('False')`` returns true, ``bool('')``. returns false +Cast a :ref:`String` value to a boolean value, this method will return ``true`` if called with a non empty string and ``false`` in other case. Examples: ``bool('False')`` returns ``true``, ``bool('')`` returns ``false``. diff --git a/classes/class_camera.rst b/classes/class_camera.rst index 326b07904..546ecfc76 100644 --- a/classes/class_camera.rst +++ b/classes/class_camera.rst @@ -34,6 +34,8 @@ Properties +-----------------------------------------------------+-----------------------------------------------------------------+ | :ref:`float` | :ref:`fov` | +-----------------------------------------------------+-----------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`frustum_offset` | ++-----------------------------------------------------+-----------------------------------------------------------------+ | :ref:`float` | :ref:`h_offset` | +-----------------------------------------------------+-----------------------------------------------------------------+ | :ref:`KeepAspect` | :ref:`keep_aspect` | @@ -50,35 +52,37 @@ Properties Methods ------- -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_current` **(** :ref:`bool` enable_next=true **)** | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_camera_transform` **(** **)** const | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_cull_mask_bit` **(** :ref:`int` layer **)** const | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_frustum` **(** **)** const | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_position_behind` **(** :ref:`Vector3` world_point **)** const | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`make_current` **(** **)** | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`project_local_ray_normal` **(** :ref:`Vector2` screen_point **)** const | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`project_position` **(** :ref:`Vector2` screen_point **)** const | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`project_ray_normal` **(** :ref:`Vector2` screen_point **)** const | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`project_ray_origin` **(** :ref:`Vector2` screen_point **)** const | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_cull_mask_bit` **(** :ref:`int` layer, :ref:`bool` enable **)** | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_orthogonal` **(** :ref:`float` size, :ref:`float` z_near, :ref:`float` z_far **)** | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_perspective` **(** :ref:`float` fov, :ref:`float` z_near, :ref:`float` z_far **)** | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`unproject_position` **(** :ref:`Vector3` world_point **)** const | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_current` **(** :ref:`bool` enable_next=true **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`get_camera_transform` **(** **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_cull_mask_bit` **(** :ref:`int` layer **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_frustum` **(** **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_position_behind` **(** :ref:`Vector3` world_point **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`make_current` **(** **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`project_local_ray_normal` **(** :ref:`Vector2` screen_point **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`project_position` **(** :ref:`Vector2` screen_point **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`project_ray_normal` **(** :ref:`Vector2` screen_point **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`project_ray_origin` **(** :ref:`Vector2` screen_point **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_cull_mask_bit` **(** :ref:`int` layer, :ref:`bool` enable **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_frustum` **(** :ref:`float` size, :ref:`Vector2` offset, :ref:`float` z_near, :ref:`float` z_far **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_orthogonal` **(** :ref:`float` size, :ref:`float` z_near, :ref:`float` z_far **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_perspective` **(** :ref:`float` fov, :ref:`float` z_near, :ref:`float` z_far **)** | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`unproject_position` **(** :ref:`Vector3` world_point **)** const | ++-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ @@ -89,12 +93,16 @@ Enumerations .. _class_Camera_constant_PROJECTION_ORTHOGONAL: +.. _class_Camera_constant_PROJECTION_FRUSTUM: + enum **Projection**: - **PROJECTION_PERSPECTIVE** = **0** --- Perspective Projection (object's size on the screen becomes smaller when far away). - **PROJECTION_ORTHOGONAL** = **1** --- Orthogonal Projection (objects remain the same size on the screen no matter how far away they are). +- **PROJECTION_FRUSTUM** = **2** + .. _enum_Camera_KeepAspect: .. _class_Camera_constant_KEEP_WIDTH: @@ -203,6 +211,16 @@ The distance to the far culling boundary for this Camera relative to its local z The camera's field of view angle (in degrees). Only applicable in perspective mode. Since :ref:`keep_aspect` locks one axis, ``fov`` sets the other axis' field of view angle. +.. _class_Camera_property_frustum_offset: + +- :ref:`Vector2` **frustum_offset** + ++----------+---------------------------+ +| *Setter* | set_frustum_offset(value) | ++----------+---------------------------+ +| *Getter* | get_frustum_offset() | ++----------+---------------------------+ + .. _class_Camera_property_h_offset: - :ref:`float` **h_offset** @@ -282,7 +300,7 @@ Method Descriptions - void **clear_current** **(** :ref:`bool` enable_next=true **)** -If this is the current Camera, remove it from being current. If ``enable_next`` is true, request to make the next Camera current, if any. +If this is the current Camera, remove it from being current. If ``enable_next`` is ``true``, request to make the next Camera current, if any. .. _class_Camera_method_get_camera_transform: @@ -338,6 +356,10 @@ Returns a 3D position in worldspace, that is the result of projecting a point on - void **set_cull_mask_bit** **(** :ref:`int` layer, :ref:`bool` enable **)** +.. _class_Camera_method_set_frustum: + +- void **set_frustum** **(** :ref:`float` size, :ref:`Vector2` offset, :ref:`float` z_near, :ref:`float` z_far **)** + .. _class_Camera_method_set_orthogonal: - void **set_orthogonal** **(** :ref:`float` size, :ref:`float` z_near, :ref:`float` z_far **)** diff --git a/classes/class_canvasitem.rst b/classes/class_canvasitem.rst index a3cb0203f..50e14bf60 100644 --- a/classes/class_canvasitem.rst +++ b/classes/class_canvasitem.rst @@ -53,7 +53,7 @@ Methods +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`draw_line` **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_mesh` **(** :ref:`Mesh` mesh, :ref:`Texture` texture, :ref:`Texture` normal_map=null **)** | +| void | :ref:`draw_mesh` **(** :ref:`Mesh` mesh, :ref:`Texture` texture, :ref:`Texture` normal_map=null, :ref:`Transform2D` transform=Transform2D( 1, 0, 0, 1, 0, 0 ), :ref:`Color` modulate=Color( 1, 1, 1, 1 ) **)** | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`draw_multiline` **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -205,7 +205,7 @@ Constants .. _class_CanvasItem_constant_NOTIFICATION_EXIT_CANVAS: -- **NOTIFICATION_TRANSFORM_CHANGED** = **29** --- Canvas item transform has changed. Notification is only received if enabled by :ref:`set_notify_transform` or :ref:`set_notify_local_transform`. +- **NOTIFICATION_TRANSFORM_CHANGED** = **2000** --- Canvas item transform has changed. Notification is only received if enabled by :ref:`set_notify_transform` or :ref:`set_notify_local_transform`. - **NOTIFICATION_DRAW** = **30** --- CanvasItem is requested to draw. @@ -363,7 +363,7 @@ Draws a line from a 2D point to another, with a given color and width. It can be .. _class_CanvasItem_method_draw_mesh: -- void **draw_mesh** **(** :ref:`Mesh` mesh, :ref:`Texture` texture, :ref:`Texture` normal_map=null **)** +- void **draw_mesh** **(** :ref:`Mesh` mesh, :ref:`Texture` texture, :ref:`Texture` normal_map=null, :ref:`Transform2D` transform=Transform2D( 1, 0, 0, 1, 0, 0 ), :ref:`Color` modulate=Color( 1, 1, 1, 1 ) **)** .. _class_CanvasItem_method_draw_multiline: diff --git a/classes/class_canvaslayer.rst b/classes/class_canvaslayer.rst index 02839c35a..906134762 100644 --- a/classes/class_canvaslayer.rst +++ b/classes/class_canvaslayer.rst @@ -21,21 +21,25 @@ Canvas drawing layer. Properties ---------- -+---------------------------------------+----------------------------------------------------------------------+ -| :ref:`Node` | :ref:`custom_viewport` | -+---------------------------------------+----------------------------------------------------------------------+ -| :ref:`int` | :ref:`layer` | -+---------------------------------------+----------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`offset` | -+---------------------------------------+----------------------------------------------------------------------+ -| :ref:`float` | :ref:`rotation` | -+---------------------------------------+----------------------------------------------------------------------+ -| :ref:`float` | :ref:`rotation_degrees` | -+---------------------------------------+----------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`scale` | -+---------------------------------------+----------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`transform` | -+---------------------------------------+----------------------------------------------------------------------+ ++---------------------------------------+----------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`custom_viewport` | ++---------------------------------------+----------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`follow_viewport_enable` | ++---------------------------------------+----------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`follow_viewport_scale` | ++---------------------------------------+----------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`layer` | ++---------------------------------------+----------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`offset` | ++---------------------------------------+----------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`rotation` | ++---------------------------------------+----------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`rotation_degrees` | ++---------------------------------------+----------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`scale` | ++---------------------------------------+----------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`transform` | ++---------------------------------------+----------------------------------------------------------------------------------+ Methods ------- @@ -71,6 +75,26 @@ Property Descriptions The custom :ref:`Viewport` node assigned to the ``CanvasLayer``. If null, uses the default viewport instead. +.. _class_CanvasLayer_property_follow_viewport_enable: + +- :ref:`bool` **follow_viewport_enable** + ++----------+----------------------------+ +| *Setter* | set_follow_viewport(value) | ++----------+----------------------------+ +| *Getter* | is_following_viewport() | ++----------+----------------------------+ + +.. _class_CanvasLayer_property_follow_viewport_scale: + +- :ref:`float` **follow_viewport_scale** + ++----------+----------------------------------+ +| *Setter* | set_follow_viewport_scale(value) | ++----------+----------------------------------+ +| *Getter* | get_follow_viewport_scale() | ++----------+----------------------------------+ + .. _class_CanvasLayer_property_layer: - :ref:`int` **layer** diff --git a/classes/class_classdb.rst b/classes/class_classdb.rst index fce64b208..8aac94722 100644 --- a/classes/class_classdb.rst +++ b/classes/class_classdb.rst @@ -73,7 +73,7 @@ Method Descriptions - :ref:`bool` **can_instance** **(** :ref:`String` class **)** const -Returns true if you can instance objects from the specified 'class', false in other case. +Returns ``true`` if you can instance objects from the specified 'class', ``false`` in other case. .. _class_ClassDB_method_class_exists: @@ -103,7 +103,7 @@ Returns an array with the names all the integer constants of 'class' or its ance - :ref:`Array` **class_get_method_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const -Returns an array with all the methods of 'class' or its ancestry if 'no_inheritance' is false. Every element of the array is a :ref:`Dictionary` with the following keys: args, default_args, flags, id, name, return: (class_name, hint, hint_string, name, type, usage). +Returns an array with all the methods of 'class' or its ancestry if 'no_inheritance' is ``false``. Every element of the array is a :ref:`Dictionary` with the following keys: args, default_args, flags, id, name, return: (class_name, hint, hint_string, name, type, usage). .. _class_ClassDB_method_class_get_property: @@ -115,7 +115,7 @@ Returns the value of 'property' of 'class' or its ancestry. - :ref:`Array` **class_get_property_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const -Returns an array with all the properties of 'class' or its ancestry if 'no_inheritance' is false. +Returns an array with all the properties of 'class' or its ancestry if 'no_inheritance' is ``false``. .. _class_ClassDB_method_class_get_signal: @@ -127,7 +127,7 @@ Returns the 'signal' data of 'class' or its ancestry. The returned value is a :r - :ref:`Array` **class_get_signal_list** **(** :ref:`String` class, :ref:`bool` no_inheritance=false **)** const -Returns an array with all the signals of 'class' or its ancestry if 'no_inheritance' is false. Every element of the array is a :ref:`Dictionary` as described in :ref:`class_get_signal`. +Returns an array with all the signals of 'class' or its ancestry if 'no_inheritance' is ``false``. Every element of the array is a :ref:`Dictionary` as described in :ref:`class_get_signal`. .. _class_ClassDB_method_class_has_integer_constant: diff --git a/classes/class_collisionobject.rst b/classes/class_collisionobject.rst index 829c2d6bd..62b2f2cd9 100644 --- a/classes/class_collisionobject.rst +++ b/classes/class_collisionobject.rst @@ -117,7 +117,7 @@ If ``true``, the ``CollisionObject`` will continue to receive input events as th | *Getter* | is_ray_pickable() | +----------+-------------------------+ -If ``true``, the :ref:`CollisionObject`'s shapes will respond to :ref:`RayCast`\ s. Default value: ``true``. +If ``true``, the ``CollisionObject``'s shapes will respond to :ref:`RayCast`\ s. Default value: ``true``. Method Descriptions ------------------- diff --git a/classes/class_collisionpolygon.rst b/classes/class_collisionpolygon.rst index f0546659f..538b08307 100644 --- a/classes/class_collisionpolygon.rst +++ b/classes/class_collisionpolygon.rst @@ -57,7 +57,7 @@ Length that the resulting collision extends in either direction perpendicular to | *Getter* | is_disabled() | +----------+---------------------+ -If true, no collision will be produced. +If ``true``, no collision will be produced. .. _class_CollisionPolygon_property_polygon: diff --git a/classes/class_control.rst b/classes/class_control.rst index 0ce1e2ed5..6e5b370b4 100644 --- a/classes/class_control.rst +++ b/classes/class_control.rst @@ -838,7 +838,7 @@ Controls whether the control will be able to receive mouse button input events t | *Getter* | is_clipping_contents() | +----------+--------------------------+ -Enables whether rendering of children should be clipped to this control's rectangle. If true, parts of a child which would be visibly outside of this control's rectangle will not be rendered. +Enables whether rendering of children should be clipped to this control's rectangle. If ``true``, parts of a child which would be visibly outside of this control's rectangle will not be rendered. .. _class_Control_property_rect_global_position: diff --git a/classes/class_csgbox.rst b/classes/class_csgbox.rst index 77052736b..21959b564 100644 --- a/classes/class_csgbox.rst +++ b/classes/class_csgbox.rst @@ -7,7 +7,7 @@ CSGBox ====== -**Inherits:** :ref:`CSGPrimitive` **<** :ref:`CSGShape` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` +**Inherits:** :ref:`CSGPrimitive` **<** :ref:`CSGShape` **<** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core diff --git a/classes/class_csgcombiner.rst b/classes/class_csgcombiner.rst index 3bd4eca94..9c8d52026 100644 --- a/classes/class_csgcombiner.rst +++ b/classes/class_csgcombiner.rst @@ -7,7 +7,7 @@ CSGCombiner =========== -**Inherits:** :ref:`CSGShape` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` +**Inherits:** :ref:`CSGShape` **<** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core diff --git a/classes/class_csgcylinder.rst b/classes/class_csgcylinder.rst index eeb5c8cbd..f88d6cbd7 100644 --- a/classes/class_csgcylinder.rst +++ b/classes/class_csgcylinder.rst @@ -7,7 +7,7 @@ CSGCylinder =========== -**Inherits:** :ref:`CSGPrimitive` **<** :ref:`CSGShape` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` +**Inherits:** :ref:`CSGPrimitive` **<** :ref:`CSGShape` **<** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core @@ -51,7 +51,7 @@ Property Descriptions | *Getter* | is_cone() | +----------+-----------------+ -If true a cone is created, the :ref:`radius` will only apply to one side. +If ``true`` a cone is created, the :ref:`radius` will only apply to one side. .. _class_CSGCylinder_property_height: @@ -111,5 +111,5 @@ The number of sides of the cylinder, the higher this number the more detail ther | *Getter* | get_smooth_faces() | +----------+-------------------------+ -If true the normals of the cylinder are set to give a smooth effect making the cylinder seem rounded. When false the cylinder will have a flat shaded look. +If ``true`` the normals of the cylinder are set to give a smooth effect making the cylinder seem rounded. If ``false`` the cylinder will have a flat shaded look. diff --git a/classes/class_csgmesh.rst b/classes/class_csgmesh.rst index 883da7fd7..009663ede 100644 --- a/classes/class_csgmesh.rst +++ b/classes/class_csgmesh.rst @@ -7,7 +7,7 @@ CSGMesh ======= -**Inherits:** :ref:`CSGPrimitive` **<** :ref:`CSGShape` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` +**Inherits:** :ref:`CSGPrimitive` **<** :ref:`CSGShape` **<** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core @@ -19,9 +19,11 @@ A CSG Mesh shape that uses a mesh resource. Properties ---------- -+-------------------------+------------------------------------------+ -| :ref:`Mesh` | :ref:`mesh` | -+-------------------------+------------------------------------------+ ++---------------------------------+--------------------------------------------------+ +| :ref:`Material` | :ref:`material` | ++---------------------------------+--------------------------------------------------+ +| :ref:`Mesh` | :ref:`mesh` | ++---------------------------------+--------------------------------------------------+ Description ----------- @@ -31,6 +33,16 @@ This CSG node allows you to use any mesh resource as a CSG shape, provided it is Property Descriptions --------------------- +.. _class_CSGMesh_property_material: + +- :ref:`Material` **material** + ++----------+---------------------+ +| *Setter* | set_material(value) | ++----------+---------------------+ +| *Getter* | get_material() | ++----------+---------------------+ + .. _class_CSGMesh_property_mesh: - :ref:`Mesh` **mesh** diff --git a/classes/class_csgpolygon.rst b/classes/class_csgpolygon.rst index 54bc61eea..7e54c54f3 100644 --- a/classes/class_csgpolygon.rst +++ b/classes/class_csgpolygon.rst @@ -7,7 +7,7 @@ CSGPolygon ========== -**Inherits:** :ref:`CSGPrimitive` **<** :ref:`CSGShape` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` +**Inherits:** :ref:`CSGPrimitive` **<** :ref:`CSGShape` **<** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core @@ -136,7 +136,7 @@ Extrusion mode. | *Getter* | is_path_continuous_u() | +----------+------------------------------+ -If true the u component of our uv will continuously increase in unison with the distance traveled along our path when :ref:`mode` is :ref:`MODE_PATH`. +If ``true`` the u component of our uv will continuously increase in unison with the distance traveled along our path when :ref:`mode` is :ref:`MODE_PATH`. .. _class_CSGPolygon_property_path_interval: @@ -160,7 +160,7 @@ Interval at which a new extrusion slice is added along the path when :ref:`mode< | *Getter* | is_path_joined() | +----------+------------------------+ -If true the start and end of our path are joined together ensuring there is no seam when :ref:`mode` is :ref:`MODE_PATH`. +If ``true`` the start and end of our path are joined together ensuring there is no seam when :ref:`mode` is :ref:`MODE_PATH`. .. _class_CSGPolygon_property_path_local: @@ -172,7 +172,7 @@ If true the start and end of our path are joined together ensuring there is no s | *Getter* | is_path_local() | +----------+-----------------------+ -If false we extrude centered on our path, if true we extrude in relation to the position of our CSGPolygon when :ref:`mode` is :ref:`MODE_PATH`. +If ``false`` we extrude centered on our path, if ``true`` we extrude in relation to the position of our CSGPolygon when :ref:`mode` is :ref:`MODE_PATH`. .. _class_CSGPolygon_property_path_node: diff --git a/classes/class_csgprimitive.rst b/classes/class_csgprimitive.rst index ce8daa167..01596feb1 100644 --- a/classes/class_csgprimitive.rst +++ b/classes/class_csgprimitive.rst @@ -7,7 +7,7 @@ CSGPrimitive ============ -**Inherits:** :ref:`CSGShape` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` +**Inherits:** :ref:`CSGShape` **<** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Inherited By:** :ref:`CSGBox`, :ref:`CSGCylinder`, :ref:`CSGMesh`, :ref:`CSGPolygon`, :ref:`CSGSphere`, :ref:`CSGTorus` diff --git a/classes/class_csgshape.rst b/classes/class_csgshape.rst index c380d55cf..58999b13c 100644 --- a/classes/class_csgshape.rst +++ b/classes/class_csgshape.rst @@ -7,7 +7,7 @@ CSGShape ======== -**Inherits:** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` +**Inherits:** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Inherited By:** :ref:`CSGCombiner`, :ref:`CSGPrimitive` @@ -176,7 +176,7 @@ Returns an individual bit on the collision mask. - :ref:`bool` **is_root_shape** **(** **)** const -Returns true if this is a root shape and is thus the object that is rendered. +Returns ``true`` if this is a root shape and is thus the object that is rendered. .. _class_CSGShape_method_set_collision_layer_bit: diff --git a/classes/class_csgsphere.rst b/classes/class_csgsphere.rst index d3fb1f8ff..3d26b0613 100644 --- a/classes/class_csgsphere.rst +++ b/classes/class_csgsphere.rst @@ -7,7 +7,7 @@ CSGSphere ========= -**Inherits:** :ref:`CSGPrimitive` **<** :ref:`CSGShape` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` +**Inherits:** :ref:`CSGPrimitive` **<** :ref:`CSGShape` **<** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core @@ -97,5 +97,5 @@ Number of horizontal slices for the sphere. | *Getter* | get_smooth_faces() | +----------+-------------------------+ -If true the normals of the sphere are set to give a smooth effect making the sphere seem rounded. When false the sphere will have a flat shaded look. +If ``true`` the normals of the sphere are set to give a smooth effect making the sphere seem rounded. If ``false`` the sphere will have a flat shaded look. diff --git a/classes/class_csgtorus.rst b/classes/class_csgtorus.rst index 4532255be..0672f72a3 100644 --- a/classes/class_csgtorus.rst +++ b/classes/class_csgtorus.rst @@ -7,7 +7,7 @@ CSGTorus ======== -**Inherits:** :ref:`CSGPrimitive` **<** :ref:`CSGShape` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` +**Inherits:** :ref:`CSGPrimitive` **<** :ref:`CSGShape` **<** :ref:`GeometryInstance` **<** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Category:** Core @@ -111,5 +111,5 @@ The number of slices the torus is constructed of. | *Getter* | get_smooth_faces() | +----------+-------------------------+ -If true the normals of the torus are set to give a smooth effect making the torus seem rounded. When false the torus will have a flat shaded look. +If ``true`` the normals of the torus are set to give a smooth effect making the torus seem rounded. If ``false`` the torus will have a flat shaded look. diff --git a/classes/class_curve2d.rst b/classes/class_curve2d.rst index e2075bda6..8fd27e6d0 100644 --- a/classes/class_curve2d.rst +++ b/classes/class_curve2d.rst @@ -169,7 +169,7 @@ If ``idx`` is out of bounds it is truncated to the first or last vertex, and ``t Returns a point within the curve at position ``offset``, where ``offset`` is measured as a pixel distance along the curve. -To do that, it finds the two cached points where the ``offset`` lies between, then interpolates the values. This interpolation is cubic if ``cubic`` is set to true, or linear if set to false. +To do that, it finds the two cached points where the ``offset`` lies between, then interpolates the values. This interpolation is cubic if ``cubic`` is set to ``true``, or linear if set to ``false``. Cubic interpolation tends to follow the curves better, but linear is faster (and often, precise enough). diff --git a/classes/class_curve3d.rst b/classes/class_curve3d.rst index 6774be772..40bfec5b2 100644 --- a/classes/class_curve3d.rst +++ b/classes/class_curve3d.rst @@ -213,7 +213,7 @@ If ``idx`` is out of bounds it is truncated to the first or last vertex, and ``t Returns a point within the curve at position ``offset``, where ``offset`` is measured as a pixel distance along the curve. -To do that, it finds the two cached points where the ``offset`` lies between, then interpolates the values. This interpolation is cubic if ``cubic`` is set to true, or linear if set to false. +To do that, it finds the two cached points where the ``offset`` lies between, then interpolates the values. This interpolation is cubic if ``cubic`` is set to ``true``, or linear if set to ``false``. Cubic interpolation tends to follow the curves better, but linear is faster (and often, precise enough). diff --git a/classes/class_dictionary.rst b/classes/class_dictionary.rst index e44690750..a01d37983 100644 --- a/classes/class_dictionary.rst +++ b/classes/class_dictionary.rst @@ -85,7 +85,7 @@ Creates a copy of the dictionary, and returns it. - :ref:`bool` **empty** **(** **)** -Return true if the dictionary is empty. +Return ``true`` if the dictionary is empty. .. _class_Dictionary_method_erase: @@ -103,13 +103,13 @@ Returns the current value for the specified key in the ``Dictionary``. If the ke - :ref:`bool` **has** **(** :ref:`Variant` key **)** -Return true if the dictionary has a given key. +Return ``true`` if the dictionary has a given key. .. _class_Dictionary_method_has_all: - :ref:`bool` **has_all** **(** :ref:`Array` keys **)** -Return true if the dictionary has all of the keys in the given array. +Return ``true`` if the dictionary has all of the keys in the given array. .. _class_Dictionary_method_hash: diff --git a/classes/class_dynamicfont.rst b/classes/class_dynamicfont.rst index a6efa92e1..20d195f83 100644 --- a/classes/class_dynamicfont.rst +++ b/classes/class_dynamicfont.rst @@ -84,6 +84,13 @@ Description DynamicFont renders vector font files (such as TTF or OTF) dynamically at runtime instead of using a prerendered texture atlas like :ref:`BitmapFont`. This trades the faster loading time of :ref:`BitmapFont`\ s for the ability to change font parameters like size and spacing during runtime. :ref:`DynamicFontData` is used for referencing the font file paths. +:: + + var dynamic_font = DynamicFont.new() + dynamic_font.font_data = load("res://BarlowCondensed-Bold.ttf") + dynamic_font.size = 64 + $"Label".set("custom_fonts/font", dynamic_font) + Property Descriptions --------------------- diff --git a/classes/class_editorfeatureprofile.rst b/classes/class_editorfeatureprofile.rst new file mode 100644 index 000000000..fd3ec9fa1 --- /dev/null +++ b/classes/class_editorfeatureprofile.rst @@ -0,0 +1,131 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the EditorFeatureProfile.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_EditorFeatureProfile: + +EditorFeatureProfile +==================== + +**Inherits:** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Methods +------- + ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_feature_name` **(** :ref:`Feature` feature **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_class_disabled` **(** :ref:`String` class_name **)** const | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_class_editor_disabled` **(** :ref:`String` class_name **)** const | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_class_property_disabled` **(** :ref:`String` class_name, :ref:`String` arg1 **)** const | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_feature_disabled` **(** :ref:`Feature` feature **)** const | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`load_from_file` **(** :ref:`String` path **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`save_to_file` **(** :ref:`String` path **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_disable_class` **(** :ref:`String` class_name, :ref:`bool` disable **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_disable_class_editor` **(** :ref:`String` class_name, :ref:`bool` disable **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_disable_class_property` **(** :ref:`String` class_name, :ref:`String` property, :ref:`bool` arg2 **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_disable_feature` **(** :ref:`Feature` feature, :ref:`bool` disable **)** | ++---------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Enumerations +------------ + +.. _enum_EditorFeatureProfile_Feature: + +.. _class_EditorFeatureProfile_constant_FEATURE_3D: + +.. _class_EditorFeatureProfile_constant_FEATURE_SCRIPT: + +.. _class_EditorFeatureProfile_constant_FEATURE_ASSET_LIB: + +.. _class_EditorFeatureProfile_constant_FEATURE_SCENE_TREE: + +.. _class_EditorFeatureProfile_constant_FEATURE_IMPORT_DOCK: + +.. _class_EditorFeatureProfile_constant_FEATURE_NODE_DOCK: + +.. _class_EditorFeatureProfile_constant_FEATURE_FILESYSTEM_DOCK: + +.. _class_EditorFeatureProfile_constant_FEATURE_MAX: + +enum **Feature**: + +- **FEATURE_3D** = **0** + +- **FEATURE_SCRIPT** = **1** + +- **FEATURE_ASSET_LIB** = **2** + +- **FEATURE_SCENE_TREE** = **3** + +- **FEATURE_IMPORT_DOCK** = **4** + +- **FEATURE_NODE_DOCK** = **5** + +- **FEATURE_FILESYSTEM_DOCK** = **6** + +- **FEATURE_MAX** = **7** + +Method Descriptions +------------------- + +.. _class_EditorFeatureProfile_method_get_feature_name: + +- :ref:`String` **get_feature_name** **(** :ref:`Feature` feature **)** + +.. _class_EditorFeatureProfile_method_is_class_disabled: + +- :ref:`bool` **is_class_disabled** **(** :ref:`String` class_name **)** const + +.. _class_EditorFeatureProfile_method_is_class_editor_disabled: + +- :ref:`bool` **is_class_editor_disabled** **(** :ref:`String` class_name **)** const + +.. _class_EditorFeatureProfile_method_is_class_property_disabled: + +- :ref:`bool` **is_class_property_disabled** **(** :ref:`String` class_name, :ref:`String` arg1 **)** const + +.. _class_EditorFeatureProfile_method_is_feature_disabled: + +- :ref:`bool` **is_feature_disabled** **(** :ref:`Feature` feature **)** const + +.. _class_EditorFeatureProfile_method_load_from_file: + +- :ref:`Error` **load_from_file** **(** :ref:`String` path **)** + +.. _class_EditorFeatureProfile_method_save_to_file: + +- :ref:`Error` **save_to_file** **(** :ref:`String` path **)** + +.. _class_EditorFeatureProfile_method_set_disable_class: + +- void **set_disable_class** **(** :ref:`String` class_name, :ref:`bool` disable **)** + +.. _class_EditorFeatureProfile_method_set_disable_class_editor: + +- void **set_disable_class_editor** **(** :ref:`String` class_name, :ref:`bool` disable **)** + +.. _class_EditorFeatureProfile_method_set_disable_class_property: + +- void **set_disable_class_property** **(** :ref:`String` class_name, :ref:`String` property, :ref:`bool` arg2 **)** + +.. _class_EditorFeatureProfile_method_set_disable_feature: + +- void **set_disable_feature** **(** :ref:`Feature` feature, :ref:`bool` disable **)** + diff --git a/classes/class_editorfilesystem.rst b/classes/class_editorfilesystem.rst index 92f912a00..1151b429f 100644 --- a/classes/class_editorfilesystem.rst +++ b/classes/class_editorfilesystem.rst @@ -100,7 +100,7 @@ Return the scan progress for 0 to 1 if the FS is being scanned. - :ref:`bool` **is_scanning** **(** **)** const -Return true of the filesystem is being scanned. +Return ``true`` of the filesystem is being scanned. .. _class_EditorFileSystem_method_scan: diff --git a/classes/class_editorinspectorplugin.rst b/classes/class_editorinspectorplugin.rst index c7c967603..956c615de 100644 --- a/classes/class_editorinspectorplugin.rst +++ b/classes/class_editorinspectorplugin.rst @@ -14,7 +14,7 @@ EditorInspectorPlugin Brief Description ----------------- - +Plugin for adding custom property editors on inspector. Methods ------- @@ -37,6 +37,23 @@ Methods | :ref:`bool` | :ref:`parse_property` **(** :ref:`Object` object, :ref:`int` type, :ref:`String` path, :ref:`int` hint, :ref:`String` hint_text, :ref:`int` usage **)** virtual | +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +Description +----------- + +This plugins allows adding custom property editors to :ref:`EditorInspector`. + +Plugins are registered via :ref:`EditorPlugin.add_inspector_plugin`. + +When an object is edited, the :ref:`can_handle` function is called and must return true if the object type is supported. + +If supported, the function :ref:`parse_begin` will be called, allowing to place custom controls at the beginning of the class. + +Subsequently, the :ref:`parse_category` and :ref:`parse_property` are called for every category and property. They offer the ability to add custom controls to the inspector too. + +Finally :ref:`parse_end` will be called. + +On each of these calls, the "add" functions can be called. + Method Descriptions ------------------- @@ -44,31 +61,47 @@ Method Descriptions - void **add_custom_control** **(** :ref:`Control` control **)** +Add a custom control, not necesarily a property editor. + .. _class_EditorInspectorPlugin_method_add_property_editor: - void **add_property_editor** **(** :ref:`String` property, :ref:`Control` editor **)** +Add a property editor, this must inherit :ref:`EditorProperty`. + .. _class_EditorInspectorPlugin_method_add_property_editor_for_multiple_properties: - void **add_property_editor_for_multiple_properties** **(** :ref:`String` label, :ref:`PoolStringArray` properties, :ref:`Control` editor **)** +Add am editor that allows modifying multiple properties, this must inherit :ref:`EditorProperty`. + .. _class_EditorInspectorPlugin_method_can_handle: - :ref:`bool` **can_handle** **(** :ref:`Object` object **)** virtual +Return true if this object can be handled by this plugin. + .. _class_EditorInspectorPlugin_method_parse_begin: - void **parse_begin** **(** :ref:`Object` object **)** virtual +Called to allow adding controls at the beginning of the list. + .. _class_EditorInspectorPlugin_method_parse_category: - void **parse_category** **(** :ref:`Object` object, :ref:`String` category **)** virtual +Called to allow adding controls at the beginning of the category. + .. _class_EditorInspectorPlugin_method_parse_end: - void **parse_end** **(** **)** virtual +Called to allow adding controls at the end of the list. + .. _class_EditorInspectorPlugin_method_parse_property: - :ref:`bool` **parse_property** **(** :ref:`Object` object, :ref:`int` type, :ref:`String` path, :ref:`int` hint, :ref:`String` hint_text, :ref:`int` usage **)** virtual +Called to allow adding property specific editors to the inspector. Usually these inherit :ref:`EditorProperty` + diff --git a/classes/class_editorinterface.rst b/classes/class_editorinterface.rst index e235c9f06..6379a0800 100644 --- a/classes/class_editorinterface.rst +++ b/classes/class_editorinterface.rst @@ -30,6 +30,8 @@ Methods +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Control` | :ref:`get_editor_viewport` **(** **)** | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`EditorInspector` | :ref:`get_inspector` **(** **)** const | ++-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_open_scenes` **(** **)** const | +-----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`EditorFileSystem` | :ref:`get_resource_filesystem` **(** **)** | @@ -99,6 +101,10 @@ Returns the :ref:`EditorSettings`. Returns the editor :ref:`Viewport`. +.. _class_EditorInterface_method_get_inspector: + +- :ref:`EditorInspector` **get_inspector** **(** **)** const + .. _class_EditorInterface_method_get_open_scenes: - :ref:`Array` **get_open_scenes** **(** **)** const diff --git a/classes/class_editorplugin.rst b/classes/class_editorplugin.rst index 1bad9b721..de8186e0e 100644 --- a/classes/class_editorplugin.rst +++ b/classes/class_editorplugin.rst @@ -442,13 +442,13 @@ Get the GUI layout of the plugin. This is used to save the project's editor layo - :ref:`bool` **handles** **(** :ref:`Object` object **)** virtual -Implement this function if your plugin edits a specific type of object (Resource or Node). If you return true, then you will get the functions :ref:`edit` and :ref:`make_visible` called when the editor requests them. If you have declared the methods :ref:`forward_canvas_gui_input` and :ref:`forward_spatial_gui_input` these will be called too. +Implement this function if your plugin edits a specific type of object (Resource or Node). If you return ``true``, then you will get the functions :ref:`edit` and :ref:`make_visible` called when the editor requests them. If you have declared the methods :ref:`forward_canvas_gui_input` and :ref:`forward_spatial_gui_input` these will be called too. .. _class_EditorPlugin_method_has_main_screen: - :ref:`bool` **has_main_screen** **(** **)** virtual -Return true if this is a main screen editor plugin (it goes in the workspaces selector together with '2D', '3D', and 'Script'). +Return ``true`` if this is a main screen editor plugin (it goes in the workspaces selector together with '2D', '3D', and 'Script'). .. _class_EditorPlugin_method_hide_bottom_panel: diff --git a/classes/class_editorproperty.rst b/classes/class_editorproperty.rst index 14ef7b012..170e3f8e1 100644 --- a/classes/class_editorproperty.rst +++ b/classes/class_editorproperty.rst @@ -14,7 +14,7 @@ EditorProperty Brief Description ----------------- - +Custom control to edit properties for adding into the inspector Properties ---------- @@ -36,6 +36,8 @@ Properties Methods ------- ++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_focusable` **(** :ref:`Control` control **)** | +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`emit_changed` **(** :ref:`String` property, :ref:`Variant` value, :ref:`String` field="", :ref:`bool` changing=false **)** | +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -45,6 +47,8 @@ Methods +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_tooltip_text` **(** **)** const | +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bottom_editor` **(** :ref:`Control` editor **)** | ++-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`update_property` **(** **)** virtual | +-----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -55,34 +59,55 @@ Signals - **multiple_properties_changed** **(** :ref:`PoolStringArray` properties, :ref:`Array` value **)** +Emit yourself if you want multiple properties modified at the same time. Do not use if added via :ref:`EditorInspectorPlugin.parse_property` + .. _class_EditorProperty_signal_object_id_selected: - **object_id_selected** **(** :ref:`String` property, :ref:`int` id **)** +Used by sub-inspectors. Emit if what was selected was an Object ID. + .. _class_EditorProperty_signal_property_changed: - **property_changed** **(** :ref:`String` property, :ref:`Nil` value **)** +Do not emit this manually, use the :ref:`emit_changed` method instead. + .. _class_EditorProperty_signal_property_checked: - **property_checked** **(** :ref:`String` property, :ref:`String` bool **)** +Used internally, when a property was checked. + .. _class_EditorProperty_signal_property_keyed: - **property_keyed** **(** :ref:`String` property **)** +Emit if you want to add this value as an animation key (check keying being enabled first). + .. _class_EditorProperty_signal_property_keyed_with_value: - **property_keyed_with_value** **(** :ref:`String` property, :ref:`Nil` value **)** +Emit if you want to key a property with a single value. + .. _class_EditorProperty_signal_resource_selected: - **resource_selected** **(** :ref:`String` path, :ref:`Resource` resource **)** +If you want a sub-resource to be edited, emit this signal with the resource. + .. _class_EditorProperty_signal_selected: - **selected** **(** :ref:`String` path, :ref:`int` focusable_idx **)** +Internal, used when selected. + +Description +----------- + +This control allows property editing for one or multiple properties into :ref:`EditorInspector`. It is added via :ref:`EditorInspectorPlugin`. + Property Descriptions --------------------- @@ -96,6 +121,8 @@ Property Descriptions | *Getter* | is_checkable() | +----------+----------------------+ +Used by the inspector, set when property is checkable. + .. _class_EditorProperty_property_checked: - :ref:`bool` **checked** @@ -106,6 +133,8 @@ Property Descriptions | *Getter* | is_checked() | +----------+--------------------+ +Used by the inspector, when the property is checked. + .. _class_EditorProperty_property_draw_red: - :ref:`bool` **draw_red** @@ -116,6 +145,8 @@ Property Descriptions | *Getter* | is_draw_red() | +----------+---------------------+ +Used by the inspector, when the property must draw with error color. + .. _class_EditorProperty_property_keying: - :ref:`bool` **keying** @@ -126,6 +157,8 @@ Property Descriptions | *Getter* | is_keying() | +----------+-------------------+ +Used by the inspector, when the property can add keys for animation/ + .. _class_EditorProperty_property_label: - :ref:`String` **label** @@ -136,6 +169,8 @@ Property Descriptions | *Getter* | get_label() | +----------+------------------+ +Set this property to change the label (if you want to show one) + .. _class_EditorProperty_property_read_only: - :ref:`bool` **read_only** @@ -146,26 +181,50 @@ Property Descriptions | *Getter* | is_read_only() | +----------+----------------------+ +Used by the inspector, when the property is read-only. + Method Descriptions ------------------- +.. _class_EditorProperty_method_add_focusable: + +- void **add_focusable** **(** :ref:`Control` control **)** + +If any of the controls added can gain keyboard focus, add it here. This ensures that focus will be restored if the inspector is refreshed. + .. _class_EditorProperty_method_emit_changed: - void **emit_changed** **(** :ref:`String` property, :ref:`Variant` value, :ref:`String` field="", :ref:`bool` changing=false **)** +If one (or many properties) changed, this must be called. "Field" is used in case your editor can modify fields separately (as an example, Vector3.x). The "changing" argument avoids the editor requesting this property to be refreshed (leave as false if unsure). + .. _class_EditorProperty_method_get_edited_object: - :ref:`Object` **get_edited_object** **(** **)** +Get the edited object. + .. _class_EditorProperty_method_get_edited_property: - :ref:`String` **get_edited_property** **(** **)** +Get the edited property. If your editor is for a single property (added via :ref:`EditorInspectorPlugin.parse_property`), then this will return it.. + .. _class_EditorProperty_method_get_tooltip_text: - :ref:`String` **get_tooltip_text** **(** **)** const +Override if you want to allow a custom tooltip over your property. + +.. _class_EditorProperty_method_set_bottom_editor: + +- void **set_bottom_editor** **(** :ref:`Control` editor **)** + +Add controls with this function if you want them on the bottom (below the label). + .. _class_EditorProperty_method_update_property: - void **update_property** **(** **)** virtual +When this virtual function is called, you must update your editor. + diff --git a/classes/class_editorsceneimporter.rst b/classes/class_editorsceneimporter.rst index 89badfd26..2f0d5eae8 100644 --- a/classes/class_editorsceneimporter.rst +++ b/classes/class_editorsceneimporter.rst @@ -9,6 +9,8 @@ EditorSceneImporter **Inherits:** :ref:`Reference` **<** :ref:`Object` +**Inherited By:** :ref:`EditorSceneImporterAssimp` + **Category:** Core Brief Description diff --git a/classes/class_editorsceneimporterassimp.rst b/classes/class_editorsceneimporterassimp.rst new file mode 100644 index 000000000..5c7f94e3c --- /dev/null +++ b/classes/class_editorsceneimporterassimp.rst @@ -0,0 +1,46 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the EditorSceneImporterAssimp.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_EditorSceneImporterAssimp: + +EditorSceneImporterAssimp +========================= + +**Inherits:** :ref:`EditorSceneImporter` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + +This is a multi-format 3d asset importer. + +Description +----------- + +This is a multi-format 3d asset importer. + +Use these FBX export settings from Autodesk Maya. + +:: + + * Smoothing Groups + * Smooth Mesh + * Triangluate (For mesh with blendshapes) + * Bake Animation + * Resample All + * Deformed Models + * Skins + * Blend Shapes + * Curve Filters + * Constant Key Reducer + * Auto Tangents Only + * DO NOT CHECK Constraints (Will Break File) + * Can check Embed Media (Embeds textures into FBX file to import) + -- Note: When importing embed media, texture and mesh will be a un-alterable file. + -- Reimport of fbx with updated texture is need if texture is updated. + * Units: Centimeters + * Up Axis: Y + * Binary format in FBX 2017 + diff --git a/classes/class_editorspatialgizmo.rst b/classes/class_editorspatialgizmo.rst index 8e333a9f8..612e8897b 100644 --- a/classes/class_editorspatialgizmo.rst +++ b/classes/class_editorspatialgizmo.rst @@ -107,7 +107,7 @@ Add an unscaled billboard for visualization. Call this function during :ref:`red Commit a handle being edited (handles must have been previously added by :ref:`add_handles`). -If the cancel parameter is true, an option to restore the edited value to the original is provided. +If the cancel parameter is ``true``, an option to restore the edited value to the original is provided. .. _class_EditorSpatialGizmo_method_get_handle_name: diff --git a/classes/class_editorspatialgizmoplugin.rst b/classes/class_editorspatialgizmoplugin.rst index 328a03f54..725b9ad10 100644 --- a/classes/class_editorspatialgizmoplugin.rst +++ b/classes/class_editorspatialgizmoplugin.rst @@ -58,7 +58,7 @@ Methods Description ----------- -EditorSpatialGizmoPlugin allows you to define a new type of Gizmo. There are two main ways to do so: extending :ref:`EditorSpatialGizmoPlugin` for the simpler gizmos, or creating a new :ref:`EditorSpatialGizmo` type. See the tutorial in the documentation for more info. +EditorSpatialGizmoPlugin allows you to define a new type of Gizmo. There are two main ways to do so: extending ``EditorSpatialGizmoPlugin`` for the simpler gizmos, or creating a new :ref:`EditorSpatialGizmo` type. See the tutorial in the documentation for more info. Tutorials --------- @@ -78,7 +78,7 @@ Adds a new material to the internal material list for the plugin. It can then be - :ref:`bool` **can_be_hidden** **(** **)** virtual -Override this method to define whether the gizmo can be hidden or not. Defaults to true. +Override this method to define whether the gizmo can be hidden or not. Defaults to ``true``. .. _class_EditorSpatialGizmoPlugin_method_commit_handle: diff --git a/classes/class_environment.rst b/classes/class_environment.rst index 79d42481b..161042a05 100644 --- a/classes/class_environment.rst +++ b/classes/class_environment.rst @@ -385,7 +385,7 @@ Global contrast value of the rendered scene (default value is 1). | *Getter* | is_adjustment_enabled() | +----------+------------------------------+ -Enables the adjustment\_\* options provided by this resource. If false, adjustments modifications will have no effect on the rendered scene. +Enables the adjustment\_\* options provided by this resource. If ``false``, adjustments modifications will have no effect on the rendered scene. .. _class_Environment_property_adjustment_saturation: diff --git a/classes/class_file.rst b/classes/class_file.rst index 60fc14d2c..fdcc319ed 100644 --- a/classes/class_file.rst +++ b/classes/class_file.rst @@ -26,95 +26,95 @@ Properties Methods ------- -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`close` **(** **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`eof_reached` **(** **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`file_exists` **(** :ref:`String` path **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_16` **(** **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_32` **(** **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_64` **(** **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_8` **(** **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_as_text` **(** **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`get_buffer` **(** :ref:`int` len **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_csv_line` **(** :ref:`String` delim="," **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_double` **(** **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`get_error` **(** **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_float` **(** **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_len` **(** **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_line` **(** **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_md5` **(** :ref:`String` path **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_modified_time` **(** :ref:`String` file **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_pascal_string` **(** **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_path` **(** **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_path_absolute` **(** **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_position` **(** **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_real` **(** **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_sha256` **(** :ref:`String` path **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_var` **(** **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_open` **(** **)** const | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`open` **(** :ref:`String` path, :ref:`int` flags **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`open_compressed` **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`int` compression_mode=0 **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`open_encrypted` **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`PoolByteArray` key **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`open_encrypted_with_pass` **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`String` pass **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`seek` **(** :ref:`int` position **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`seek_end` **(** :ref:`int` position=0 **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_16` **(** :ref:`int` value **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_32` **(** :ref:`int` value **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_64` **(** :ref:`int` value **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_8` **(** :ref:`int` value **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_buffer` **(** :ref:`PoolByteArray` buffer **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_csv_line` **(** :ref:`PoolStringArray` values, :ref:`String` delim="," **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_double` **(** :ref:`float` value **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_float` **(** :ref:`float` value **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_line` **(** :ref:`String` line **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_pascal_string` **(** :ref:`String` string **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_real` **(** :ref:`float` value **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_string` **(** :ref:`String` string **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`store_var` **(** :ref:`Variant` value **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`close` **(** **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`eof_reached` **(** **)** const | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`file_exists` **(** :ref:`String` path **)** const | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_16` **(** **)** const | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_32` **(** **)** const | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_64` **(** **)** const | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_8` **(** **)** const | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_as_text` **(** **)** const | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`get_buffer` **(** :ref:`int` len **)** const | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_csv_line` **(** :ref:`String` delim="," **)** const | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_double` **(** **)** const | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`get_error` **(** **)** const | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_float` **(** **)** const | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_len` **(** **)** const | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_line` **(** **)** const | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_md5` **(** :ref:`String` path **)** const | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_modified_time` **(** :ref:`String` file **)** const | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_pascal_string` **(** **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_path` **(** **)** const | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_path_absolute` **(** **)** const | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_position` **(** **)** const | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_real` **(** **)** const | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_sha256` **(** :ref:`String` path **)** const | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_var` **(** :ref:`bool` allow_objects=false **)** const | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_open` **(** **)** const | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`open` **(** :ref:`String` path, :ref:`ModeFlags` flags **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`open_compressed` **(** :ref:`String` path, :ref:`ModeFlags` mode_flags, :ref:`CompressionMode` compression_mode=0 **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`open_encrypted` **(** :ref:`String` path, :ref:`ModeFlags` mode_flags, :ref:`PoolByteArray` key **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`open_encrypted_with_pass` **(** :ref:`String` path, :ref:`ModeFlags` mode_flags, :ref:`String` pass **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`seek` **(** :ref:`int` position **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`seek_end` **(** :ref:`int` position=0 **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_16` **(** :ref:`int` value **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_32` **(** :ref:`int` value **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_64` **(** :ref:`int` value **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_8` **(** :ref:`int` value **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_buffer` **(** :ref:`PoolByteArray` buffer **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_csv_line` **(** :ref:`PoolStringArray` values, :ref:`String` delim="," **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_double` **(** :ref:`float` value **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_float` **(** :ref:`float` value **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_line` **(** :ref:`String` line **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_pascal_string` **(** :ref:`String` string **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_real` **(** :ref:`float` value **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_string` **(** :ref:`String` string **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`store_var` **(** :ref:`Variant` value, :ref:`bool` full_objects=false **)** | ++-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ @@ -256,6 +256,8 @@ Returns the next 8 bits from the file as an integer. Returns the whole file as a :ref:`String`. +Text is interpreted as being UTF-8 encoded. + .. _class_File_method_get_buffer: - :ref:`PoolByteArray` **get_buffer** **(** :ref:`int` len **)** const @@ -268,6 +270,8 @@ Returns next ``len`` bytes of the file as a :ref:`PoolByteArray` **get_double** **(** **)** const @@ -298,6 +302,8 @@ Returns the size of the file in bytes. Returns the next line of the file as a :ref:`String`. +Text is interpreted as being UTF-8 encoded. + .. _class_File_method_get_md5: - :ref:`String` **get_md5** **(** :ref:`String` path **)** const @@ -316,6 +322,8 @@ Returns the last time the ``file`` was modified in unix timestamp format or retu Returns a :ref:`String` saved in Pascal format from the file. +Text is interpreted as being UTF-8 encoded. + .. _class_File_method_get_path: - :ref:`String` **get_path** **(** **)** const @@ -348,9 +356,11 @@ Returns a SHA-256 :ref:`String` representing the file at the given .. _class_File_method_get_var: -- :ref:`Variant` **get_var** **(** **)** const +- :ref:`Variant` **get_var** **(** :ref:`bool` allow_objects=false **)** const -Returns the next :ref:`Variant` value from the file. +Returns the next :ref:`Variant` value from the file. When ``allow_objects`` is ``true`` decoding objects is allowed. + +**WARNING:** Deserialized object can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats (remote code execution). .. _class_File_method_is_open: @@ -360,25 +370,25 @@ Returns ``true`` if the file is currently opened. .. _class_File_method_open: -- :ref:`Error` **open** **(** :ref:`String` path, :ref:`int` flags **)** +- :ref:`Error` **open** **(** :ref:`String` path, :ref:`ModeFlags` flags **)** Opens the file for writing or reading, depending on the flags. .. _class_File_method_open_compressed: -- :ref:`Error` **open_compressed** **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`int` compression_mode=0 **)** +- :ref:`Error` **open_compressed** **(** :ref:`String` path, :ref:`ModeFlags` mode_flags, :ref:`CompressionMode` compression_mode=0 **)** Opens a compressed file for reading or writing. Use COMPRESSION\_\* constants to set ``compression_mode``. .. _class_File_method_open_encrypted: -- :ref:`Error` **open_encrypted** **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`PoolByteArray` key **)** +- :ref:`Error` **open_encrypted** **(** :ref:`String` path, :ref:`ModeFlags` mode_flags, :ref:`PoolByteArray` key **)** Opens an encrypted file in write or read mode. You need to pass a binary key to encrypt/decrypt it. .. _class_File_method_open_encrypted_with_pass: -- :ref:`Error` **open_encrypted_with_pass** **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`String` pass **)** +- :ref:`Error` **open_encrypted_with_pass** **(** :ref:`String` path, :ref:`ModeFlags` mode_flags, :ref:`String` pass **)** Opens an encrypted file in write or read mode. You need to pass a password to encrypt/decrypt it. @@ -430,6 +440,8 @@ Stores the given array of bytes in the file. Store the given :ref:`PoolStringArray` in the file as a line formatted in the CSV (Comma Separated Values) format. You can pass a different delimiter to use other than the default "," (comma), it should be one character long. +Text will be encoded as UTF-8. + .. _class_File_method_store_double: - void **store_double** **(** :ref:`float` value **)** @@ -448,12 +460,16 @@ Stores a floating point number as 32 bits in the file. Stores the given :ref:`String` as a line in the file. +Text will be encoded as UTF-8. + .. _class_File_method_store_pascal_string: - void **store_pascal_string** **(** :ref:`String` string **)** Stores the given :ref:`String` as a line in the file in Pascal format (i.e. also store the length of the string). +Text will be encoded as UTF-8. + .. _class_File_method_store_real: - void **store_real** **(** :ref:`float` value **)** @@ -466,9 +482,11 @@ Stores a floating point number in the file. Stores the given :ref:`String` in the file. +Text will be encoded as UTF-8. + .. _class_File_method_store_var: -- void **store_var** **(** :ref:`Variant` value **)** +- void **store_var** **(** :ref:`Variant` value, :ref:`bool` full_objects=false **)** -Stores any Variant value in the file. +Stores any Variant value in the file. When ``full_objects`` is ``true`` encoding objects is allowed (and can potentially include code). diff --git a/classes/class_geometryinstance.rst b/classes/class_geometryinstance.rst index 75dda39fa..0ea20892d 100644 --- a/classes/class_geometryinstance.rst +++ b/classes/class_geometryinstance.rst @@ -9,7 +9,7 @@ GeometryInstance **Inherits:** :ref:`VisualInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`CPUParticles`, :ref:`ImmediateGeometry`, :ref:`MeshInstance`, :ref:`MultiMeshInstance`, :ref:`Particles`, :ref:`SpriteBase3D` +**Inherited By:** :ref:`CPUParticles`, :ref:`CSGShape`, :ref:`ImmediateGeometry`, :ref:`MeshInstance`, :ref:`MultiMeshInstance`, :ref:`Particles`, :ref:`SpriteBase3D` **Category:** Core diff --git a/classes/class_graphedit.rst b/classes/class_graphedit.rst index 255fc38f2..9dfd4fc0b 100644 --- a/classes/class_graphedit.rst +++ b/classes/class_graphedit.rst @@ -277,7 +277,7 @@ Return an Array containing the list of connections. A connection consists in a s - :ref:`bool` **is_node_connected** **(** :ref:`String` from, :ref:`int` from_port, :ref:`String` to, :ref:`int` to_port **)** -Return true if the 'from_port' slot of 'from' GraphNode is connected to the 'to_port' slot of 'to' GraphNode. +Return ``true`` if the 'from_port' slot of 'from' GraphNode is connected to the 'to_port' slot of 'to' GraphNode. .. _class_GraphEdit_method_is_valid_connection_type: diff --git a/classes/class_graphnode.rst b/classes/class_graphnode.rst index 539ae5b64..2722f98bd 100644 --- a/classes/class_graphnode.rst +++ b/classes/class_graphnode.rst @@ -336,13 +336,13 @@ Return the (integer) type of right (output) 'idx' slot. - :ref:`bool` **is_slot_enabled_left** **(** :ref:`int` idx **)** const -Return true if left (input) slot 'idx' is enabled. False otherwise. +Return ``true`` if left (input) slot 'idx' is enabled, ``false`` otherwise. .. _class_GraphNode_method_is_slot_enabled_right: - :ref:`bool` **is_slot_enabled_right** **(** :ref:`int` idx **)** const -Return true if right (output) slot 'idx' is enabled. False otherwise. +Return ``true`` if right (output) slot 'idx' is enabled, ``false`` otherwise. .. _class_GraphNode_method_set_slot: diff --git a/classes/class_heightmapshape.rst b/classes/class_heightmapshape.rst new file mode 100644 index 000000000..139f30a30 --- /dev/null +++ b/classes/class_heightmapshape.rst @@ -0,0 +1,73 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the HeightMapShape.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_HeightMapShape: + +HeightMapShape +============== + +**Inherits:** :ref:`Shape` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + +Height map shape for 3D physics (bullet only) + +Properties +---------- + ++-------------------------------------------+-----------------------------------------------------------+ +| :ref:`PoolRealArray` | :ref:`map_data` | ++-------------------------------------------+-----------------------------------------------------------+ +| :ref:`int` | :ref:`map_depth` | ++-------------------------------------------+-----------------------------------------------------------+ +| :ref:`int` | :ref:`map_width` | ++-------------------------------------------+-----------------------------------------------------------+ + +Description +----------- + +Height map shape resource, which can be added to a :ref:`PhysicsBody` or :ref:`Area`. + +Property Descriptions +--------------------- + +.. _class_HeightMapShape_property_map_data: + +- :ref:`PoolRealArray` **map_data** + ++----------+---------------------+ +| *Setter* | set_map_data(value) | ++----------+---------------------+ +| *Getter* | get_map_data() | ++----------+---------------------+ + +Height map data, pool array must be of :ref:`map_width` \* :ref:`map_depth` size. + +.. _class_HeightMapShape_property_map_depth: + +- :ref:`int` **map_depth** + ++----------+----------------------+ +| *Setter* | set_map_depth(value) | ++----------+----------------------+ +| *Getter* | get_map_depth() | ++----------+----------------------+ + +Depth of the height map data. Changing this will resize the :ref:`map_data`. + +.. _class_HeightMapShape_property_map_width: + +- :ref:`int` **map_width** + ++----------+----------------------+ +| *Setter* | set_map_width(value) | ++----------+----------------------+ +| *Getter* | get_map_width() | ++----------+----------------------+ + +Width of the height map data. Changing this will resize the :ref:`map_data`. + diff --git a/classes/class_httpclient.rst b/classes/class_httpclient.rst index 2cf5c4188..8e0119cd7 100644 --- a/classes/class_httpclient.rst +++ b/classes/class_httpclient.rst @@ -311,7 +311,7 @@ enum **ResponseCode**: - **RESPONSE_SEE_OTHER** = **303** --- HTTP status code ``303 See Other``. The server is redirecting the user agent to a different resource, as indicated by a URI in the Location header field, which is intended to provide an indirect response to the original request. -- **RESPONSE_NOT_MODIFIED** = **304** --- HTTP status code ``304 Not Modified``. A conditional GET or HEAD request has been received and would have resulted in a 200 OK response if it were not for the fact that the condition evaluated to false. +- **RESPONSE_NOT_MODIFIED** = **304** --- HTTP status code ``304 Not Modified``. A conditional GET or HEAD request has been received and would have resulted in a 200 OK response if it were not for the fact that the condition evaluated to ``false``. - **RESPONSE_USE_PROXY** = **305** --- HTTP status code ``305 Use Proxy``. Deprecated. Do not use. @@ -345,7 +345,7 @@ enum **ResponseCode**: - **RESPONSE_LENGTH_REQUIRED** = **411** --- HTTP status code ``411 Length Required``. The server refuses to accept the request without a defined Content-Length header. -- **RESPONSE_PRECONDITION_FAILED** = **412** --- HTTP status code ``412 Precondition Failed``. One or more conditions given in the request header fields evaluated to false when tested on the server. +- **RESPONSE_PRECONDITION_FAILED** = **412** --- HTTP status code ``412 Precondition Failed``. One or more conditions given in the request header fields evaluated to ``false`` when tested on the server. - **RESPONSE_REQUEST_ENTITY_TOO_LARGE** = **413** --- HTTP status code ``413 Entity Too Large``. The server is refusing to process a request because the request payload is larger than the server is willing or able to process. diff --git a/classes/class_image.rst b/classes/class_image.rst index b8f41dd13..dd5b4a650 100644 --- a/classes/class_image.rst +++ b/classes/class_image.rst @@ -453,13 +453,13 @@ Copies ``src`` image to this image. - void **create** **(** :ref:`int` width, :ref:`int` height, :ref:`bool` use_mipmaps, :ref:`Format` format **)** -Creates an empty image of given size and format. See ``FORMAT_*`` constants. If ``use_mipmaps`` is true then generate mipmaps for this image. See the ``generate_mipmaps`` method. +Creates an empty image of given size and format. See ``FORMAT_*`` constants. If ``use_mipmaps`` is ``true`` then generate mipmaps for this image. See the ``generate_mipmaps`` method. .. _class_Image_method_create_from_data: - void **create_from_data** **(** :ref:`int` width, :ref:`int` height, :ref:`bool` use_mipmaps, :ref:`Format` format, :ref:`PoolByteArray` data **)** -Creates a new image of given size and format. See ``FORMAT_*`` constants. Fills the image with the given raw data. If ``use_mipmaps`` is true then generate mipmaps for this image. See the ``generate_mipmaps`` method. +Creates a new image of given size and format. See ``FORMAT_*`` constants. Fills the image with the given raw data. If ``use_mipmaps`` is ``true`` then generate mipmaps for this image. See the ``generate_mipmaps`` method. .. _class_Image_method_crop: diff --git a/classes/class_input.rst b/classes/class_input.rst index 67a03850c..63924b1b2 100644 --- a/classes/class_input.rst +++ b/classes/class_input.rst @@ -21,83 +21,85 @@ A Singleton that deals with inputs. Methods ------- -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`action_press` **(** :ref:`String` action, :ref:`float` strength=1.0 **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`action_release` **(** :ref:`String` action **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_joy_mapping` **(** :ref:`String` mapping, :ref:`bool` update_existing=false **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_accelerometer` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_action_strength` **(** :ref:`String` action **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_connected_joypads` **(** **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_gravity` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_gyroscope` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_joy_axis` **(** :ref:`int` device, :ref:`int` axis **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_joy_axis_index_from_string` **(** :ref:`String` axis **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_joy_axis_string` **(** :ref:`int` axis_index **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_joy_button_index_from_string` **(** :ref:`String` button **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_joy_button_string` **(** :ref:`int` button_index **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_joy_guid` **(** :ref:`int` device **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_joy_name` **(** :ref:`int` device **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_joy_vibration_duration` **(** :ref:`int` device **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_joy_vibration_strength` **(** :ref:`int` device **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_last_mouse_speed` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_magnetometer` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_mouse_button_mask` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`MouseMode` | :ref:`get_mouse_mode` **(** **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_just_pressed` **(** :ref:`String` action **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_just_released` **(** :ref:`String` action **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_action_pressed` **(** :ref:`String` action **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_joy_button_pressed` **(** :ref:`int` device, :ref:`int` button **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_joy_known` **(** :ref:`int` device **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_key_pressed` **(** :ref:`int` scancode **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_mouse_button_pressed` **(** :ref:`int` button **)** const | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`joy_connection_changed` **(** :ref:`int` device, :ref:`bool` connected, :ref:`String` name, :ref:`String` guid **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`parse_input_event` **(** :ref:`InputEvent` event **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_joy_mapping` **(** :ref:`String` guid **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_mouse_cursor` **(** :ref:`Resource` image, :ref:`CursorShape` shape=0, :ref:`Vector2` hotspot=Vector2( 0, 0 ) **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_default_cursor_shape` **(** :ref:`CursorShape` shape=0 **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mouse_mode` **(** :ref:`MouseMode` mode **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_accumulated_input` **(** :ref:`bool` enable **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`start_joy_vibration` **(** :ref:`int` device, :ref:`float` weak_magnitude, :ref:`float` strong_magnitude, :ref:`float` duration=0 **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop_joy_vibration` **(** :ref:`int` device **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`warp_mouse_position` **(** :ref:`Vector2` to **)** | -+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`action_press` **(** :ref:`String` action, :ref:`float` strength=1.0 **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`action_release` **(** :ref:`String` action **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_joy_mapping` **(** :ref:`String` mapping, :ref:`bool` update_existing=false **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_accelerometer` **(** **)** const | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_action_strength` **(** :ref:`String` action **)** const | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_connected_joypads` **(** **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`CursorShape` | :ref:`get_current_cursor_shape` **(** **)** const | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_gravity` **(** **)** const | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_gyroscope` **(** **)** const | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_joy_axis` **(** :ref:`int` device, :ref:`int` axis **)** const | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_joy_axis_index_from_string` **(** :ref:`String` axis **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_joy_axis_string` **(** :ref:`int` axis_index **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_joy_button_index_from_string` **(** :ref:`String` button **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_joy_button_string` **(** :ref:`int` button_index **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_joy_guid` **(** :ref:`int` device **)** const | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_joy_name` **(** :ref:`int` device **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_joy_vibration_duration` **(** :ref:`int` device **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_joy_vibration_strength` **(** :ref:`int` device **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_last_mouse_speed` **(** **)** const | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_magnetometer` **(** **)** const | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_mouse_button_mask` **(** **)** const | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`MouseMode` | :ref:`get_mouse_mode` **(** **)** const | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_action_just_pressed` **(** :ref:`String` action **)** const | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_action_just_released` **(** :ref:`String` action **)** const | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_action_pressed` **(** :ref:`String` action **)** const | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_joy_button_pressed` **(** :ref:`int` device, :ref:`int` button **)** const | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_joy_known` **(** :ref:`int` device **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_key_pressed` **(** :ref:`int` scancode **)** const | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_mouse_button_pressed` **(** :ref:`int` button **)** const | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`joy_connection_changed` **(** :ref:`int` device, :ref:`bool` connected, :ref:`String` name, :ref:`String` guid **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`parse_input_event` **(** :ref:`InputEvent` event **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_joy_mapping` **(** :ref:`String` guid **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_mouse_cursor` **(** :ref:`Resource` image, :ref:`CursorShape` shape=0, :ref:`Vector2` hotspot=Vector2( 0, 0 ) **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_default_cursor_shape` **(** :ref:`CursorShape` shape=0 **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_mouse_mode` **(** :ref:`MouseMode` mode **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_accumulated_input` **(** :ref:`bool` enable **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`start_joy_vibration` **(** :ref:`int` device, :ref:`float` weak_magnitude, :ref:`float` strong_magnitude, :ref:`float` duration=0 **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop_joy_vibration` **(** :ref:`int` device **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`warp_mouse_position` **(** :ref:`Vector2` to **)** | ++--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -256,6 +258,10 @@ Returns a value between 0 and 1 representing the intensity of the given action. Returns an :ref:`Array` containing the device IDs of all currently connected joypads. +.. _class_Input_method_get_current_cursor_shape: + +- :ref:`CursorShape` **get_current_cursor_shape** **(** **)** const + .. _class_Input_method_get_gravity: - :ref:`Vector3` **get_gravity** **(** **)** const @@ -272,7 +278,7 @@ If the device has a gyroscope, this will return the rate of rotation in rad/s ar - :ref:`float` **get_joy_axis** **(** :ref:`int` device, :ref:`int` axis **)** const -Returns the current value of the joypad axis at given index (see ``JOY_*`` constants in :ref:`@GlobalScope`) +Returns the current value of the joypad axis at given index (see :ref:`JoystickList`). .. _class_Input_method_get_joy_axis_index_from_string: @@ -284,7 +290,7 @@ Returns the index of the provided axis name. - :ref:`String` **get_joy_axis_string** **(** :ref:`int` axis_index **)** -Receives a ``JOY_AXIS_*`` Enum and returns its equivalent name as a string. +Receives a :ref:`JoystickList` axis and returns its equivalent name as a string. .. _class_Input_method_get_joy_button_index_from_string: @@ -296,7 +302,7 @@ Returns the index of the provided button name. - :ref:`String` **get_joy_button_string** **(** :ref:`int` button_index **)** -Receives a ``JOY_BUTTON_*`` Enum and returns its equivalent name as a string. +Receives a joy button from :ref:`JoystickList` and returns its equivalent name as a string. .. _class_Input_method_get_joy_guid: @@ -350,7 +356,7 @@ Return the mouse mode. See the constants for more information. - :ref:`bool` **is_action_just_pressed** **(** :ref:`String` action **)** const -Returns ``true`` when the user starts pressing the action event, meaning it's true only on the frame that the user pressed down the button. +Returns ``true`` when the user starts pressing the action event, meaning it's ``true`` only on the frame that the user pressed down the button. This is useful for code that needs to run only once when an action is pressed, instead of every frame while it's pressed. @@ -358,7 +364,7 @@ This is useful for code that needs to run only once when an action is pressed, i - :ref:`bool` **is_action_just_released** **(** :ref:`String` action **)** const -Returns ``true`` when the user stops pressing the action event, meaning it's true only on the frame that the user released the button. +Returns ``true`` when the user stops pressing the action event, meaning it's ``true`` only on the frame that the user released the button. .. _class_Input_method_is_action_pressed: @@ -370,25 +376,25 @@ Returns ``true`` if you are pressing the action event. - :ref:`bool` **is_joy_button_pressed** **(** :ref:`int` device, :ref:`int` button **)** const -Returns ``true`` if you are pressing the joypad button. (see ``JOY_*`` constants in :ref:`@GlobalScope`) +Returns ``true`` if you are pressing the joypad button (see :ref:`JoystickList`). .. _class_Input_method_is_joy_known: - :ref:`bool` **is_joy_known** **(** :ref:`int` device **)** -Returns ``true`` if the system knows the specified device. This means that it sets all button and axis indices exactly as defined in the ``JOY_*`` constants (see :ref:`@GlobalScope`). Unknown joypads are not expected to match these constants, but you can still retrieve events from them. +Returns ``true`` if the system knows the specified device. This means that it sets all button and axis indices exactly as defined in :ref:`JoystickList`. Unknown joypads are not expected to match these constants, but you can still retrieve events from them. .. _class_Input_method_is_key_pressed: - :ref:`bool` **is_key_pressed** **(** :ref:`int` scancode **)** const -Returns ``true`` if you are pressing the key. You can pass ``KEY_*``, which are pre-defined constants listed in :ref:`@GlobalScope`. +Returns ``true`` if you are pressing the key. You can pass a :ref:`KeyList` constant. .. _class_Input_method_is_mouse_button_pressed: - :ref:`bool` **is_mouse_button_pressed** **(** :ref:`int` button **)** const -Returns ``true`` if you are pressing the mouse button. You can pass ``BUTTON_*``, which are pre-defined constants listed in :ref:`@GlobalScope`. +Returns ``true`` if you are pressing the mouse button specified with :ref:`ButtonList`. .. _class_Input_method_joy_connection_changed: diff --git a/classes/class_inputeventjoypadbutton.rst b/classes/class_inputeventjoypadbutton.rst index d4acf638d..597a9ad4f 100644 --- a/classes/class_inputeventjoypadbutton.rst +++ b/classes/class_inputeventjoypadbutton.rst @@ -50,7 +50,7 @@ Property Descriptions | *Getter* | get_button_index() | +----------+-------------------------+ -Button identifier. One of the ``JOY_BUTTON_*`` constants from :ref:`@GlobalScope`. +Button identifier. One of the :ref:`JoystickList` button constants. .. _class_InputEventJoypadButton_property_pressed: diff --git a/classes/class_inputeventjoypadmotion.rst b/classes/class_inputeventjoypadmotion.rst index a380e104b..41018045f 100644 --- a/classes/class_inputeventjoypadmotion.rst +++ b/classes/class_inputeventjoypadmotion.rst @@ -48,7 +48,7 @@ Property Descriptions | *Getter* | get_axis() | +----------+-----------------+ -Axis identifier. Use one of the ``JOY_AXIS_*`` constants in :ref:`@GlobalScope`. +Axis identifier. Use one of the :ref:`JoystickList` axis constants. .. _class_InputEventJoypadMotion_property_axis_value: diff --git a/classes/class_inputeventkey.rst b/classes/class_inputeventkey.rst index 0e258ec6c..4a69f1f8f 100644 --- a/classes/class_inputeventkey.rst +++ b/classes/class_inputeventkey.rst @@ -83,7 +83,7 @@ If ``true``, the key's state is pressed. If ``false``, the key's state is releas | *Getter* | get_scancode() | +----------+---------------------+ -Key scancode, one of the ``KEY_*`` constants in :ref:`@GlobalScope`. +Key scancode, one of the :ref:`KeyList` constants. .. _class_InputEventKey_property_unicode: diff --git a/classes/class_inputeventmouse.rst b/classes/class_inputeventmouse.rst index b86b91159..493fa8f05 100644 --- a/classes/class_inputeventmouse.rst +++ b/classes/class_inputeventmouse.rst @@ -52,7 +52,7 @@ Property Descriptions | *Getter* | get_button_mask() | +----------+------------------------+ -Mouse button mask identifier, one of or a bitwise combination of the BUTTON_MASK\_\* constants in :ref:`@GlobalScope`. +Mouse button mask identifier, one of or a bitwise combination of the :ref:`ButtonList` button masks. .. _class_InputEventMouse_property_global_position: diff --git a/classes/class_inputeventmousebutton.rst b/classes/class_inputeventmousebutton.rst index af8e44851..8b2c67324 100644 --- a/classes/class_inputeventmousebutton.rst +++ b/classes/class_inputeventmousebutton.rst @@ -52,7 +52,7 @@ Property Descriptions | *Getter* | get_button_index() | +----------+-------------------------+ -Mouse button identifier, one of the BUTTON\_\* or BUTTON_WHEEL\_\* constants in :ref:`@GlobalScope`. +Mouse button identifier, one of the :ref:`ButtonList` button or button wheel constants. .. _class_InputEventMouseButton_property_doubleclick: diff --git a/classes/class_itemlist.rst b/classes/class_itemlist.rst index 1e9aa8ffc..ce6e15913 100644 --- a/classes/class_itemlist.rst +++ b/classes/class_itemlist.rst @@ -372,7 +372,7 @@ Adds an item to the item list with no text, only an icon. Adds an item to the item list with specified text. Specify an icon of null for a list item with no icon. -If selectable is true the list item will be selectable. +If selectable is ``true`` the list item will be selectable. .. _class_ItemList_method_clear: diff --git a/classes/class_kinematicbody.rst b/classes/class_kinematicbody.rst index ceb4a59fa..d2f46be4a 100644 --- a/classes/class_kinematicbody.rst +++ b/classes/class_kinematicbody.rst @@ -176,13 +176,13 @@ 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. -If ``stop_on_slope`` is true, body will not slide on slopes if you include gravity in ``linear_velocity``. +If ``stop_on_slope`` is ``true``, body will not slide on slopes if you include gravity in ``linear_velocity``. If the body collides, it will change direction a maximum of ``max_slides`` times before it stops. ``floor_max_angle`` is the maximum angle (in radians) where a slope is still considered a floor (or a ceiling), rather than a wall. The default value equals 45 degrees. -If ``infinite_inertia`` is true, body will be able to push :ref:`RigidBody` nodes, but it won't also detect any collisions with them. When false, it will interact with :ref:`RigidBody` nodes like with :ref:`StaticBody`. +If ``infinite_inertia`` is ``true``, body will be able to push :ref:`RigidBody` nodes, but it won't also detect any collisions with them. If ``false`` it will interact with :ref:`RigidBody` nodes like with :ref:`StaticBody`. Returns the ``linear_velocity`` vector, rotated and/or scaled if a slide collision occurred. To get detailed information about collisions that occurred, use :ref:`get_slide_collision`. diff --git a/classes/class_kinematicbody2d.rst b/classes/class_kinematicbody2d.rst index 38c6ea7fa..8bb1656ef 100644 --- a/classes/class_kinematicbody2d.rst +++ b/classes/class_kinematicbody2d.rst @@ -149,13 +149,13 @@ 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. -If ``stop_on_slope`` is true, body will not slide on slopes when you include gravity in ``linear_velocity`` and the body is standing still. +If ``stop_on_slope`` is ``true``, body will not slide on slopes when you include gravity in ``linear_velocity`` and the body is standing still. If the body collides, it will change direction a maximum of ``max_slides`` times before it stops. ``floor_max_angle`` is the maximum angle (in radians) where a slope is still considered a floor (or a ceiling), rather than a wall. The default value equals 45 degrees. -If ``infinite_inertia`` is true, body will be able to push :ref:`RigidBody2D` nodes, but it won't also detect any collisions with them. When false, it will interact with :ref:`RigidBody2D` nodes like with :ref:`StaticBody2D`. +If ``infinite_inertia`` is ``true``, body will be able to push :ref:`RigidBody2D` nodes, but it won't also detect any collisions with them. If ``false`` it will interact with :ref:`RigidBody2D` nodes like with :ref:`StaticBody2D`. Returns the ``linear_velocity`` vector, rotated and/or scaled if a slide collision occurred. To get detailed information about collisions that occurred, use :ref:`get_slide_collision`. diff --git a/classes/class_label.rst b/classes/class_label.rst index 9cf1c1094..47cb19715 100644 --- a/classes/class_label.rst +++ b/classes/class_label.rst @@ -152,7 +152,7 @@ Controls the text's horizontal align. Supports left, center, right, and fill, or | *Getter* | has_autowrap() | +----------+---------------------+ -If ``true``, wraps the text inside the node's bounding rectangle. If you resize the node, it will change its height automatically to show all the text. Default: false. +If ``true``, wraps the text inside the node's bounding rectangle. If you resize the node, it will change its height automatically to show all the text. Default: ``false``. .. _class_Label_property_clip_text: diff --git a/classes/class_line2d.rst b/classes/class_line2d.rst index bd97347bd..717d8060c 100644 --- a/classes/class_line2d.rst +++ b/classes/class_line2d.rst @@ -49,6 +49,8 @@ Methods +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_point` **(** :ref:`Vector2` position **)** | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_points` **(** **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_point_count` **(** **)** const | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_point_position` **(** :ref:`int` i **)** const | @@ -258,6 +260,12 @@ Method Descriptions Add a point at the ``position``. Appends the point at the end of the line. +.. _class_Line2D_method_clear_points: + +- void **clear_points** **(** **)** + +Removes all points from the line. + .. _class_Line2D_method_get_point_count: - :ref:`int` **get_point_count** **(** **)** const diff --git a/classes/class_lineedit.rst b/classes/class_lineedit.rst index b4b08dd77..51d9a1c8e 100644 --- a/classes/class_lineedit.rst +++ b/classes/class_lineedit.rst @@ -112,7 +112,7 @@ Emitted when the text changes. - **text_entered** **(** :ref:`String` new_text **)** -Emitted when the user presses ``KEY_ENTER`` on the ``LineEdit``. +Emitted when the user presses :ref:`@GlobalScope.KEY_ENTER` on the ``LineEdit``. Enumerations ------------ @@ -287,7 +287,7 @@ If ``true``, the ``LineEdit`` width will increase to stay longer than the :ref:` | *Getter* | get_focus_mode() | +----------+-----------------------+ -Defines how the ``LineEdit`` can grab focus (Keyboard and mouse, only keyboard, or none). See ``enum FocusMode`` in :ref:`Control` for details. +Defines how the ``LineEdit`` can grab focus (Keyboard and mouse, only keyboard, or none). See :ref:`FocusMode` in :ref:`Control` for details. .. _class_LineEdit_property_max_length: diff --git a/classes/class_mainloop.rst b/classes/class_mainloop.rst index 53a04aff3..be448ef29 100644 --- a/classes/class_mainloop.rst +++ b/classes/class_mainloop.rst @@ -76,29 +76,29 @@ Constants .. _class_MainLoop_constant_NOTIFICATION_OS_IME_UPDATE: -- **NOTIFICATION_WM_MOUSE_ENTER** = **2** +- **NOTIFICATION_WM_MOUSE_ENTER** = **1002** -- **NOTIFICATION_WM_MOUSE_EXIT** = **3** +- **NOTIFICATION_WM_MOUSE_EXIT** = **1003** -- **NOTIFICATION_WM_FOCUS_IN** = **4** +- **NOTIFICATION_WM_FOCUS_IN** = **1004** -- **NOTIFICATION_WM_FOCUS_OUT** = **5** +- **NOTIFICATION_WM_FOCUS_OUT** = **1005** -- **NOTIFICATION_WM_QUIT_REQUEST** = **6** +- **NOTIFICATION_WM_QUIT_REQUEST** = **1006** -- **NOTIFICATION_WM_GO_BACK_REQUEST** = **7** +- **NOTIFICATION_WM_GO_BACK_REQUEST** = **1007** -- **NOTIFICATION_WM_UNFOCUS_REQUEST** = **8** +- **NOTIFICATION_WM_UNFOCUS_REQUEST** = **1008** -- **NOTIFICATION_OS_MEMORY_WARNING** = **9** +- **NOTIFICATION_OS_MEMORY_WARNING** = **1009** -- **NOTIFICATION_TRANSLATION_CHANGED** = **90** +- **NOTIFICATION_TRANSLATION_CHANGED** = **1010** -- **NOTIFICATION_WM_ABOUT** = **91** +- **NOTIFICATION_WM_ABOUT** = **1011** -- **NOTIFICATION_CRASH** = **92** +- **NOTIFICATION_CRASH** = **1012** -- **NOTIFICATION_OS_IME_UPDATE** = **93** +- **NOTIFICATION_OS_IME_UPDATE** = **1013** Description ----------- diff --git a/classes/class_marshalls.rst b/classes/class_marshalls.rst index 8f5ea3acf..ef40d5ed4 100644 --- a/classes/class_marshalls.rst +++ b/classes/class_marshalls.rst @@ -19,19 +19,19 @@ Data transformation (marshalling) and encoding helpers. Methods ------- -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`base64_to_raw` **(** :ref:`String` base64_str **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`base64_to_utf8` **(** :ref:`String` base64_str **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`base64_to_variant` **(** :ref:`String` base64_str **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`raw_to_base64` **(** :ref:`PoolByteArray` array **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`utf8_to_base64` **(** :ref:`String` utf8_str **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`variant_to_base64` **(** :ref:`Variant` variant **)** | -+-------------------------------------------+------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`base64_to_raw` **(** :ref:`String` base64_str **)** | ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`base64_to_utf8` **(** :ref:`String` base64_str **)** | ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`base64_to_variant` **(** :ref:`String` base64_str, :ref:`bool` allow_objects=false **)** | ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`raw_to_base64` **(** :ref:`PoolByteArray` array **)** | ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`utf8_to_base64` **(** :ref:`String` utf8_str **)** | ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`variant_to_base64` **(** :ref:`Variant` variant, :ref:`bool` full_objects=false **)** | ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -55,9 +55,11 @@ Return utf8 String of a given base64 encoded String. .. _class_Marshalls_method_base64_to_variant: -- :ref:`Variant` **base64_to_variant** **(** :ref:`String` base64_str **)** +- :ref:`Variant` **base64_to_variant** **(** :ref:`String` base64_str, :ref:`bool` allow_objects=false **)** -Return :ref:`Variant` of a given base64 encoded String. +Return :ref:`Variant` of a given base64 encoded String. When ``allow_objects`` is ``true`` decoding objects is allowed. + +**WARNING:** Deserialized object can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats (remote code execution). .. _class_Marshalls_method_raw_to_base64: @@ -73,7 +75,7 @@ Return base64 encoded String of a given utf8 String. .. _class_Marshalls_method_variant_to_base64: -- :ref:`String` **variant_to_base64** **(** :ref:`Variant` variant **)** +- :ref:`String` **variant_to_base64** **(** :ref:`Variant` variant, :ref:`bool` full_objects=false **)** -Return base64 encoded String of a given :ref:`Variant`. +Return base64 encoded String of a given :ref:`Variant`. When ``full_objects`` is ``true`` encoding objects is allowed (and can potentially include code). diff --git a/classes/class_meshinstance.rst b/classes/class_meshinstance.rst index 2ea2a3faf..de90c1f0e 100644 --- a/classes/class_meshinstance.rst +++ b/classes/class_meshinstance.rst @@ -89,7 +89,7 @@ This helper creates a :ref:`StaticBody` child node with a :ref - void **create_debug_tangents** **(** **)** -This helper creates a :ref:`MeshInstance` child node with gizmos at every vertex calculated from the mesh geometry. It's mainly used for testing. +This helper creates a ``MeshInstance`` child node with gizmos at every vertex calculated from the mesh geometry. It's mainly used for testing. .. _class_MeshInstance_method_create_trimesh_collision: diff --git a/classes/class_meshlibrary.rst b/classes/class_meshlibrary.rst index 754a2caed..240054139 100644 --- a/classes/class_meshlibrary.rst +++ b/classes/class_meshlibrary.rst @@ -19,39 +19,43 @@ Library of meshes. Methods ------- -+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_item` **(** :ref:`int` id **)** | -+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_item_by_name` **(** :ref:`String` name **)** const | -+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolIntArray` | :ref:`get_item_list` **(** **)** const | -+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Mesh` | :ref:`get_item_mesh` **(** :ref:`int` id **)** const | -+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_item_name` **(** :ref:`int` id **)** const | -+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NavigationMesh` | :ref:`get_item_navmesh` **(** :ref:`int` id **)** const | -+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_item_preview` **(** :ref:`int` id **)** const | -+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_item_shapes` **(** :ref:`int` id **)** const | -+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_last_unused_item_id` **(** **)** const | -+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_item` **(** :ref:`int` id **)** | -+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_mesh` **(** :ref:`int` id, :ref:`Mesh` mesh **)** | -+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_name` **(** :ref:`int` id, :ref:`String` name **)** | -+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_navmesh` **(** :ref:`int` id, :ref:`NavigationMesh` navmesh **)** | -+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_preview` **(** :ref:`int` id, :ref:`Texture` texture **)** | -+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_item_shapes` **(** :ref:`int` id, :ref:`Array` shapes **)** | -+---------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_item` **(** :ref:`int` id **)** | ++---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find_item_by_name` **(** :ref:`String` name **)** const | ++---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`get_item_list` **(** **)** const | ++---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Mesh` | :ref:`get_item_mesh` **(** :ref:`int` id **)** const | ++---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_item_name` **(** :ref:`int` id **)** const | ++---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NavigationMesh` | :ref:`get_item_navmesh` **(** :ref:`int` id **)** const | ++---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`get_item_navmesh_transform` **(** :ref:`int` id **)** const | ++---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_item_preview` **(** :ref:`int` id **)** const | ++---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_item_shapes` **(** :ref:`int` id **)** const | ++---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_last_unused_item_id` **(** **)** const | ++---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_item` **(** :ref:`int` id **)** | ++---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_mesh` **(** :ref:`int` id, :ref:`Mesh` mesh **)** | ++---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_name` **(** :ref:`int` id, :ref:`String` name **)** | ++---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_navmesh` **(** :ref:`int` id, :ref:`NavigationMesh` navmesh **)** | ++---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_navmesh_transform` **(** :ref:`int` id, :ref:`Transform` navmesh **)** | ++---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_preview` **(** :ref:`int` id, :ref:`Texture` texture **)** | ++---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_item_shapes` **(** :ref:`int` id, :ref:`Array` shapes **)** | ++---------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -99,6 +103,10 @@ Return the name of the item. - :ref:`NavigationMesh` **get_item_navmesh** **(** :ref:`int` id **)** const +.. _class_MeshLibrary_method_get_item_navmesh_transform: + +- :ref:`Transform` **get_item_navmesh_transform** **(** :ref:`int` id **)** const + .. _class_MeshLibrary_method_get_item_preview: - :ref:`Texture` **get_item_preview** **(** :ref:`int` id **)** const @@ -135,6 +143,10 @@ Set the name of the item. - void **set_item_navmesh** **(** :ref:`int` id, :ref:`NavigationMesh` navmesh **)** +.. _class_MeshLibrary_method_set_item_navmesh_transform: + +- void **set_item_navmesh_transform** **(** :ref:`int` id, :ref:`Transform` navmesh **)** + .. _class_MeshLibrary_method_set_item_preview: - void **set_item_preview** **(** :ref:`int` id, :ref:`Texture` texture **)** diff --git a/classes/class_meshtexture.rst b/classes/class_meshtexture.rst new file mode 100644 index 000000000..ee446d8fc --- /dev/null +++ b/classes/class_meshtexture.rst @@ -0,0 +1,73 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the MeshTexture.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_MeshTexture: + +MeshTexture +=========== + +**Inherits:** :ref:`Texture` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + +Simple texture that uses a mesh to draw itself. + +Properties +---------- + ++-------------------------------+--------------------------------------------------------------+ +| :ref:`Texture` | :ref:`base_texture` | ++-------------------------------+--------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`image_size` | ++-------------------------------+--------------------------------------------------------------+ +| :ref:`Mesh` | :ref:`mesh` | ++-------------------------------+--------------------------------------------------------------+ + +Description +----------- + +Simple texture that uses a mesh to draw itself. It's limited because flags can't be changed and region drawing is not supported. + +Property Descriptions +--------------------- + +.. _class_MeshTexture_property_base_texture: + +- :ref:`Texture` **base_texture** + ++----------+-------------------------+ +| *Setter* | set_base_texture(value) | ++----------+-------------------------+ +| *Getter* | get_base_texture() | ++----------+-------------------------+ + +Set the base texture that the Mesh will use to draw. + +.. _class_MeshTexture_property_image_size: + +- :ref:`Vector2` **image_size** + ++----------+-----------------------+ +| *Setter* | set_image_size(value) | ++----------+-----------------------+ +| *Getter* | get_image_size() | ++----------+-----------------------+ + +Set the size of the image, needed for reference. + +.. _class_MeshTexture_property_mesh: + +- :ref:`Mesh` **mesh** + ++----------+-----------------+ +| *Setter* | set_mesh(value) | ++----------+-----------------+ +| *Getter* | get_mesh() | ++----------+-----------------+ + +Set the mesh used to draw. It must be a mesh using 2D vertices. + diff --git a/classes/class_mobilevrinterface.rst b/classes/class_mobilevrinterface.rst index 45e39cde3..d50edddc7 100644 --- a/classes/class_mobilevrinterface.rst +++ b/classes/class_mobilevrinterface.rst @@ -24,6 +24,8 @@ Properties +---------------------------+--------------------------------------------------------------------------+ | :ref:`float` | :ref:`display_width` | +---------------------------+--------------------------------------------------------------------------+ +| :ref:`float` | :ref:`eye_height` | ++---------------------------+--------------------------------------------------------------------------+ | :ref:`float` | :ref:`iod` | +---------------------------+--------------------------------------------------------------------------+ | :ref:`float` | :ref:`k1` | @@ -38,7 +40,15 @@ Description This is a generic mobile VR implementation where you need to provide details about the phone and HMD used. It does not rely on any existing framework. This is the most basic interface we have. For the best effect you do need a mobile phone with a gyroscope and accelerometer. -Note that even though there is no positional tracking the camera will assume the headset is at a height of 1.85 meters. +Note that even though there is no positional tracking the camera will assume the headset is at a height of 1.85 meters, you can change this by setting :ref:`eye_height`. + +You can initialise this interface as follows: + +:: + + var interface = ARVRServer.find_interface("Native mobile") + if interface and interface.initialize(): + get_viewport().arvr = true Property Descriptions --------------------- @@ -67,6 +77,18 @@ The distance between the display and the lenses inside of the device in centimet The width of the display in centimeters. +.. _class_MobileVRInterface_property_eye_height: + +- :ref:`float` **eye_height** + ++----------+-----------------------+ +| *Setter* | set_eye_height(value) | ++----------+-----------------------+ +| *Getter* | get_eye_height() | ++----------+-----------------------+ + +The height at which the camera is placed in relation to the ground (i.e. :ref:`ARVROrigin` node). + .. _class_MobileVRInterface_property_iod: - :ref:`float` **iod** diff --git a/classes/class_multimesh.rst b/classes/class_multimesh.rst index 28dfec407..7660be861 100644 --- a/classes/class_multimesh.rst +++ b/classes/class_multimesh.rst @@ -19,17 +19,19 @@ Provides high performance mesh instancing. Properties ---------- -+----------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`ColorFormat` | :ref:`color_format` | -+----------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`CustomDataFormat` | :ref:`custom_data_format` | -+----------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`int` | :ref:`instance_count` | -+----------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`Mesh` | :ref:`mesh` | -+----------------------------------------------------------+------------------------------------------------------------------------+ -| :ref:`TransformFormat` | :ref:`transform_format` | -+----------------------------------------------------------+------------------------------------------------------------------------+ ++----------------------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`ColorFormat` | :ref:`color_format` | ++----------------------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`CustomDataFormat` | :ref:`custom_data_format` | ++----------------------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`instance_count` | ++----------------------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`Mesh` | :ref:`mesh` | ++----------------------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`TransformFormat` | :ref:`transform_format` | ++----------------------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`visible_instance_count` | ++----------------------------------------------------------+--------------------------------------------------------------------------------+ Methods ------- @@ -180,6 +182,16 @@ Mesh to be drawn. Format of transform used to transform mesh, either 2D or 3D. +.. _class_MultiMesh_property_visible_instance_count: + +- :ref:`int` **visible_instance_count** + ++----------+-----------------------------------+ +| *Setter* | set_visible_instance_count(value) | ++----------+-----------------------------------+ +| *Getter* | get_visible_instance_count() | ++----------+-----------------------------------+ + Method Descriptions ------------------- diff --git a/classes/class_multiplayerapi.rst b/classes/class_multiplayerapi.rst index c94abc613..3e36681ed 100644 --- a/classes/class_multiplayerapi.rst +++ b/classes/class_multiplayerapi.rst @@ -19,6 +19,8 @@ High Level Multiplayer API. Properties ---------- ++-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`allow_object_decoding` | +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ | :ref:`NetworkedMultiplayerPeer` | :ref:`network_peer` | +-----------------------------------------------------------------+-----------------------------------------------------------------------------------------------------+ @@ -142,6 +144,20 @@ It is possible to override the MultiplayerAPI instance used by specific Nodes by Property Descriptions --------------------- +.. _class_MultiplayerAPI_property_allow_object_decoding: + +- :ref:`bool` **allow_object_decoding** + ++----------+----------------------------------+ +| *Setter* | set_allow_object_decoding(value) | ++----------+----------------------------------+ +| *Getter* | is_object_decoding_allowed() | ++----------+----------------------------------+ + +If ``true`` (or if the :ref:`network_peer` :ref:`PacketPeer.allow_object_decoding` the MultiplayerAPI will allow encoding and decoding of object during RPCs/RSETs. + +**WARNING:** Deserialized object can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats (remote code execution). + .. _class_MultiplayerAPI_property_network_peer: - :ref:`NetworkedMultiplayerPeer` **network_peer** diff --git a/classes/class_networkedmultiplayerenet.rst b/classes/class_networkedmultiplayerenet.rst index 7f01487e9..57161ec96 100644 --- a/classes/class_networkedmultiplayerenet.rst +++ b/classes/class_networkedmultiplayerenet.rst @@ -167,7 +167,7 @@ Create server that listens to connections via ``port``. The port needs to be an - void **disconnect_peer** **(** :ref:`int` id, :ref:`bool` now=false **)** -Disconnect the given peer. If "now" is set to true, the connection will be closed immediately without flushing queued messages. +Disconnect the given peer. If "now" is set to ``true``, the connection will be closed immediately without flushing queued messages. .. _class_NetworkedMultiplayerENet_method_get_last_packet_channel: diff --git a/classes/class_node.rst b/classes/class_node.rst index d3582f416..8b6a89111 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -309,12 +309,34 @@ Constants .. _class_Node_constant_NOTIFICATION_PATH_CHANGED: -.. _class_Node_constant_NOTIFICATION_TRANSLATION_CHANGED: - .. _class_Node_constant_NOTIFICATION_INTERNAL_PROCESS: .. _class_Node_constant_NOTIFICATION_INTERNAL_PHYSICS_PROCESS: +.. _class_Node_constant_NOTIFICATION_WM_MOUSE_ENTER: + +.. _class_Node_constant_NOTIFICATION_WM_MOUSE_EXIT: + +.. _class_Node_constant_NOTIFICATION_WM_FOCUS_IN: + +.. _class_Node_constant_NOTIFICATION_WM_FOCUS_OUT: + +.. _class_Node_constant_NOTIFICATION_WM_QUIT_REQUEST: + +.. _class_Node_constant_NOTIFICATION_WM_GO_BACK_REQUEST: + +.. _class_Node_constant_NOTIFICATION_WM_UNFOCUS_REQUEST: + +.. _class_Node_constant_NOTIFICATION_OS_MEMORY_WARNING: + +.. _class_Node_constant_NOTIFICATION_TRANSLATION_CHANGED: + +.. _class_Node_constant_NOTIFICATION_WM_ABOUT: + +.. _class_Node_constant_NOTIFICATION_CRASH: + +.. _class_Node_constant_NOTIFICATION_OS_IME_UPDATE: + - **NOTIFICATION_ENTER_TREE** = **10** --- Notification received when the node enters a :ref:`SceneTree`. - **NOTIFICATION_EXIT_TREE** = **11** --- Notification received when the node is about to exit a :ref:`SceneTree`. @@ -343,12 +365,34 @@ Constants - **NOTIFICATION_PATH_CHANGED** = **23** --- Notification received when the node's :ref:`NodePath` changed. -- **NOTIFICATION_TRANSLATION_CHANGED** = **24** --- Notification received when translations may have changed. Can be triggered by the user changing the locale. Can be used to respond to language changes, for example to change the UI strings on the fly. Useful when working with the built-in translation support, like :ref:`Object.tr`. - - **NOTIFICATION_INTERNAL_PROCESS** = **25** --- Notification received every frame when the internal process flag is set (see :ref:`set_process_internal`). - **NOTIFICATION_INTERNAL_PHYSICS_PROCESS** = **26** --- Notification received every frame when the internal physics process flag is set (see :ref:`set_physics_process_internal`). +- **NOTIFICATION_WM_MOUSE_ENTER** = **1002** + +- **NOTIFICATION_WM_MOUSE_EXIT** = **1003** + +- **NOTIFICATION_WM_FOCUS_IN** = **1004** + +- **NOTIFICATION_WM_FOCUS_OUT** = **1005** + +- **NOTIFICATION_WM_QUIT_REQUEST** = **1006** + +- **NOTIFICATION_WM_GO_BACK_REQUEST** = **1007** + +- **NOTIFICATION_WM_UNFOCUS_REQUEST** = **1008** + +- **NOTIFICATION_OS_MEMORY_WARNING** = **1009** + +- **NOTIFICATION_TRANSLATION_CHANGED** = **1010** --- Notification received when translations may have changed. Can be triggered by the user changing the locale. Can be used to respond to language changes, for example to change the UI strings on the fly. Useful when working with the built-in translation support, like :ref:`Object.tr`. + +- **NOTIFICATION_WM_ABOUT** = **1011** + +- **NOTIFICATION_CRASH** = **1012** + +- **NOTIFICATION_OS_IME_UPDATE** = **1013** + Description ----------- @@ -475,6 +519,10 @@ Corresponds to the NOTIFICATION_EXIT_TREE notification in :ref:`Object._notifica - :ref:`String` **_get_configuration_warning** **(** **)** virtual +The string returned from this method is displayed as a warning in the "Scene Dock" if the script that overrides it is a ``tool`` script. + +Returning an empty string produces no warning. + .. _class_Node_method__input: - void **_input** **(** :ref:`InputEvent` event **)** virtual @@ -563,6 +611,8 @@ Setting "legible_unique_name" ``true`` creates child nodes with human-readable n Adds the node to a group. Groups are helpers to name and organize a subset of nodes, for example "enemies" or "collectables". A node can be in any number of groups. Nodes can be assigned a group at any time, but will not be added until they are inside the scene tree (see :ref:`is_inside_tree`). See notes in the description, and the group methods in :ref:`SceneTree`. +``persistent`` option is used when packing node to :ref:`PackedScene` and saving to file. Non-persistent groups aren't stored. + .. _class_Node_method_can_process: - :ref:`bool` **can_process** **(** **)** const diff --git a/classes/class_node2d.rst b/classes/class_node2d.rst index 59a542c34..8a28276c7 100644 --- a/classes/class_node2d.rst +++ b/classes/class_node2d.rst @@ -268,13 +268,13 @@ Rotates the node so it points towards the 'point'. - void **move_local_x** **(** :ref:`float` delta, :ref:`bool` scaled=false **)** -Applies a local translation on the node's X axis based on the :ref:`Node._process`'s ``delta``. If ``scaled`` is false, normalizes the movement. +Applies a local translation on the node's X axis based on the :ref:`Node._process`'s ``delta``. If ``scaled`` is ``false``, normalizes the movement. .. _class_Node2D_method_move_local_y: - void **move_local_y** **(** :ref:`float` delta, :ref:`bool` scaled=false **)** -Applies a local translation on the node's Y axis based on the :ref:`Node._process`'s ``delta``. If ``scaled`` is false, normalizes the movement. +Applies a local translation on the node's Y axis based on the :ref:`Node._process`'s ``delta``. If ``scaled`` is ``false``, normalizes the movement. .. _class_Node2D_method_rotate: diff --git a/classes/class_nodepath.rst b/classes/class_nodepath.rst index 0f06fa75b..f289ff95e 100644 --- a/classes/class_nodepath.rst +++ b/classes/class_nodepath.rst @@ -91,11 +91,11 @@ Get the number of resource names in the path. - :ref:`bool` **is_absolute** **(** **)** -Return true if the node path is absolute (not relative). +Return ``true`` if the node path is absolute (not relative). .. _class_NodePath_method_is_empty: - :ref:`bool` **is_empty** **(** **)** -Return true if the node path is empty. +Return ``true`` if the node path is empty. diff --git a/classes/class_noisetexture.rst b/classes/class_noisetexture.rst index 9668b71b9..fbb46ad50 100644 --- a/classes/class_noisetexture.rst +++ b/classes/class_noisetexture.rst @@ -53,7 +53,7 @@ Property Descriptions | *Getter* | is_normalmap() | +----------+-------------------------+ -If true, the resulting texture contains a normal map created from the original noise interpreted as a bump map. +If ``true``, the resulting texture contains a normal map created from the original noise interpreted as a bump map. .. _class_NoiseTexture_property_bump_strength: diff --git a/classes/class_object.rst b/classes/class_object.rst index ea13a8bc9..effb8c1c9 100644 --- a/classes/class_object.rst +++ b/classes/class_object.rst @@ -396,7 +396,7 @@ Set property into the object. - void **set_block_signals** **(** :ref:`bool` enable **)** -If set to true, signal emission is blocked. +If set to ``true``, signal emission is blocked. .. _class_Object_method_set_deferred: @@ -410,7 +410,7 @@ If set to true, signal emission is blocked. - void **set_message_translation** **(** :ref:`bool` enable **)** -Define whether the object can translate strings (with calls to :ref:`tr`). Default is true. +Define whether the object can translate strings (with calls to :ref:`tr`). Default is ``true``. .. _class_Object_method_set_meta: diff --git a/classes/class_opensimplexnoise.rst b/classes/class_opensimplexnoise.rst index 39ecb0afd..73b6bdda1 100644 --- a/classes/class_opensimplexnoise.rst +++ b/classes/class_opensimplexnoise.rst @@ -37,6 +37,8 @@ Methods +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Image` | :ref:`get_image` **(** :ref:`int` width, :ref:`int` height **)** | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_noise_1d` **(** :ref:`float` x **)** | ++---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_noise_2d` **(** :ref:`float` x, :ref:`float` y **)** | +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_noise_2dv` **(** :ref:`Vector2` pos **)** | @@ -143,6 +145,10 @@ Method Descriptions Generate a noise image with the requested ``width`` and ``height``, based on the current noise parameters. +.. _class_OpenSimplexNoise_method_get_noise_1d: + +- :ref:`float` **get_noise_1d** **(** :ref:`float` x **)** + .. _class_OpenSimplexNoise_method_get_noise_2d: - :ref:`float` **get_noise_2d** **(** :ref:`float` x, :ref:`float` y **)** diff --git a/classes/class_os.rst b/classes/class_os.rst index f7e9a772d..701a00111 100644 --- a/classes/class_os.rst +++ b/classes/class_os.rst @@ -19,37 +19,37 @@ Operating System functions. Properties ---------- -+-------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`clipboard` | -+-------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`current_screen` | -+-------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`exit_code` | -+-------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`keep_screen_on` | -+-------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`low_processor_usage_mode` | -+-------------------------------+-------------------------------------------------------------------------------------------------------+ -| _OS.ScreenOrientation | :ref:`screen_orientation` | -+-------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`vsync_enabled` | -+-------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`window_borderless` | -+-------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`window_fullscreen` | -+-------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`window_maximized` | -+-------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`window_minimized` | -+-------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`window_per_pixel_transparency_enabled` | -+-------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`window_position` | -+-------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`window_resizable` | -+-------------------------------+-------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`window_size` | -+-------------------------------+-------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`clipboard` | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`current_screen` | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`exit_code` | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`keep_screen_on` | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`low_processor_usage_mode` | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`ScreenOrientation` | :ref:`screen_orientation` | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`vsync_enabled` | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`window_borderless` | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`window_fullscreen` | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`window_maximized` | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`window_minimized` | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`window_per_pixel_transparency_enabled` | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`window_position` | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`window_resizable` | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`window_size` | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------+ Methods ------- @@ -499,7 +499,7 @@ If ``true``, the engine optimizes for low processor usage by only refreshing the .. _class_OS_property_screen_orientation: -- _OS.ScreenOrientation **screen_orientation** +- :ref:`ScreenOrientation` **screen_orientation** +----------+-------------------------------+ | *Setter* | set_screen_orientation(value) | diff --git a/classes/class_packetpeer.rst b/classes/class_packetpeer.rst index ba076acfe..928c7a530 100644 --- a/classes/class_packetpeer.rst +++ b/classes/class_packetpeer.rst @@ -9,7 +9,7 @@ PacketPeer **Inherits:** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`NetworkedMultiplayerPeer`, :ref:`PacketPeerGDNative`, :ref:`PacketPeerStream`, :ref:`PacketPeerUDP`, :ref:`WebSocketPeer` +**Inherited By:** :ref:`NetworkedMultiplayerPeer`, :ref:`PacketPeerGDNative`, :ref:`PacketPeerStream`, :ref:`PacketPeerUDP`, :ref:`WebRTCPeer`, :ref:`WebSocketPeer` **Category:** Core @@ -28,19 +28,19 @@ Properties Methods ------- -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_available_packet_count` **(** **)** const | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`get_packet` **(** **)** | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`get_packet_error` **(** **)** const | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_var` **(** **)** | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`put_packet` **(** :ref:`PoolByteArray` buffer **)** | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`put_var` **(** :ref:`Variant` var **)** | -+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_available_packet_count` **(** **)** const | ++-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`get_packet` **(** **)** | ++-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`get_packet_error` **(** **)** const | ++-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_var` **(** :ref:`bool` allow_objects=false **)** | ++-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`put_packet` **(** :ref:`PoolByteArray` buffer **)** | ++-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`put_var` **(** :ref:`Variant` var, :ref:`bool` full_objects=false **)** | ++-------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -60,6 +60,12 @@ Property Descriptions | *Getter* | is_object_decoding_allowed() | +----------+----------------------------------+ +Deprecated. Use ``get_var`` and ``put_var`` parameters instead. + +If ``true`` the PacketPeer will allow encoding and decoding of object via :ref:`get_var` and :ref:`put_var`. + +**WARNING:** Deserialized object can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats (remote code execution). + Method Descriptions ------------------- @@ -83,9 +89,11 @@ Return the error state of the last packet received (via :ref:`get_packet` **get_var** **(** **)** +- :ref:`Variant` **get_var** **(** :ref:`bool` allow_objects=false **)** -Get a Variant. +Get a Variant. When ``allow_objects`` (or :ref:`allow_object_decoding`) is ``true`` decoding objects is allowed. + +**WARNING:** Deserialized object can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats (remote code execution). .. _class_PacketPeer_method_put_packet: @@ -95,7 +103,7 @@ Send a raw packet. .. _class_PacketPeer_method_put_var: -- :ref:`Error` **put_var** **(** :ref:`Variant` var **)** +- :ref:`Error` **put_var** **(** :ref:`Variant` var, :ref:`bool` full_objects=false **)** -Send a Variant as a packet. +Send a Variant as a packet. When ``full_objects`` (or :ref:`allow_object_decoding`) is ``true`` encoding objects is allowed (and can potentially include code). diff --git a/classes/class_performance.rst b/classes/class_performance.rst index 81d2558e3..952678d63 100644 --- a/classes/class_performance.rst +++ b/classes/class_performance.rst @@ -50,6 +50,8 @@ Enumerations .. _class_Performance_constant_OBJECT_NODE_COUNT: +.. _class_Performance_constant_OBJECT_ORPHAN_NODE_COUNT: + .. _class_Performance_constant_RENDER_OBJECTS_IN_FRAME: .. _class_Performance_constant_RENDER_VERTICES_IN_FRAME: @@ -108,43 +110,45 @@ enum **Monitor**: - **OBJECT_RESOURCE_COUNT** = **9** --- Number of resources currently used. -- **OBJECT_NODE_COUNT** = **10** --- Number of nodes currently instanced. This also includes the root node, as well as any nodes not in the scene tree. +- **OBJECT_NODE_COUNT** = **10** --- Number of nodes currently instanced in the scene tree. This also includes the root node. -- **RENDER_OBJECTS_IN_FRAME** = **11** --- 3D objects drawn per frame. +- **OBJECT_ORPHAN_NODE_COUNT** = **11** -- **RENDER_VERTICES_IN_FRAME** = **12** --- Vertices drawn per frame. 3D only. +- **RENDER_OBJECTS_IN_FRAME** = **12** --- 3D objects drawn per frame. -- **RENDER_MATERIAL_CHANGES_IN_FRAME** = **13** --- Material changes per frame. 3D only +- **RENDER_VERTICES_IN_FRAME** = **13** --- Vertices drawn per frame. 3D only. -- **RENDER_SHADER_CHANGES_IN_FRAME** = **14** --- Shader changes per frame. 3D only. +- **RENDER_MATERIAL_CHANGES_IN_FRAME** = **14** --- Material changes per frame. 3D only -- **RENDER_SURFACE_CHANGES_IN_FRAME** = **15** --- Render surface changes per frame. 3D only. +- **RENDER_SHADER_CHANGES_IN_FRAME** = **15** --- Shader changes per frame. 3D only. -- **RENDER_DRAW_CALLS_IN_FRAME** = **16** --- Draw calls per frame. 3D only. +- **RENDER_SURFACE_CHANGES_IN_FRAME** = **16** --- Render surface changes per frame. 3D only. -- **RENDER_VIDEO_MEM_USED** = **17** --- Video memory used. Includes both texture and vertex memory. +- **RENDER_DRAW_CALLS_IN_FRAME** = **17** --- Draw calls per frame. 3D only. -- **RENDER_TEXTURE_MEM_USED** = **18** --- Texture memory used. +- **RENDER_VIDEO_MEM_USED** = **18** --- Video memory used. Includes both texture and vertex memory. -- **RENDER_VERTEX_MEM_USED** = **19** --- Vertex memory used. +- **RENDER_TEXTURE_MEM_USED** = **19** --- Texture memory used. -- **RENDER_USAGE_VIDEO_MEM_TOTAL** = **20** +- **RENDER_VERTEX_MEM_USED** = **20** --- Vertex memory used. -- **PHYSICS_2D_ACTIVE_OBJECTS** = **21** --- Number of active :ref:`RigidBody2D` nodes in the game. +- **RENDER_USAGE_VIDEO_MEM_TOTAL** = **21** -- **PHYSICS_2D_COLLISION_PAIRS** = **22** --- Number of collision pairs in the 2D physics engine. +- **PHYSICS_2D_ACTIVE_OBJECTS** = **22** --- Number of active :ref:`RigidBody2D` nodes in the game. -- **PHYSICS_2D_ISLAND_COUNT** = **23** --- Number of islands in the 2D physics engine. +- **PHYSICS_2D_COLLISION_PAIRS** = **23** --- Number of collision pairs in the 2D physics engine. -- **PHYSICS_3D_ACTIVE_OBJECTS** = **24** --- Number of active :ref:`RigidBody` and :ref:`VehicleBody` nodes in the game. +- **PHYSICS_2D_ISLAND_COUNT** = **24** --- Number of islands in the 2D physics engine. -- **PHYSICS_3D_COLLISION_PAIRS** = **25** --- Number of collision pairs in the 3D physics engine. +- **PHYSICS_3D_ACTIVE_OBJECTS** = **25** --- Number of active :ref:`RigidBody` and :ref:`VehicleBody` nodes in the game. -- **PHYSICS_3D_ISLAND_COUNT** = **26** --- Number of islands in the 3D physics engine. +- **PHYSICS_3D_COLLISION_PAIRS** = **26** --- Number of collision pairs in the 3D physics engine. -- **AUDIO_OUTPUT_LATENCY** = **27** +- **PHYSICS_3D_ISLAND_COUNT** = **27** --- Number of islands in the 3D physics engine. -- **MONITOR_MAX** = **28** +- **AUDIO_OUTPUT_LATENCY** = **28** + +- **MONITOR_MAX** = **29** Description ----------- diff --git a/classes/class_physicsserver.rst b/classes/class_physicsserver.rst index 469c02c3b..8f9a9be31 100644 --- a/classes/class_physicsserver.rst +++ b/classes/class_physicsserver.rst @@ -598,7 +598,7 @@ enum **ShapeType**: - **SHAPE_CONCAVE_POLYGON** = **7** --- The :ref:`Shape` is a :ref:`ConcavePolygonShape`. -- **SHAPE_HEIGHTMAP** = **8** --- The :ref:`Shape` is a HeightMapShape. +- **SHAPE_HEIGHTMAP** = **8** --- The :ref:`Shape` is a :ref:`HeightMapShape`. - **SHAPE_CUSTOM** = **9** --- This constant is used internally by the engine. Any attempt to create this kind of shape results in an error. diff --git a/classes/class_plane.rst b/classes/class_plane.rst index 2af2d8d47..106c580e7 100644 --- a/classes/class_plane.rst +++ b/classes/class_plane.rst @@ -147,7 +147,7 @@ Returns a point on the plane. - :ref:`bool` **has_point** **(** :ref:`Vector3` point, :ref:`float` epsilon=0.00001 **)** -Returns true if "point" is inside the plane (by a very minimum threshold). +Returns ``true`` if "point" is inside the plane (by a very minimum threshold). .. _class_Plane_method_intersect_3: @@ -171,7 +171,7 @@ Returns the intersection point of a segment from position "begin" to position "e - :ref:`bool` **is_point_over** **(** :ref:`Vector3` point **)** -Returns true if "point" is located above the plane. +Returns ``true`` if "point" is located above the plane. .. _class_Plane_method_normalized: diff --git a/classes/class_poolbytearray.rst b/classes/class_poolbytearray.rst index be44d78f6..eb9aba510 100644 --- a/classes/class_poolbytearray.rst +++ b/classes/class_poolbytearray.rst @@ -44,6 +44,8 @@ Methods +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set` **(** :ref:`int` idx, :ref:`int` byte **)** | +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`sha256_string` **(** **)** | ++-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`size` **(** **)** | +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolByteArray` | :ref:`subarray` **(** :ref:`int` from, :ref:`int` to **)** | @@ -135,6 +137,12 @@ Set the size of the array. If the array is grown reserve elements at the end of Change the byte at the given index. +.. _class_PoolByteArray_method_sha256_string: + +- :ref:`String` **sha256_string** **(** **)** + +Return SHA256 string of the PoolByteArray. + .. _class_PoolByteArray_method_size: - :ref:`int` **size** **(** **)** diff --git a/classes/class_projectsettings.rst b/classes/class_projectsettings.rst index 22a88a3e2..5a9a7e0da 100644 --- a/classes/class_projectsettings.rst +++ b/classes/class_projectsettings.rst @@ -54,6 +54,8 @@ Properties +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`audio/channel_disable_time` | +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`audio/default_bus_layout` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`audio/driver` | +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`audio/enable_audio_input` | @@ -100,6 +102,8 @@ Properties +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`debug/gdscript/warnings/return_value_discarded` | +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/shadowed_variable` | ++-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`debug/gdscript/warnings/standalone_expression` | +-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`debug/gdscript/warnings/treat_warnings_as_errors` | @@ -690,6 +694,10 @@ Audio buses will disable automatically when sound goes below a given DB threshol Audio buses will disable automatically when sound goes below a given DB threshold for a given time. This saves CPU as effects assigned to that bus will no longer do any processing. +.. _class_ProjectSettings_property_audio/default_bus_layout: + +- :ref:`String` **audio/default_bus_layout** + .. _class_ProjectSettings_property_audio/driver: - :ref:`String` **audio/driver** @@ -796,6 +804,10 @@ Enable long distance matching in zstd. - :ref:`bool` **debug/gdscript/warnings/return_value_discarded** +.. _class_ProjectSettings_property_debug/gdscript/warnings/shadowed_variable: + +- :ref:`bool` **debug/gdscript/warnings/shadowed_variable** + .. _class_ProjectSettings_property_debug/gdscript/warnings/standalone_expression: - :ref:`bool` **debug/gdscript/warnings/standalone_expression** @@ -1894,13 +1906,13 @@ Convert a localized path (res://) to a full native OS path. - :ref:`bool` **has_setting** **(** :ref:`String` name **)** const -Return true if a configuration value is present. +Return ``true`` if a configuration value is present. .. _class_ProjectSettings_method_load_resource_pack: - :ref:`bool` **load_resource_pack** **(** :ref:`String` pack **)** -Loads the contents of the .pck or .zip file specified by ``pack`` into the resource filesystem (res://). Returns true on success. +Loads the contents of the .pck or .zip file specified by ``pack`` into the resource filesystem (res://). Returns ``true`` on success. Note: If a file from ``pack`` shares the same path as a file already in the resource filesystem, any attempts to load that file will use the file from ``pack``. @@ -1914,7 +1926,7 @@ Convert a path to a localized path (res:// path). - :ref:`bool` **property_can_revert** **(** :ref:`String` name **)** -Returns true if the specified property exists and its initial value differs from the current value. +Returns ``true`` if the specified property exists and its initial value differs from the current value. .. _class_ProjectSettings_method_property_get_revert: diff --git a/classes/class_randomnumbergenerator.rst b/classes/class_randomnumbergenerator.rst index 762498a38..816eead0c 100644 --- a/classes/class_randomnumbergenerator.rst +++ b/classes/class_randomnumbergenerator.rst @@ -14,7 +14,7 @@ RandomNumberGenerator Brief Description ----------------- -A class for generation pseudo-random numbers. +A class for generating pseudo-random numbers. Properties ---------- @@ -26,17 +26,24 @@ Properties Methods ------- -+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`randf` **(** **)** | -+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`randf_range` **(** :ref:`float` from, :ref:`float` to **)** | -+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`randi` **(** **)** | -+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`randi_range` **(** :ref:`int` from, :ref:`int` to **)** | -+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`randomize` **(** **)** | -+---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`randf` **(** **)** | ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`randf_range` **(** :ref:`float` from, :ref:`float` to **)** | ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`randfn` **(** :ref:`float` mean=0.0, :ref:`float` deviation=1.0 **)** | ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`randi` **(** **)** | ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`randi_range` **(** :ref:`int` from, :ref:`int` to **)** | ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`randomize` **(** **)** | ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ + +Description +----------- + +RandomNumberGenerator is a class for generating pseudo-random numbers. It currently uses PCG32. The underlying algorithm is an implementation detail. As a result, it should not be depended upon for reproducible random streams across Godot versions. Property Descriptions --------------------- @@ -53,6 +60,8 @@ Property Descriptions The seed used by the random number generator. A given seed will give a reproducible sequence of pseudo-random numbers. +**Note:** The RNG does not have an avalanche effect, and can output similar random streams given similar seeds. Consider using a hash function to improve your seed quality if they're sourced externally. + Method Descriptions ------------------- @@ -60,19 +69,25 @@ Method Descriptions - :ref:`float` **randf** **(** **)** -Generates pseudo-random float between '0.0' and '1.0'. +Generates pseudo-random float between '0.0' and '1.0', inclusive. .. _class_RandomNumberGenerator_method_randf_range: - :ref:`float` **randf_range** **(** :ref:`float` from, :ref:`float` to **)** -Generates pseudo-random float between ``from`` and ``to``. +Generates pseudo-random float between ``from`` and ``to``, inclusive. + +.. _class_RandomNumberGenerator_method_randfn: + +- :ref:`float` **randfn** **(** :ref:`float` mean=0.0, :ref:`float` deviation=1.0 **)** + +Generates normally(gaussian) distributed pseudo-random number, using Box-Muller transform with the specified ``mean`` and a standard ``deviation``. .. _class_RandomNumberGenerator_method_randi: - :ref:`int` **randi** **(** **)** -Generates pseudo-random 32-bit unsigned integer between '0' and '4294967295'. +Generates pseudo-random 32-bit unsigned integer between '0' and '4294967295', inclusive. .. _class_RandomNumberGenerator_method_randi_range: diff --git a/classes/class_reference.rst b/classes/class_reference.rst index 205e6050c..29af28036 100644 --- a/classes/class_reference.rst +++ b/classes/class_reference.rst @@ -9,7 +9,7 @@ Reference **Inherits:** :ref:`Object` -**Inherited By:** :ref:`ARVRInterface`, :ref:`AStar`, :ref:`AnimationTrackEditPlugin`, :ref:`AudioStreamPlayback`, :ref:`ConfigFile`, :ref:`Directory`, :ref:`EditorExportPlugin`, :ref:`EditorImportPlugin`, :ref:`EditorInspectorPlugin`, :ref:`EditorResourceConversionPlugin`, :ref:`EditorResourcePreviewGenerator`, :ref:`EditorSceneImporter`, :ref:`EditorScenePostImport`, :ref:`EditorScript`, :ref:`EncodedObjectAsID`, :ref:`Expression`, :ref:`File`, :ref:`FuncRef`, :ref:`GDNative`, :ref:`GDScriptFunctionState`, :ref:`GDScriptNativeClass`, :ref:`HTTPClient`, :ref:`JSONParseResult`, :ref:`KinematicCollision`, :ref:`KinematicCollision2D`, :ref:`Marshalls`, :ref:`MeshDataTool`, :ref:`MultiplayerAPI`, :ref:`Mutex`, :ref:`PCKPacker`, :ref:`PackedDataContainerRef`, :ref:`PacketPeer`, :ref:`Physics2DShapeQueryParameters`, :ref:`Physics2DShapeQueryResult`, :ref:`Physics2DTestMotionResult`, :ref:`PhysicsShapeQueryParameters`, :ref:`PhysicsShapeQueryResult`, :ref:`RandomNumberGenerator`, :ref:`RegEx`, :ref:`RegExMatch`, :ref:`Resource`, :ref:`ResourceFormatLoader`, :ref:`ResourceFormatSaver`, :ref:`ResourceImporter`, :ref:`ResourceInteractiveLoader`, :ref:`SceneState`, :ref:`SceneTreeTimer`, :ref:`Semaphore`, :ref:`SpatialGizmo`, :ref:`SpatialVelocityTracker`, :ref:`StreamPeer`, :ref:`SurfaceTool`, :ref:`TCP_Server`, :ref:`Thread`, :ref:`TriangleMesh`, :ref:`UPNP`, :ref:`UPNPDevice`, :ref:`VisualScriptFunctionState`, :ref:`WeakRef`, :ref:`XMLParser` +**Inherited By:** :ref:`ARVRInterface`, :ref:`AStar`, :ref:`AnimationTrackEditPlugin`, :ref:`AudioEffectInstance`, :ref:`AudioStreamPlayback`, :ref:`ConfigFile`, :ref:`Directory`, :ref:`EditorExportPlugin`, :ref:`EditorFeatureProfile`, :ref:`EditorImportPlugin`, :ref:`EditorInspectorPlugin`, :ref:`EditorResourceConversionPlugin`, :ref:`EditorResourcePreviewGenerator`, :ref:`EditorSceneImporter`, :ref:`EditorScenePostImport`, :ref:`EditorScript`, :ref:`EncodedObjectAsID`, :ref:`Expression`, :ref:`File`, :ref:`FuncRef`, :ref:`GDNative`, :ref:`GDScriptFunctionState`, :ref:`GDScriptNativeClass`, :ref:`HTTPClient`, :ref:`JSONParseResult`, :ref:`KinematicCollision`, :ref:`KinematicCollision2D`, :ref:`Marshalls`, :ref:`MeshDataTool`, :ref:`MultiplayerAPI`, :ref:`Mutex`, :ref:`PCKPacker`, :ref:`PackedDataContainerRef`, :ref:`PacketPeer`, :ref:`Physics2DShapeQueryParameters`, :ref:`Physics2DShapeQueryResult`, :ref:`Physics2DTestMotionResult`, :ref:`PhysicsShapeQueryParameters`, :ref:`PhysicsShapeQueryResult`, :ref:`RandomNumberGenerator`, :ref:`RegEx`, :ref:`RegExMatch`, :ref:`Resource`, :ref:`ResourceFormatLoader`, :ref:`ResourceFormatSaver`, :ref:`ResourceImporter`, :ref:`ResourceInteractiveLoader`, :ref:`SceneState`, :ref:`SceneTreeTimer`, :ref:`Semaphore`, :ref:`SpatialGizmo`, :ref:`SpatialVelocityTracker`, :ref:`StreamPeer`, :ref:`SurfaceTool`, :ref:`TCP_Server`, :ref:`Thread`, :ref:`TriangleMesh`, :ref:`UPNP`, :ref:`UPNPDevice`, :ref:`VisualScriptFunctionState`, :ref:`WeakRef`, :ref:`XMLParser` **Category:** Core diff --git a/classes/class_resourceformatsaver.rst b/classes/class_resourceformatsaver.rst index 2a24dc0fb..d75364224 100644 --- a/classes/class_resourceformatsaver.rst +++ b/classes/class_resourceformatsaver.rst @@ -49,7 +49,7 @@ Gets the list of extensions for files this saver is able to write. - :ref:`bool` **recognize** **(** :ref:`Resource` resource **)** virtual -Returns true if the given resource object can be saved by this saver. +Returns ``true`` if the given resource object can be saved by this saver. .. _class_ResourceFormatSaver_method_save: diff --git a/classes/class_resourcepreloader.rst b/classes/class_resourcepreloader.rst index fd064d740..80f5593da 100644 --- a/classes/class_resourcepreloader.rst +++ b/classes/class_resourcepreloader.rst @@ -63,7 +63,7 @@ Returns the list of resources inside the preloader. - :ref:`bool` **has_resource** **(** :ref:`String` name **)** const -Returns true if the preloader contains a resource associated to ``name``. +Returns ``true`` if the preloader contains a resource associated to ``name``. .. _class_ResourcePreloader_method_remove_resource: diff --git a/classes/class_resourcesaver.rst b/classes/class_resourcesaver.rst index 247a1fd2d..3dfffff44 100644 --- a/classes/class_resourcesaver.rst +++ b/classes/class_resourcesaver.rst @@ -19,11 +19,11 @@ Resource saving interface. Methods ------- -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_recognized_extensions` **(** :ref:`Resource` type **)** | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`save` **(** :ref:`String` path, :ref:`Resource` resource, :ref:`int` flags=0 **)** | -+-----------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_recognized_extensions` **(** :ref:`Resource` type **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`save` **(** :ref:`String` path, :ref:`Resource` resource, :ref:`SaverFlags` flags=0 **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ @@ -76,7 +76,7 @@ Returns the list of extensions available for saving a resource of a given type. .. _class_ResourceSaver_method_save: -- :ref:`Error` **save** **(** :ref:`String` path, :ref:`Resource` resource, :ref:`int` flags=0 **)** +- :ref:`Error` **save** **(** :ref:`String` path, :ref:`Resource` resource, :ref:`SaverFlags` flags=0 **)** Saves a resource to disk. diff --git a/classes/class_scenetree.rst b/classes/class_scenetree.rst index 321ec76d5..2bf5678b7 100644 --- a/classes/class_scenetree.rst +++ b/classes/class_scenetree.rst @@ -426,7 +426,7 @@ Changes to the given :ref:`PackedScene`. - :ref:`SceneTreeTimer` **create_timer** **(** :ref:`float` time_sec, :ref:`bool` pause_mode_process=true **)** -Returns a :ref:`SceneTreeTimer` which will :ref:`SceneTreeTimer.timeout` after the given time in seconds elapsed in this SceneTree. If ``pause_mode_process`` is set to false, pausing the SceneTree will also pause the timer. +Returns a :ref:`SceneTreeTimer` which will :ref:`SceneTreeTimer.timeout` after the given time in seconds elapsed in this SceneTree. If ``pause_mode_process`` is set to ``false``, pausing the SceneTree will also pause the timer. Commonly used to create a one-shot delay timer as in the following example: @@ -441,6 +441,8 @@ Commonly used to create a one-shot delay timer as in the following example: - :ref:`int` **get_frame** **(** **)** const +Returns the current frame, i.e. number of frames since the application started. + .. _class_SceneTree_method_get_network_connected_peers: - :ref:`PoolIntArray` **get_network_connected_peers** **(** **)** const diff --git a/classes/class_shape.rst b/classes/class_shape.rst index 40af9c1fd..9802b77a4 100644 --- a/classes/class_shape.rst +++ b/classes/class_shape.rst @@ -9,7 +9,7 @@ Shape **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`BoxShape`, :ref:`CapsuleShape`, :ref:`ConcavePolygonShape`, :ref:`ConvexPolygonShape`, :ref:`CylinderShape`, :ref:`PlaneShape`, :ref:`RayShape`, :ref:`SphereShape` +**Inherited By:** :ref:`BoxShape`, :ref:`CapsuleShape`, :ref:`ConcavePolygonShape`, :ref:`ConvexPolygonShape`, :ref:`CylinderShape`, :ref:`HeightMapShape`, :ref:`PlaneShape`, :ref:`RayShape`, :ref:`SphereShape` **Category:** Core diff --git a/classes/class_skeleton.rst b/classes/class_skeleton.rst index eb354c119..e03796409 100644 --- a/classes/class_skeleton.rst +++ b/classes/class_skeleton.rst @@ -55,6 +55,8 @@ Methods +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_bone_rest_disabled` **(** :ref:`int` bone_idx **)** const | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`localize_rests` **(** **)** | ++-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`physical_bones_add_collision_exception` **(** :ref:`RID` exception **)** | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`physical_bones_remove_collision_exception` **(** :ref:`RID` exception **)** | @@ -196,6 +198,10 @@ Deprecated soon. - :ref:`bool` **is_bone_rest_disabled** **(** :ref:`int` bone_idx **)** const +.. _class_Skeleton_method_localize_rests: + +- void **localize_rests** **(** **)** + .. _class_Skeleton_method_physical_bones_add_collision_exception: - void **physical_bones_add_collision_exception** **(** :ref:`RID` exception **)** diff --git a/classes/class_slider.rst b/classes/class_slider.rst index 71f7ba8f8..e4a72a54a 100644 --- a/classes/class_slider.rst +++ b/classes/class_slider.rst @@ -51,6 +51,8 @@ Property Descriptions | *Getter* | is_editable() | +----------+---------------------+ +If ``true``, the slider can be interacted with. If ``false``, the value can be changed only by code. + .. _class_Slider_property_focus_mode: - :ref:`FocusMode` **focus_mode** @@ -71,6 +73,8 @@ Property Descriptions | *Getter* | is_scrollable() | +----------+-----------------------+ +If ``true``, the value can be changed using the mouse wheel. + .. _class_Slider_property_tick_count: - :ref:`int` **tick_count** @@ -81,6 +85,8 @@ Property Descriptions | *Getter* | get_ticks() | +----------+------------------+ +Number of ticks displayed on the slider, including border ticks. Ticks are uniformly-distributed value markers. + .. _class_Slider_property_ticks_on_borders: - :ref:`bool` **ticks_on_borders** @@ -91,3 +97,5 @@ Property Descriptions | *Getter* | get_ticks_on_borders() | +----------+-----------------------------+ +If ``true``, the slider will display ticks for minimum and maximum values. + diff --git a/classes/class_spatial.rst b/classes/class_spatial.rst index beafb4acb..f4d90676b 100644 --- a/classes/class_spatial.rst +++ b/classes/class_spatial.rst @@ -130,7 +130,7 @@ Constants .. _class_Spatial_constant_NOTIFICATION_VISIBILITY_CHANGED: -- **NOTIFICATION_TRANSFORM_CHANGED** = **29** --- Spatial nodes receives this notification when their global transform changes. This means that either the current or a parent node changed its transform. +- **NOTIFICATION_TRANSFORM_CHANGED** = **2000** --- Spatial nodes receives this notification when their global transform changes. This means that either the current or a parent node changed its transform. In order for ``NOTIFICATION_TRANSFORM_CHANGED`` to work, users first need to ask for it, with :ref:`set_notify_transform`. diff --git a/classes/class_spheremesh.rst b/classes/class_spheremesh.rst index 36286807c..88850d2cc 100644 --- a/classes/class_spheremesh.rst +++ b/classes/class_spheremesh.rst @@ -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: diff --git a/classes/class_streampeer.rst b/classes/class_streampeer.rst index b9036553d..9cf9326f4 100644 --- a/classes/class_streampeer.rst +++ b/classes/class_streampeer.rst @@ -28,69 +28,69 @@ Properties Methods ------- -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_16` **(** **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_32` **(** **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_64` **(** **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_8` **(** **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_available_bytes` **(** **)** const | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_data` **(** :ref:`int` bytes **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_double` **(** **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_float` **(** **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_partial_data` **(** :ref:`int` bytes **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_string` **(** :ref:`int` bytes=-1 **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_u16` **(** **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_u32` **(** **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_u64` **(** **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_u8` **(** **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_utf8_string` **(** :ref:`int` bytes=-1 **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_var` **(** **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_16` **(** :ref:`int` value **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_32` **(** :ref:`int` value **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_64` **(** :ref:`int` value **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_8` **(** :ref:`int` value **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`put_data` **(** :ref:`PoolByteArray` data **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_double` **(** :ref:`float` value **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_float` **(** :ref:`float` value **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`put_partial_data` **(** :ref:`PoolByteArray` data **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_string` **(** :ref:`String` value **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_u16` **(** :ref:`int` value **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_u32` **(** :ref:`int` value **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_u64` **(** :ref:`int` value **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_u8` **(** :ref:`int` value **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_utf8_string` **(** :ref:`String` value **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_var` **(** :ref:`Variant` value **)** | -+---------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_16` **(** **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_32` **(** **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_64` **(** **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_8` **(** **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_available_bytes` **(** **)** const | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_data` **(** :ref:`int` bytes **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_double` **(** **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_float` **(** **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_partial_data` **(** :ref:`int` bytes **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_string` **(** :ref:`int` bytes=-1 **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_u16` **(** **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_u32` **(** **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_u64` **(** **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_u8` **(** **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_utf8_string` **(** :ref:`int` bytes=-1 **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_var` **(** :ref:`bool` allow_objects=false **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_16` **(** :ref:`int` value **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_32` **(** :ref:`int` value **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_64` **(** :ref:`int` value **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_8` **(** :ref:`int` value **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`put_data` **(** :ref:`PoolByteArray` data **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_double` **(** :ref:`float` value **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_float` **(** :ref:`float` value **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`put_partial_data` **(** :ref:`PoolByteArray` data **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_string` **(** :ref:`String` value **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_u16` **(** :ref:`int` value **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_u32` **(** :ref:`int` value **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_u64` **(** :ref:`int` value **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_u8` **(** :ref:`int` value **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_utf8_string` **(** :ref:`String` value **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`put_var` **(** :ref:`Variant` value, :ref:`bool` full_objects=false **)** | ++---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -207,9 +207,11 @@ Get a utf8 string with byte-length ``bytes`` from the stream (this decodes the s .. _class_StreamPeer_method_get_var: -- :ref:`Variant` **get_var** **(** **)** +- :ref:`Variant` **get_var** **(** :ref:`bool` allow_objects=false **)** -Get a Variant from the stream. +Get a Variant from the stream. When ``allow_objects`` is ``true`` decoding objects is allowed. + +**WARNING:** Deserialized object can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats (remote code execution). .. _class_StreamPeer_method_put_16: @@ -297,7 +299,7 @@ Put a zero-terminated utf8 string into the stream prepended by a 32 bits unsigne .. _class_StreamPeer_method_put_var: -- void **put_var** **(** :ref:`Variant` value **)** +- void **put_var** **(** :ref:`Variant` value, :ref:`bool` full_objects=false **)** -Put a Variant into the stream. +Put a Variant into the stream. When ``full_objects`` is ``true`` encoding objects is allowed (and can potentially include code). diff --git a/classes/class_streampeerssl.rst b/classes/class_streampeerssl.rst index 5b11b3a1f..f8455e326 100644 --- a/classes/class_streampeerssl.rst +++ b/classes/class_streampeerssl.rst @@ -99,7 +99,7 @@ Method Descriptions - :ref:`Error` **connect_to_stream** **(** :ref:`StreamPeer` stream, :ref:`bool` validate_certs=false, :ref:`String` for_hostname="" **)** -Connect to a peer using an underlying :ref:`StreamPeer` "stream", when "validate_certs" is true, ``StreamPeerSSL`` will validate that the certificate presented by the peer matches the "for_hostname". +Connect to a peer using an underlying :ref:`StreamPeer` "stream", when "validate_certs" is ``true``, ``StreamPeerSSL`` will validate that the certificate presented by the peer matches the "for_hostname". .. _class_StreamPeerSSL_method_disconnect_from_stream: diff --git a/classes/class_string.rst b/classes/class_string.rst index d192f0a26..cfd057b04 100644 --- a/classes/class_string.rst +++ b/classes/class_string.rst @@ -116,6 +116,8 @@ Methods +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_subsequence_ofi` **(** :ref:`String` text **)** | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid_filename` **(** **)** | ++-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_valid_float` **(** **)** | +-----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_valid_hex_number` **(** :ref:`bool` with_prefix=False **)** | @@ -463,6 +465,14 @@ Returns ``true`` if this string is a subsequence of the given string. Returns ``true`` if this string is a subsequence of the given string, without considering case. +.. _class_String_method_is_valid_filename: + +- :ref:`bool` **is_valid_filename** **(** **)** + +Returns ``true`` if this string is free from characters that aren't allowed in file names, those being: + +``: / \ ? * " | % < >`` + .. _class_String_method_is_valid_float: - :ref:`bool` **is_valid_float** **(** **)** diff --git a/classes/class_styleboxflat.rst b/classes/class_styleboxflat.rst index dc7275302..4ddf4f6fe 100644 --- a/classes/class_styleboxflat.rst +++ b/classes/class_styleboxflat.rst @@ -19,49 +19,51 @@ Customizable Stylebox with a given set of parameters. (no texture required) Properties ---------- -+---------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`anti_aliasing` | -+---------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`anti_aliasing_size` | -+---------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`bg_color` | -+---------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`border_blend` | -+---------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`border_color` | -+---------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`border_width_bottom` | -+---------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`border_width_left` | -+---------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`border_width_right` | -+---------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`border_width_top` | -+---------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`corner_detail` | -+---------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`corner_radius_bottom_left` | -+---------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`corner_radius_bottom_right` | -+---------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`corner_radius_top_left` | -+---------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`corner_radius_top_right` | -+---------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`draw_center` | -+---------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`expand_margin_bottom` | -+---------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`expand_margin_left` | -+---------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`expand_margin_right` | -+---------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`expand_margin_top` | -+---------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`shadow_color` | -+---------------------------+-------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`shadow_size` | -+---------------------------+-------------------------------------------------------------------------------------------+ ++-------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`anti_aliasing` | ++-------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`anti_aliasing_size` | ++-------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`bg_color` | ++-------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`border_blend` | ++-------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`border_color` | ++-------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`border_width_bottom` | ++-------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`border_width_left` | ++-------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`border_width_right` | ++-------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`border_width_top` | ++-------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`corner_detail` | ++-------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`corner_radius_bottom_left` | ++-------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`corner_radius_bottom_right` | ++-------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`corner_radius_top_left` | ++-------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`corner_radius_top_right` | ++-------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`draw_center` | ++-------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`expand_margin_bottom` | ++-------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`expand_margin_left` | ++-------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`expand_margin_right` | ++-------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`expand_margin_top` | ++-------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`shadow_color` | ++-------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`shadow_offset` | ++-------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`shadow_size` | ++-------------------------------+-------------------------------------------------------------------------------------------+ Methods ------- @@ -157,7 +159,7 @@ The background color of the stylebox. | *Getter* | get_border_blend() | +----------+-------------------------+ -When set to true, the border will fade into the background color. +When set to ``true``, the border will fade into the background color. .. _class_StyleBoxFlat_property_border_color: @@ -355,6 +357,18 @@ Expands the stylebox outside of the control rect on the top edge. Useful in comb The color of the shadow. (This has no effect when shadow_size < 1) +.. _class_StyleBoxFlat_property_shadow_offset: + +- :ref:`Vector2` **shadow_offset** + ++----------+--------------------------+ +| *Setter* | set_shadow_offset(value) | ++----------+--------------------------+ +| *Getter* | get_shadow_offset() | ++----------+--------------------------+ + +The shadow offset in pixels. Adjusts the position of the shadow relatively to the stylebox. + .. _class_StyleBoxFlat_property_shadow_size: - :ref:`int` **shadow_size** diff --git a/classes/class_tabcontainer.rst b/classes/class_tabcontainer.rst index 7351469f6..0b1ff80e5 100644 --- a/classes/class_tabcontainer.rst +++ b/classes/class_tabcontainer.rst @@ -274,7 +274,7 @@ If set on a :ref:`Popup` node instance, a popup menu icon appears i - void **set_tab_disabled** **(** :ref:`int` tab_idx, :ref:`bool` disabled **)** -If ``disabled`` is false, hides the tab at index ``tab_idx``. Note that its title text will remain, unless also removed with :ref:`set_tab_title`. +If ``disabled`` is ``false``, hides the tab at index ``tab_idx``. Note that its title text will remain, unless also removed with :ref:`set_tab_title`. .. _class_TabContainer_method_set_tab_icon: diff --git a/classes/class_tabs.rst b/classes/class_tabs.rst index 4b9e85125..8cf21a203 100644 --- a/classes/class_tabs.rst +++ b/classes/class_tabs.rst @@ -336,7 +336,7 @@ If ``true``, enables selecting a tab with right mouse button. - void **set_tab_disabled** **(** :ref:`int` tab_idx, :ref:`bool` disabled **)** -If ``disabled`` is false, hides the tab at index ``tab_idx``. Note that its title text will remain, unless also removed with :ref:`set_tab_title`. +If ``disabled`` is ``false``, hides the tab at index ``tab_idx``. Note that its title text will remain, unless also removed with :ref:`set_tab_title`. .. _class_Tabs_method_set_tab_icon: diff --git a/classes/class_tcp_server.rst b/classes/class_tcp_server.rst index 6a230d1bb..485968a3e 100644 --- a/classes/class_tcp_server.rst +++ b/classes/class_tcp_server.rst @@ -41,7 +41,7 @@ Method Descriptions - :ref:`bool` **is_connection_available** **(** **)** const -Return true if a connection is available for taking. +Return ``true`` if a connection is available for taking. .. _class_TCP_Server_method_listen: diff --git a/classes/class_textedit.rst b/classes/class_textedit.rst index ccdf094e1..fa632a60f 100644 --- a/classes/class_textedit.rst +++ b/classes/class_textedit.rst @@ -230,6 +230,10 @@ Emitted when a breakpoint is placed via the breakpoint gutter. Emitted when the cursor changes. +.. _class_TextEdit_signal_info_clicked: + +- **info_clicked** **(** :ref:`int` row, :ref:`String` info **)** + .. _class_TextEdit_signal_request_completion: - **request_completion** **(** **)** @@ -289,9 +293,9 @@ enum **MenuItems**: - **MENU_PASTE** = **2** --- Pastes the clipboard text over the selected text (or at the cursor's position). -- **MENU_CLEAR** = **3** --- Erases the whole :ref:`TextEdit` text. +- **MENU_CLEAR** = **3** --- Erases the whole ``TextEdit`` text. -- **MENU_SELECT_ALL** = **4** --- Selects the whole :ref:`TextEdit` text. +- **MENU_SELECT_ALL** = **4** --- Selects the whole ``TextEdit`` text. - **MENU_UNDO** = **5** --- Undoes the previous action. @@ -479,7 +483,7 @@ If ``true``, line numbers are displayed to the left of the text. | *Getter* | get_text() | +----------+-----------------+ -String value of the :ref:`TextEdit`. +String value of the ``TextEdit``. .. _class_TextEdit_property_v_scroll_speed: @@ -491,7 +495,7 @@ String value of the :ref:`TextEdit`. | *Getter* | get_v_scroll_speed() | +----------+---------------------------+ -If ``true``, enables text wrapping when it goes beyond he edge of what is visible. +Vertical scroll sensitivity. .. _class_TextEdit_property_wrap_enabled: @@ -503,6 +507,8 @@ If ``true``, enables text wrapping when it goes beyond he edge of what is visibl | *Getter* | is_wrap_enabled() | +----------+-------------------------+ +If ``true``, enables text wrapping when it goes beyond the edge of what is visible. + Method Descriptions ------------------- @@ -662,7 +668,7 @@ Insert a given text at the cursor position. - :ref:`bool` **is_selection_active** **(** **)** const -Return true if the selection is active. +Return ``true`` if the selection is active. .. _class_TextEdit_method_menu_option: diff --git a/classes/class_texture.rst b/classes/class_texture.rst index 870b88c5d..d9795ab15 100644 --- a/classes/class_texture.rst +++ b/classes/class_texture.rst @@ -9,7 +9,7 @@ Texture **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`AnimatedTexture`, :ref:`AtlasTexture`, :ref:`CurveTexture`, :ref:`GradientTexture`, :ref:`ImageTexture`, :ref:`LargeTexture`, :ref:`NoiseTexture`, :ref:`ProxyTexture`, :ref:`StreamTexture`, :ref:`ViewportTexture` +**Inherited By:** :ref:`AnimatedTexture`, :ref:`AtlasTexture`, :ref:`CurveTexture`, :ref:`GradientTexture`, :ref:`ImageTexture`, :ref:`LargeTexture`, :ref:`MeshTexture`, :ref:`NoiseTexture`, :ref:`ProxyTexture`, :ref:`StreamTexture`, :ref:`ViewportTexture` **Category:** Core diff --git a/classes/class_texturerect.rst b/classes/class_texturerect.rst index c47e9b50c..9d19a0e22 100644 --- a/classes/class_texturerect.rst +++ b/classes/class_texturerect.rst @@ -22,6 +22,10 @@ Properties +--------------------------------------------------+--------------------------------------------------------------+ | :ref:`bool` | :ref:`expand` | +--------------------------------------------------+--------------------------------------------------------------+ +| :ref:`bool` | :ref:`flip_h` | ++--------------------------------------------------+--------------------------------------------------------------+ +| :ref:`bool` | :ref:`flip_v` | ++--------------------------------------------------+--------------------------------------------------------------+ | :ref:`StretchMode` | :ref:`stretch_mode` | +--------------------------------------------------+--------------------------------------------------------------+ | :ref:`Texture` | :ref:`texture` | @@ -86,6 +90,30 @@ Property Descriptions If ``true``, the texture scales to fit its bounding rectangle. Default value: ``false``. +.. _class_TextureRect_property_flip_h: + +- :ref:`bool` **flip_h** + ++----------+-------------------+ +| *Setter* | set_flip_h(value) | ++----------+-------------------+ +| *Getter* | is_flipped_h() | ++----------+-------------------+ + +If ``true``, texture is flipped horizontally. Default value: ``false``. + +.. _class_TextureRect_property_flip_v: + +- :ref:`bool` **flip_v** + ++----------+-------------------+ +| *Setter* | set_flip_v(value) | ++----------+-------------------+ +| *Getter* | is_flipped_v() | ++----------+-------------------+ + +If ``true``, texture is flipped vertically. Default value: ``false``. + .. _class_TextureRect_property_stretch_mode: - :ref:`StretchMode` **stretch_mode** diff --git a/classes/class_thread.rst b/classes/class_thread.rst index f16012263..9a7de1958 100644 --- a/classes/class_thread.rst +++ b/classes/class_thread.rst @@ -19,15 +19,15 @@ A unit of execution in a process. Methods ------- -+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_id` **(** **)** const | -+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_active` **(** **)** const | -+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`start` **(** :ref:`Object` instance, :ref:`String` method, :ref:`Variant` userdata=null, :ref:`int` priority=1 **)** | -+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`wait_to_finish` **(** **)** | -+---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_id` **(** **)** const | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_active` **(** **)** const | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`start` **(** :ref:`Object` instance, :ref:`String` method, :ref:`Variant` userdata=null, :ref:`Priority` priority=1 **)** | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`wait_to_finish` **(** **)** | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ @@ -66,11 +66,11 @@ Returns the current ``Thread``\ s id, uniquely identifying it among all threads. - :ref:`bool` **is_active** **(** **)** const -Returns true if this ``Thread`` is currently active. An active ``Thread`` cannot start work on a new method but can be joined with :ref:`wait_to_finish`. +Returns ``true`` if this ``Thread`` is currently active. An active ``Thread`` cannot start work on a new method but can be joined with :ref:`wait_to_finish`. .. _class_Thread_method_start: -- :ref:`Error` **start** **(** :ref:`Object` instance, :ref:`String` method, :ref:`Variant` userdata=null, :ref:`int` priority=1 **)** +- :ref:`Error` **start** **(** :ref:`Object` instance, :ref:`String` method, :ref:`Variant` userdata=null, :ref:`Priority` priority=1 **)** Starts a new ``Thread`` that runs "method" on object "instance" with "userdata" passed as an argument. The "priority" of the ``Thread`` can be changed by passing a PRIORITY\_\* enum. diff --git a/classes/class_tilemap.rst b/classes/class_tilemap.rst index 801b751b6..04ab455a9 100644 --- a/classes/class_tilemap.rst +++ b/classes/class_tilemap.rst @@ -136,6 +136,10 @@ enum **Mode**: .. _class_TileMap_constant_HALF_OFFSET_DISABLED: +.. _class_TileMap_constant_HALF_OFFSET_NEGATIVE_X: + +.. _class_TileMap_constant_HALF_OFFSET_NEGATIVE_Y: + enum **HalfOffset**: - **HALF_OFFSET_X** = **0** --- Half offset on the X coordinate. @@ -144,6 +148,10 @@ enum **HalfOffset**: - **HALF_OFFSET_DISABLED** = **2** --- Half offset disabled. +- **HALF_OFFSET_NEGATIVE_X** = **3** --- Half offset on the X coordinate (negative). + +- **HALF_OFFSET_NEGATIVE_Y** = **4** --- Half offset on the Y coordinate (negative). + .. _enum_TileMap_TileOrigin: .. _class_TileMap_constant_TILE_ORIGIN_TOP_LEFT: @@ -459,6 +467,15 @@ Note that data such as navigation polygons and collision shapes are not immediat If you need these to be immediately updated, you can call :ref:`update_dirty_quadrants`. +Overriding this method also overrides it internally, allowing custom logic to be implemented when tiles are placed/removed: + +:: + + func set_cell(x, y, tile, flip_x, flip_y, transpose, autotile_coord) + # Write your custom logic here. + # To call the default method: + .set_cell(x, y, tile, flip_x, flip_y, transpose, autotile_coord) + .. _class_TileMap_method_set_cellv: - void **set_cellv** **(** :ref:`Vector2` position, :ref:`int` tile, :ref:`bool` flip_x=false, :ref:`bool` flip_y=false, :ref:`bool` transpose=false **)** diff --git a/classes/class_transform.rst b/classes/class_transform.rst index 005f6aac8..d3b8303a4 100644 --- a/classes/class_transform.rst +++ b/classes/class_transform.rst @@ -73,9 +73,9 @@ Constants - **FLIP_X** = **Transform( -1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )** -- **FLIP_Y** = **Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )** +- **FLIP_Y** = **Transform( 1, 0, 0, 0, -1, 0, 0, 0, 1, 0, 0, 0 )** -- **FLIP_Z** = **Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )** +- **FLIP_Z** = **Transform( 1, 0, 0, 0, 1, 0, 0, 0, -1, 0, 0, 0 )** Description ----------- diff --git a/classes/class_treeitem.rst b/classes/class_treeitem.rst index 33b45330d..fe6942ddf 100644 --- a/classes/class_treeitem.rst +++ b/classes/class_treeitem.rst @@ -472,7 +472,7 @@ Sets the given column's custom color. Sets the given column's custom draw callback to ``callback`` method on ``object``. -The ``callback`` should accept two arguments: the :ref:`TreeItem` that is drawn and its position and size as a :ref:`Rect2`. +The ``callback`` should accept two arguments: the ``TreeItem`` that is drawn and its position and size as a :ref:`Rect2`. .. _class_TreeItem_method_set_editable: diff --git a/classes/class_tween.rst b/classes/class_tween.rst index 30dc652e2..38106c6b0 100644 --- a/classes/class_tween.rst +++ b/classes/class_tween.rst @@ -79,6 +79,12 @@ Methods Signals ------- +.. _class_Tween_signal_tween_all_completed: + +- **tween_all_completed** **(** **)** + +Emitted when all processes in a tween end. + .. _class_Tween_signal_tween_completed: - **tween_completed** **(** :ref:`Object` object, :ref:`NodePath` key **)** diff --git a/classes/class_upnpdevice.rst b/classes/class_upnpdevice.rst index 66eea5810..319d71694 100644 --- a/classes/class_upnpdevice.rst +++ b/classes/class_upnpdevice.rst @@ -135,7 +135,7 @@ IDG control URL. | *Getter* | get_igd_our_addr() | +----------+-------------------------+ -Address of the local machine in the network connecting it to this :ref:`UPNPDevice`. +Address of the local machine in the network connecting it to this ``UPNPDevice``. .. _class_UPNPDevice_property_igd_service_type: @@ -180,7 +180,7 @@ Method Descriptions - :ref:`int` **add_port_mapping** **(** :ref:`int` port, :ref:`int` port_internal=0, :ref:`String` desc="", :ref:`String` proto="UDP", :ref:`int` duration=0 **)** const -Adds a port mapping to forward the given external port on this :ref:`UPNPDevice` for the given protocol to the local machine. See :ref:`UPNP.add_port_mapping`. +Adds a port mapping to forward the given external port on this ``UPNPDevice`` for the given protocol to the local machine. See :ref:`UPNP.add_port_mapping`. .. _class_UPNPDevice_method_delete_port_mapping: @@ -198,5 +198,5 @@ Returns ``true`` if this is a valid IGD (InternetGatewayDevice) which potentiall - :ref:`String` **query_external_address** **(** **)** const -Returns the external IP address of this :ref:`UPNPDevice` or an empty string. +Returns the external IP address of this ``UPNPDevice`` or an empty string. diff --git a/classes/class_vector2.rst b/classes/class_vector2.rst index 66dc23e44..9dd31e552 100644 --- a/classes/class_vector2.rst +++ b/classes/class_vector2.rst @@ -49,6 +49,8 @@ Methods +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`cubic_interpolate` **(** :ref:`Vector2` b, :ref:`Vector2` pre_a, :ref:`Vector2` post_b, :ref:`float` t **)** | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`direction_to` **(** :ref:`Vector2` b **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`distance_squared_to` **(** :ref:`Vector2` to **)** | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`distance_to` **(** :ref:`Vector2` to **)** | @@ -211,6 +213,12 @@ Returns the 2 dimensional analog of the cross product with the given vector. Cubicly interpolates between this vector and ``b`` using ``pre_a`` and ``post_b`` as handles, and returns the result at position ``t``. ``t`` is in the range of ``0.0 - 1.0``, representing the amount of interpolation. +.. _class_Vector2_method_direction_to: + +- :ref:`Vector2` **direction_to** **(** :ref:`Vector2` b **)** + +Returns the normalized vector pointing from this vector to ``b``. + .. _class_Vector2_method_distance_squared_to: - :ref:`float` **distance_squared_to** **(** :ref:`Vector2` to **)** diff --git a/classes/class_vector3.rst b/classes/class_vector3.rst index 1393a5553..3a98299e4 100644 --- a/classes/class_vector3.rst +++ b/classes/class_vector3.rst @@ -43,6 +43,8 @@ Methods +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`cubic_interpolate` **(** :ref:`Vector3` b, :ref:`Vector3` pre_a, :ref:`Vector3` post_b, :ref:`float` t **)** | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`direction_to` **(** :ref:`Vector3` b **)** | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`distance_squared_to` **(** :ref:`Vector3` b **)** | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`distance_to` **(** :ref:`Vector3` b **)** | @@ -213,6 +215,12 @@ Returns the cross product with ``b``. Performs a cubic interpolation between vectors ``pre_a``, ``a``, ``b``, ``post_b`` (``a`` is current), by the given amount ``t``. ``t`` is in the range of ``0.0 - 1.0``, representing the amount of interpolation. +.. _class_Vector3_method_direction_to: + +- :ref:`Vector3` **direction_to** **(** :ref:`Vector3` b **)** + +Returns the normalized vector pointing from this vector to ``b``. + .. _class_Vector3_method_distance_squared_to: - :ref:`float` **distance_squared_to** **(** :ref:`Vector3` b **)** diff --git a/classes/class_vehiclebody.rst b/classes/class_vehiclebody.rst index a37f7cac3..84b3e2a5b 100644 --- a/classes/class_vehiclebody.rst +++ b/classes/class_vehiclebody.rst @@ -59,7 +59,7 @@ Slows down the vehicle by applying a braking force. The vehicle is only slowed d | *Getter* | get_engine_force() | +----------+-------------------------+ -Accelerates the vehicle by applying an engine force. The vehicle is only speed up if the wheels that have :ref:`VehicleWheel.use_as_traction` set to true and are in contact with a surface. The :ref:`RigidBody.mass` of the vehicle has an effect on the acceleration of the vehicle. For a vehicle with a mass set to 1000, try a value in the 25 - 50 range for acceleration. Note that the simulation does not take the effect of gears into account, you will need to add logic for this if you wish to simulate gears. +Accelerates the vehicle by applying an engine force. The vehicle is only speed up if the wheels that have :ref:`VehicleWheel.use_as_traction` set to ``true`` and are in contact with a surface. The :ref:`RigidBody.mass` of the vehicle has an effect on the acceleration of the vehicle. For a vehicle with a mass set to 1000, try a value in the 25 - 50 range for acceleration. Note that the simulation does not take the effect of gears into account, you will need to add logic for this if you wish to simulate gears. A negative value will result in the vehicle reversing. @@ -73,5 +73,5 @@ A negative value will result in the vehicle reversing. | *Getter* | get_steering() | +----------+---------------------+ -The steering angle for the vehicle. Setting this to a non-zero value will result in the vehicle turning when it's moving. Wheels that have :ref:`VehicleWheel.use_as_steering` set to true will automatically be rotated. +The steering angle for the vehicle. Setting this to a non-zero value will result in the vehicle turning when it's moving. Wheels that have :ref:`VehicleWheel.use_as_steering` set to ``true`` will automatically be rotated. diff --git a/classes/class_vehiclewheel.rst b/classes/class_vehiclewheel.rst index df8af8faf..21318704d 100644 --- a/classes/class_vehiclewheel.rst +++ b/classes/class_vehiclewheel.rst @@ -130,7 +130,7 @@ This is the distance the suspension can travel. As Godot measures are in meters | *Getter* | is_used_as_steering() | +----------+----------------------------+ -If true this wheel will be turned when the car steers. +If ``true`` this wheel will be turned when the car steers. .. _class_VehicleWheel_property_use_as_traction: @@ -142,7 +142,7 @@ If true this wheel will be turned when the car steers. | *Getter* | is_used_as_traction() | +----------+----------------------------+ -If true this wheel transfers engine force to the ground to propel the vehicle forward. +If ``true`` this wheel transfers engine force to the ground to propel the vehicle forward. .. _class_VehicleWheel_property_wheel_friction_slip: @@ -207,5 +207,5 @@ Returns a value between 0.0 and 1.0 that indicates whether this wheel is skiddin - :ref:`bool` **is_in_contact** **(** **)** const -Returns true if this wheel is in contact with a surface. +Returns ``true`` if this wheel is in contact with a surface. diff --git a/classes/class_visibilitynotifier.rst b/classes/class_visibilitynotifier.rst index d96b07e8b..c4579c5c1 100644 --- a/classes/class_visibilitynotifier.rst +++ b/classes/class_visibilitynotifier.rst @@ -88,3 +88,5 @@ Method Descriptions If ``true``, the bounding box is on the screen. +Note: It takes one frame for the node's visibility to be assessed once added to the scene tree, so this method will return ``false`` right after it is instantiated, even if it will be on screen in the draw pass. + diff --git a/classes/class_visibilitynotifier2d.rst b/classes/class_visibilitynotifier2d.rst index 811a9ddae..cabac18d2 100644 --- a/classes/class_visibilitynotifier2d.rst +++ b/classes/class_visibilitynotifier2d.rst @@ -88,3 +88,5 @@ Method Descriptions If ``true``, the bounding rectangle is on the screen. +Note: It takes one frame for the node's visibility to be assessed once added to the scene tree, so this method will return ``false`` right after it is instantiated, even if it will be on screen in the draw pass. + diff --git a/classes/class_visualinstance.rst b/classes/class_visualinstance.rst index a075dfedf..0e3f1f368 100644 --- a/classes/class_visualinstance.rst +++ b/classes/class_visualinstance.rst @@ -9,7 +9,7 @@ VisualInstance **Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`BakedLightmap`, :ref:`CSGShape`, :ref:`GIProbe`, :ref:`GeometryInstance`, :ref:`Light`, :ref:`ReflectionProbe`, :ref:`RootMotionView` +**Inherited By:** :ref:`BakedLightmap`, :ref:`GIProbe`, :ref:`GeometryInstance`, :ref:`Light`, :ref:`ReflectionProbe`, :ref:`RootMotionView` **Category:** Core @@ -31,6 +31,10 @@ Methods +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AABB` | :ref:`get_aabb` **(** **)** const | +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_base` **(** **)** const | ++-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_instance` **(** **)** const | ++-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_layer_mask_bit` **(** :ref:`int` layer **)** const | +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AABB` | :ref:`get_transformed_aabb` **(** **)** const | @@ -66,6 +70,14 @@ Method Descriptions Returns the :ref:`AABB` (also known as the bounding box) for this VisualInstance. +.. _class_VisualInstance_method_get_base: + +- :ref:`RID` **get_base** **(** **)** const + +.. _class_VisualInstance_method_get_instance: + +- :ref:`RID` **get_instance** **(** **)** const + .. _class_VisualInstance_method_get_layer_mask_bit: - :ref:`bool` **get_layer_mask_bit** **(** :ref:`int` layer **)** const diff --git a/classes/class_visualscriptbuiltinfunc.rst b/classes/class_visualscriptbuiltinfunc.rst index 08edf3e29..5e41a0064 100644 --- a/classes/class_visualscriptbuiltinfunc.rst +++ b/classes/class_visualscriptbuiltinfunc.rst @@ -154,6 +154,8 @@ Enumerations .. _class_VisualScriptBuiltinFunc_constant_COLORN: +.. _class_VisualScriptBuiltinFunc_constant_MATH_SMOOTHSTEP: + .. _class_VisualScriptBuiltinFunc_constant_FUNC_MAX: enum **BuiltinFunc**: @@ -284,7 +286,14 @@ enum **BuiltinFunc**: - **COLORN** = **62** --- Return the :ref:`Color` with the given name and alpha ranging from 0 to 1. Note: names are defined in color_names.inc. -- **FUNC_MAX** = **63** --- The maximum value the :ref:`function` property can have. +- **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: + +:: + + 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` property can have. Description ----------- diff --git a/classes/class_visualscriptcustomnode.rst b/classes/class_visualscriptcustomnode.rst index 9c5b9ce44..518ba0dac 100644 --- a/classes/class_visualscriptcustomnode.rst +++ b/classes/class_visualscriptcustomnode.rst @@ -83,7 +83,7 @@ Constants - **STEP_PUSH_STACK_BIT** = **16777216** --- Hint used by :ref:`_step` to tell that control should return to it when there is no other node left to execute. -This is used by :ref:`VisualScriptCondition` to redirect the sequence to the "Done" port after the true/false branch has finished execution. +This is used by :ref:`VisualScriptCondition` to redirect the sequence to the "Done" port after the ``true``/``false`` branch has finished execution. - **STEP_GO_BACK_BIT** = **33554432** --- Hint used by :ref:`_step` to tell that control should return back, either hitting a previous STEP_PUSH_STACK_BIT or exiting the function. diff --git a/classes/class_visualserver.rst b/classes/class_visualserver.rst index fb39be044..54b107668 100644 --- a/classes/class_visualserver.rst +++ b/classes/class_visualserver.rst @@ -30,6 +30,8 @@ Methods +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`camera_set_environment` **(** :ref:`RID` camera, :ref:`RID` env **)** | +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`camera_set_frustum` **(** :ref:`RID` camera, :ref:`float` size, :ref:`Vector2` offset, :ref:`float` z_near, :ref:`float` z_far **)** | ++---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`camera_set_orthogonal` **(** :ref:`RID` camera, :ref:`float` size, :ref:`float` z_near, :ref:`float` z_far **)** | +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`camera_set_perspective` **(** :ref:`RID` camera, :ref:`float` fovy_degrees, :ref:`float` z_near, :ref:`float` z_far **)** | @@ -46,7 +48,7 @@ Methods +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_add_line` **(** :ref:`RID` item, :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_mesh` **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`RID` texture, :ref:`RID` normal_map **)** | +| void | :ref:`canvas_item_add_mesh` **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`Transform2D` texture, :ref:`Color` normal_map, :ref:`RID` arg4, :ref:`RID` arg5 **)** | +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`canvas_item_add_multimesh` **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`RID` texture, :ref:`RID` normal_map **)** | +---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -1802,6 +1804,10 @@ Sets margin size, where black bars (or images, if :ref:`black_bars_set_images` camera, :ref:`RID` env **)** +.. _class_VisualServer_method_camera_set_frustum: + +- void **camera_set_frustum** **(** :ref:`RID` camera, :ref:`float` size, :ref:`Vector2` offset, :ref:`float` z_near, :ref:`float` z_far **)** + .. _class_VisualServer_method_camera_set_orthogonal: - void **camera_set_orthogonal** **(** :ref:`RID` camera, :ref:`float` size, :ref:`float` z_near, :ref:`float` z_far **)** @@ -1844,9 +1850,7 @@ Adds a line command to the :ref:`CanvasItem`'s draw commands. .. _class_VisualServer_method_canvas_item_add_mesh: -- void **canvas_item_add_mesh** **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`RID` texture, :ref:`RID` normal_map **)** - -Adds a :ref:`Mesh` to the :ref:`CanvasItem`'s draw commands. Only affects its aabb at the moment. +- void **canvas_item_add_mesh** **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`Transform2D` texture, :ref:`Color` normal_map, :ref:`RID` arg4, :ref:`RID` arg5 **)** .. _class_VisualServer_method_canvas_item_add_multimesh: diff --git a/classes/class_visualshadernode.rst b/classes/class_visualshadernode.rst index 8767ad7fe..b6cfb9a59 100644 --- a/classes/class_visualshadernode.rst +++ b/classes/class_visualshadernode.rst @@ -9,7 +9,7 @@ VisualShaderNode **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`VisualShaderNodeColorConstant`, :ref:`VisualShaderNodeColorOp`, :ref:`VisualShaderNodeCubeMap`, :ref:`VisualShaderNodeCubeMapUniform`, :ref:`VisualShaderNodeDotProduct`, :ref:`VisualShaderNodeInput`, :ref:`VisualShaderNodeOutput`, :ref:`VisualShaderNodeScalarConstant`, :ref:`VisualShaderNodeScalarFunc`, :ref:`VisualShaderNodeScalarInterp`, :ref:`VisualShaderNodeScalarOp`, :ref:`VisualShaderNodeTexture`, :ref:`VisualShaderNodeTransformCompose`, :ref:`VisualShaderNodeTransformConstant`, :ref:`VisualShaderNodeTransformDecompose`, :ref:`VisualShaderNodeTransformMult`, :ref:`VisualShaderNodeTransformVecMult`, :ref:`VisualShaderNodeUniform`, :ref:`VisualShaderNodeVec3Constant`, :ref:`VisualShaderNodeVectorCompose`, :ref:`VisualShaderNodeVectorDecompose`, :ref:`VisualShaderNodeVectorFunc`, :ref:`VisualShaderNodeVectorInterp`, :ref:`VisualShaderNodeVectorLen`, :ref:`VisualShaderNodeVectorOp` +**Inherited By:** :ref:`VisualShaderNodeBooleanConstant`, :ref:`VisualShaderNodeColorConstant`, :ref:`VisualShaderNodeColorFunc`, :ref:`VisualShaderNodeColorOp`, :ref:`VisualShaderNodeCubeMap`, :ref:`VisualShaderNodeCubeMapUniform`, :ref:`VisualShaderNodeDeterminant`, :ref:`VisualShaderNodeDotProduct`, :ref:`VisualShaderNodeFaceForward`, :ref:`VisualShaderNodeIf`, :ref:`VisualShaderNodeInput`, :ref:`VisualShaderNodeOuterProduct`, :ref:`VisualShaderNodeOutput`, :ref:`VisualShaderNodeScalarClamp`, :ref:`VisualShaderNodeScalarConstant`, :ref:`VisualShaderNodeScalarDerivativeFunc`, :ref:`VisualShaderNodeScalarFunc`, :ref:`VisualShaderNodeScalarInterp`, :ref:`VisualShaderNodeScalarOp`, :ref:`VisualShaderNodeScalarSmoothStep`, :ref:`VisualShaderNodeSwitch`, :ref:`VisualShaderNodeTexture`, :ref:`VisualShaderNodeTransformCompose`, :ref:`VisualShaderNodeTransformConstant`, :ref:`VisualShaderNodeTransformDecompose`, :ref:`VisualShaderNodeTransformFunc`, :ref:`VisualShaderNodeTransformMult`, :ref:`VisualShaderNodeTransformVecMult`, :ref:`VisualShaderNodeUniform`, :ref:`VisualShaderNodeVec3Constant`, :ref:`VisualShaderNodeVectorClamp`, :ref:`VisualShaderNodeVectorCompose`, :ref:`VisualShaderNodeVectorDecompose`, :ref:`VisualShaderNodeVectorDerivativeFunc`, :ref:`VisualShaderNodeVectorDistance`, :ref:`VisualShaderNodeVectorFunc`, :ref:`VisualShaderNodeVectorInterp`, :ref:`VisualShaderNodeVectorLen`, :ref:`VisualShaderNodeVectorOp`, :ref:`VisualShaderNodeVectorRefract`, :ref:`VisualShaderNodeVectorScalarSmoothStep`, :ref:`VisualShaderNodeVectorScalarStep`, :ref:`VisualShaderNodeVectorSmoothStep` **Category:** Core diff --git a/classes/class_visualshadernodebooleanconstant.rst b/classes/class_visualshadernodebooleanconstant.rst new file mode 100644 index 000000000..17fb9cb3b --- /dev/null +++ b/classes/class_visualshadernodebooleanconstant.rst @@ -0,0 +1,38 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeBooleanConstant.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeBooleanConstant: + +VisualShaderNodeBooleanConstant +=============================== + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Properties +---------- + ++-------------------------+--------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`constant` | ++-------------------------+--------------------------------------------------------------------------+ + +Property Descriptions +--------------------- + +.. _class_VisualShaderNodeBooleanConstant_property_constant: + +- :ref:`bool` **constant** + ++----------+---------------------+ +| *Setter* | set_constant(value) | ++----------+---------------------+ +| *Getter* | get_constant() | ++----------+---------------------+ + diff --git a/classes/class_visualshadernodebooleanuniform.rst b/classes/class_visualshadernodebooleanuniform.rst new file mode 100644 index 000000000..41b2ce2f8 --- /dev/null +++ b/classes/class_visualshadernodebooleanuniform.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeBooleanUniform.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeBooleanUniform: + +VisualShaderNodeBooleanUniform +============================== + +**Inherits:** :ref:`VisualShaderNodeUniform` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_visualshadernodecolorfunc.rst b/classes/class_visualshadernodecolorfunc.rst new file mode 100644 index 000000000..299c082c1 --- /dev/null +++ b/classes/class_visualshadernodecolorfunc.rst @@ -0,0 +1,53 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeColorFunc.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeColorFunc: + +VisualShaderNodeColorFunc +========================= + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Properties +---------- + ++----------------------------------------------------------+--------------------------------------------------------------------+ +| :ref:`Function` | :ref:`function` | ++----------------------------------------------------------+--------------------------------------------------------------------+ + +Enumerations +------------ + +.. _enum_VisualShaderNodeColorFunc_Function: + +.. _class_VisualShaderNodeColorFunc_constant_FUNC_GRAYSCALE: + +.. _class_VisualShaderNodeColorFunc_constant_FUNC_SEPIA: + +enum **Function**: + +- **FUNC_GRAYSCALE** = **0** + +- **FUNC_SEPIA** = **1** + +Property Descriptions +--------------------- + +.. _class_VisualShaderNodeColorFunc_property_function: + +- :ref:`Function` **function** + ++----------+---------------------+ +| *Setter* | set_function(value) | ++----------+---------------------+ +| *Getter* | get_function() | ++----------+---------------------+ + diff --git a/classes/class_visualshadernodedeterminant.rst b/classes/class_visualshadernodedeterminant.rst new file mode 100644 index 000000000..604d70c6f --- /dev/null +++ b/classes/class_visualshadernodedeterminant.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeDeterminant.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeDeterminant: + +VisualShaderNodeDeterminant +=========================== + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_visualshadernodefaceforward.rst b/classes/class_visualshadernodefaceforward.rst new file mode 100644 index 000000000..08614b4c1 --- /dev/null +++ b/classes/class_visualshadernodefaceforward.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeFaceForward.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeFaceForward: + +VisualShaderNodeFaceForward +=========================== + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_visualshadernodeif.rst b/classes/class_visualshadernodeif.rst new file mode 100644 index 000000000..ac4c555f3 --- /dev/null +++ b/classes/class_visualshadernodeif.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeIf.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeIf: + +VisualShaderNodeIf +================== + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_visualshadernodeouterproduct.rst b/classes/class_visualshadernodeouterproduct.rst new file mode 100644 index 000000000..277c13dc4 --- /dev/null +++ b/classes/class_visualshadernodeouterproduct.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeOuterProduct.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeOuterProduct: + +VisualShaderNodeOuterProduct +============================ + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_visualshadernodescalarclamp.rst b/classes/class_visualshadernodescalarclamp.rst new file mode 100644 index 000000000..070a8936c --- /dev/null +++ b/classes/class_visualshadernodescalarclamp.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeScalarClamp.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeScalarClamp: + +VisualShaderNodeScalarClamp +=========================== + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_visualshadernodescalarderivativefunc.rst b/classes/class_visualshadernodescalarderivativefunc.rst new file mode 100644 index 000000000..6cafc3b1a --- /dev/null +++ b/classes/class_visualshadernodescalarderivativefunc.rst @@ -0,0 +1,57 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeScalarDerivativeFunc.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeScalarDerivativeFunc: + +VisualShaderNodeScalarDerivativeFunc +==================================== + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Properties +---------- + ++---------------------------------------------------------------------+-------------------------------------------------------------------------------+ +| :ref:`Function` | :ref:`function` | ++---------------------------------------------------------------------+-------------------------------------------------------------------------------+ + +Enumerations +------------ + +.. _enum_VisualShaderNodeScalarDerivativeFunc_Function: + +.. _class_VisualShaderNodeScalarDerivativeFunc_constant_FUNC_SUM: + +.. _class_VisualShaderNodeScalarDerivativeFunc_constant_FUNC_X: + +.. _class_VisualShaderNodeScalarDerivativeFunc_constant_FUNC_Y: + +enum **Function**: + +- **FUNC_SUM** = **0** + +- **FUNC_X** = **1** + +- **FUNC_Y** = **2** + +Property Descriptions +--------------------- + +.. _class_VisualShaderNodeScalarDerivativeFunc_property_function: + +- :ref:`Function` **function** + ++----------+---------------------+ +| *Setter* | set_function(value) | ++----------+---------------------+ +| *Getter* | get_function() | ++----------+---------------------+ + diff --git a/classes/class_visualshadernodescalarfunc.rst b/classes/class_visualshadernodescalarfunc.rst index 5fef9156d..2503bf4ca 100644 --- a/classes/class_visualshadernodescalarfunc.rst +++ b/classes/class_visualshadernodescalarfunc.rst @@ -68,6 +68,28 @@ Enumerations .. _class_VisualShaderNodeScalarFunc_constant_FUNC_NEGATE: +.. _class_VisualShaderNodeScalarFunc_constant_FUNC_ACOSH: + +.. _class_VisualShaderNodeScalarFunc_constant_FUNC_ASINH: + +.. _class_VisualShaderNodeScalarFunc_constant_FUNC_ATANH: + +.. _class_VisualShaderNodeScalarFunc_constant_FUNC_DEGREES: + +.. _class_VisualShaderNodeScalarFunc_constant_FUNC_EXP2: + +.. _class_VisualShaderNodeScalarFunc_constant_FUNC_INVERSE_SQRT: + +.. _class_VisualShaderNodeScalarFunc_constant_FUNC_LOG2: + +.. _class_VisualShaderNodeScalarFunc_constant_FUNC_RADIANS: + +.. _class_VisualShaderNodeScalarFunc_constant_FUNC_RECIPROCAL: + +.. _class_VisualShaderNodeScalarFunc_constant_FUNC_ROUNDEVEN: + +.. _class_VisualShaderNodeScalarFunc_constant_FUNC_TRUNC: + enum **Function**: - **FUNC_SIN** = **0** @@ -110,6 +132,28 @@ enum **Function**: - **FUNC_NEGATE** = **19** +- **FUNC_ACOSH** = **20** + +- **FUNC_ASINH** = **21** + +- **FUNC_ATANH** = **22** + +- **FUNC_DEGREES** = **23** + +- **FUNC_EXP2** = **24** + +- **FUNC_INVERSE_SQRT** = **25** + +- **FUNC_LOG2** = **26** + +- **FUNC_RADIANS** = **27** + +- **FUNC_RECIPROCAL** = **28** + +- **FUNC_ROUNDEVEN** = **29** + +- **FUNC_TRUNC** = **30** + Property Descriptions --------------------- diff --git a/classes/class_visualshadernodescalarop.rst b/classes/class_visualshadernodescalarop.rst index 24c7f539a..05087ee17 100644 --- a/classes/class_visualshadernodescalarop.rst +++ b/classes/class_visualshadernodescalarop.rst @@ -46,6 +46,8 @@ Enumerations .. _class_VisualShaderNodeScalarOp_constant_OP_ATAN2: +.. _class_VisualShaderNodeScalarOp_constant_OP_STEP: + enum **Operator**: - **OP_ADD** = **0** @@ -66,6 +68,8 @@ enum **Operator**: - **OP_ATAN2** = **8** +- **OP_STEP** = **9** + Property Descriptions --------------------- diff --git a/classes/class_visualshadernodescalarsmoothstep.rst b/classes/class_visualshadernodescalarsmoothstep.rst new file mode 100644 index 000000000..0c3115b4b --- /dev/null +++ b/classes/class_visualshadernodescalarsmoothstep.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeScalarSmoothStep.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeScalarSmoothStep: + +VisualShaderNodeScalarSmoothStep +================================ + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_visualshadernodeswitch.rst b/classes/class_visualshadernodeswitch.rst new file mode 100644 index 000000000..69ec12ad7 --- /dev/null +++ b/classes/class_visualshadernodeswitch.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeSwitch.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeSwitch: + +VisualShaderNodeSwitch +====================== + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_visualshadernodetransformfunc.rst b/classes/class_visualshadernodetransformfunc.rst new file mode 100644 index 000000000..80a714d62 --- /dev/null +++ b/classes/class_visualshadernodetransformfunc.rst @@ -0,0 +1,53 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeTransformFunc.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeTransformFunc: + +VisualShaderNodeTransformFunc +============================= + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Properties +---------- + ++--------------------------------------------------------------+------------------------------------------------------------------------+ +| :ref:`Function` | :ref:`function` | ++--------------------------------------------------------------+------------------------------------------------------------------------+ + +Enumerations +------------ + +.. _enum_VisualShaderNodeTransformFunc_Function: + +.. _class_VisualShaderNodeTransformFunc_constant_FUNC_INVERSE: + +.. _class_VisualShaderNodeTransformFunc_constant_FUNC_TRANSPOSE: + +enum **Function**: + +- **FUNC_INVERSE** = **0** + +- **FUNC_TRANSPOSE** = **1** + +Property Descriptions +--------------------- + +.. _class_VisualShaderNodeTransformFunc_property_function: + +- :ref:`Function` **function** + ++----------+---------------------+ +| *Setter* | set_function(value) | ++----------+---------------------+ +| *Getter* | get_function() | ++----------+---------------------+ + diff --git a/classes/class_visualshadernodetransformmult.rst b/classes/class_visualshadernodetransformmult.rst index 54e63dbb0..5708a9b34 100644 --- a/classes/class_visualshadernodetransformmult.rst +++ b/classes/class_visualshadernodetransformmult.rst @@ -32,12 +32,20 @@ Enumerations .. _class_VisualShaderNodeTransformMult_constant_OP_BxA: +.. _class_VisualShaderNodeTransformMult_constant_OP_AxB_COMP: + +.. _class_VisualShaderNodeTransformMult_constant_OP_BxA_COMP: + enum **Operator**: - **OP_AxB** = **0** - **OP_BxA** = **1** +- **OP_AxB_COMP** = **2** + +- **OP_BxA_COMP** = **3** + Property Descriptions --------------------- diff --git a/classes/class_visualshadernodeuniform.rst b/classes/class_visualshadernodeuniform.rst index 0c7d1e4d5..7f8c871ad 100644 --- a/classes/class_visualshadernodeuniform.rst +++ b/classes/class_visualshadernodeuniform.rst @@ -9,7 +9,7 @@ VisualShaderNodeUniform **Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`VisualShaderNodeColorUniform`, :ref:`VisualShaderNodeScalarUniform`, :ref:`VisualShaderNodeTextureUniform`, :ref:`VisualShaderNodeTransformUniform`, :ref:`VisualShaderNodeVec3Uniform` +**Inherited By:** :ref:`VisualShaderNodeBooleanUniform`, :ref:`VisualShaderNodeColorUniform`, :ref:`VisualShaderNodeScalarUniform`, :ref:`VisualShaderNodeTextureUniform`, :ref:`VisualShaderNodeTransformUniform`, :ref:`VisualShaderNodeVec3Uniform` **Category:** Core diff --git a/classes/class_visualshadernodevectorclamp.rst b/classes/class_visualshadernodevectorclamp.rst new file mode 100644 index 000000000..5eb5fcd7e --- /dev/null +++ b/classes/class_visualshadernodevectorclamp.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeVectorClamp.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeVectorClamp: + +VisualShaderNodeVectorClamp +=========================== + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_visualshadernodevectorderivativefunc.rst b/classes/class_visualshadernodevectorderivativefunc.rst new file mode 100644 index 000000000..68c70107b --- /dev/null +++ b/classes/class_visualshadernodevectorderivativefunc.rst @@ -0,0 +1,57 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeVectorDerivativeFunc.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeVectorDerivativeFunc: + +VisualShaderNodeVectorDerivativeFunc +==================================== + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Properties +---------- + ++---------------------------------------------------------------------+-------------------------------------------------------------------------------+ +| :ref:`Function` | :ref:`function` | ++---------------------------------------------------------------------+-------------------------------------------------------------------------------+ + +Enumerations +------------ + +.. _enum_VisualShaderNodeVectorDerivativeFunc_Function: + +.. _class_VisualShaderNodeVectorDerivativeFunc_constant_FUNC_SUM: + +.. _class_VisualShaderNodeVectorDerivativeFunc_constant_FUNC_X: + +.. _class_VisualShaderNodeVectorDerivativeFunc_constant_FUNC_Y: + +enum **Function**: + +- **FUNC_SUM** = **0** + +- **FUNC_X** = **1** + +- **FUNC_Y** = **2** + +Property Descriptions +--------------------- + +.. _class_VisualShaderNodeVectorDerivativeFunc_property_function: + +- :ref:`Function` **function** + ++----------+---------------------+ +| *Setter* | set_function(value) | ++----------+---------------------+ +| *Getter* | get_function() | ++----------+---------------------+ + diff --git a/classes/class_visualshadernodevectordistance.rst b/classes/class_visualshadernodevectordistance.rst new file mode 100644 index 000000000..610e4fd2c --- /dev/null +++ b/classes/class_visualshadernodevectordistance.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeVectorDistance.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeVectorDistance: + +VisualShaderNodeVectorDistance +============================== + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_visualshadernodevectorfunc.rst b/classes/class_visualshadernodevectorfunc.rst index ec7ff49ce..56ab7919b 100644 --- a/classes/class_visualshadernodevectorfunc.rst +++ b/classes/class_visualshadernodevectorfunc.rst @@ -40,6 +40,62 @@ Enumerations .. _class_VisualShaderNodeVectorFunc_constant_FUNC_HSV2RGB: +.. _class_VisualShaderNodeVectorFunc_constant_FUNC_ABS: + +.. _class_VisualShaderNodeVectorFunc_constant_FUNC_ACOS: + +.. _class_VisualShaderNodeVectorFunc_constant_FUNC_ACOSH: + +.. _class_VisualShaderNodeVectorFunc_constant_FUNC_ASIN: + +.. _class_VisualShaderNodeVectorFunc_constant_FUNC_ASINH: + +.. _class_VisualShaderNodeVectorFunc_constant_FUNC_ATAN: + +.. _class_VisualShaderNodeVectorFunc_constant_FUNC_ATANH: + +.. _class_VisualShaderNodeVectorFunc_constant_FUNC_CEIL: + +.. _class_VisualShaderNodeVectorFunc_constant_FUNC_COS: + +.. _class_VisualShaderNodeVectorFunc_constant_FUNC_COSH: + +.. _class_VisualShaderNodeVectorFunc_constant_FUNC_DEGREES: + +.. _class_VisualShaderNodeVectorFunc_constant_FUNC_EXP: + +.. _class_VisualShaderNodeVectorFunc_constant_FUNC_EXP2: + +.. _class_VisualShaderNodeVectorFunc_constant_FUNC_FLOOR: + +.. _class_VisualShaderNodeVectorFunc_constant_FUNC_FRAC: + +.. _class_VisualShaderNodeVectorFunc_constant_FUNC_INVERSE_SQRT: + +.. _class_VisualShaderNodeVectorFunc_constant_FUNC_LOG: + +.. _class_VisualShaderNodeVectorFunc_constant_FUNC_LOG2: + +.. _class_VisualShaderNodeVectorFunc_constant_FUNC_RADIANS: + +.. _class_VisualShaderNodeVectorFunc_constant_FUNC_ROUND: + +.. _class_VisualShaderNodeVectorFunc_constant_FUNC_ROUNDEVEN: + +.. _class_VisualShaderNodeVectorFunc_constant_FUNC_SIGN: + +.. _class_VisualShaderNodeVectorFunc_constant_FUNC_SIN: + +.. _class_VisualShaderNodeVectorFunc_constant_FUNC_SINH: + +.. _class_VisualShaderNodeVectorFunc_constant_FUNC_SQRT: + +.. _class_VisualShaderNodeVectorFunc_constant_FUNC_TAN: + +.. _class_VisualShaderNodeVectorFunc_constant_FUNC_TANH: + +.. _class_VisualShaderNodeVectorFunc_constant_FUNC_TRUNC: + enum **Function**: - **FUNC_NORMALIZE** = **0** @@ -54,6 +110,62 @@ enum **Function**: - **FUNC_HSV2RGB** = **5** +- **FUNC_ABS** = **6** + +- **FUNC_ACOS** = **7** + +- **FUNC_ACOSH** = **8** + +- **FUNC_ASIN** = **9** + +- **FUNC_ASINH** = **10** + +- **FUNC_ATAN** = **11** + +- **FUNC_ATANH** = **12** + +- **FUNC_CEIL** = **13** + +- **FUNC_COS** = **14** + +- **FUNC_COSH** = **15** + +- **FUNC_DEGREES** = **16** + +- **FUNC_EXP** = **17** + +- **FUNC_EXP2** = **18** + +- **FUNC_FLOOR** = **19** + +- **FUNC_FRAC** = **20** + +- **FUNC_INVERSE_SQRT** = **21** + +- **FUNC_LOG** = **22** + +- **FUNC_LOG2** = **23** + +- **FUNC_RADIANS** = **24** + +- **FUNC_ROUND** = **25** + +- **FUNC_ROUNDEVEN** = **26** + +- **FUNC_SIGN** = **27** + +- **FUNC_SIN** = **28** + +- **FUNC_SINH** = **29** + +- **FUNC_SQRT** = **30** + +- **FUNC_TAN** = **31** + +- **FUNC_TANH** = **32** + +- **FUNC_TRUNC** = **33** + Property Descriptions --------------------- diff --git a/classes/class_visualshadernodevectorop.rst b/classes/class_visualshadernodevectorop.rst index e85a73a5e..461797b00 100644 --- a/classes/class_visualshadernodevectorop.rst +++ b/classes/class_visualshadernodevectorop.rst @@ -46,6 +46,12 @@ Enumerations .. _class_VisualShaderNodeVectorOp_constant_OP_CROSS: +.. _class_VisualShaderNodeVectorOp_constant_OP_ATAN2: + +.. _class_VisualShaderNodeVectorOp_constant_OP_REFLECT: + +.. _class_VisualShaderNodeVectorOp_constant_OP_STEP: + enum **Operator**: - **OP_ADD** = **0** @@ -66,6 +72,12 @@ enum **Operator**: - **OP_CROSS** = **8** +- **OP_ATAN2** = **9** + +- **OP_REFLECT** = **10** + +- **OP_STEP** = **11** + Property Descriptions --------------------- diff --git a/classes/class_visualshadernodevectorrefract.rst b/classes/class_visualshadernodevectorrefract.rst new file mode 100644 index 000000000..b0ba30a74 --- /dev/null +++ b/classes/class_visualshadernodevectorrefract.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeVectorRefract.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeVectorRefract: + +VisualShaderNodeVectorRefract +============================= + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_visualshadernodevectorscalarsmoothstep.rst b/classes/class_visualshadernodevectorscalarsmoothstep.rst new file mode 100644 index 000000000..1a7b4d2e6 --- /dev/null +++ b/classes/class_visualshadernodevectorscalarsmoothstep.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeVectorScalarSmoothStep.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeVectorScalarSmoothStep: + +VisualShaderNodeVectorScalarSmoothStep +====================================== + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_visualshadernodevectorscalarstep.rst b/classes/class_visualshadernodevectorscalarstep.rst new file mode 100644 index 000000000..91019e3ee --- /dev/null +++ b/classes/class_visualshadernodevectorscalarstep.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeVectorScalarStep.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeVectorScalarStep: + +VisualShaderNodeVectorScalarStep +================================ + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_visualshadernodevectorsmoothstep.rst b/classes/class_visualshadernodevectorsmoothstep.rst new file mode 100644 index 000000000..f2a87be8c --- /dev/null +++ b/classes/class_visualshadernodevectorsmoothstep.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the VisualShaderNodeVectorSmoothStep.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_VisualShaderNodeVectorSmoothStep: + +VisualShaderNodeVectorSmoothStep +================================ + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_vslider.rst b/classes/class_vslider.rst index 52a73c68e..052d514af 100644 --- a/classes/class_vslider.rst +++ b/classes/class_vslider.rst @@ -42,5 +42,5 @@ Theme Properties Description ----------- -Vertical slider. See :ref:`Slider`. This one goes from left (min) to right (max). +Vertical slider. See :ref:`Slider`. This one goes from bottom (min) to top (max). diff --git a/classes/class_vsplitcontainer.rst b/classes/class_vsplitcontainer.rst index 5c9c50699..e92e5a75f 100644 --- a/classes/class_vsplitcontainer.rst +++ b/classes/class_vsplitcontainer.rst @@ -32,5 +32,5 @@ Theme Properties Description ----------- -Vertical split container. See :ref:`SplitContainer`. This goes from left to right. +Vertical split container. See :ref:`SplitContainer`. This goes from top to bottom. diff --git a/classes/class_webrtcpeer.rst b/classes/class_webrtcpeer.rst new file mode 100644 index 000000000..51e466d98 --- /dev/null +++ b/classes/class_webrtcpeer.rst @@ -0,0 +1,144 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the WebRTCPeer.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_WebRTCPeer: + +WebRTCPeer +========== + +**Inherits:** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` + +**Inherited By:** :ref:`WebRTCPeerGDNative` + +**Category:** Core + +Brief Description +----------------- + + + +Properties +---------- + ++---------------------------------------------+---------------------------------------------------------+ +| :ref:`WriteMode` | :ref:`write_mode` | ++---------------------------------------------+---------------------------------------------------------+ + +Methods +------- + ++---------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`add_ice_candidate` **(** :ref:`String` media, :ref:`int` index, :ref:`String` name **)** | ++---------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`create_offer` **(** **)** | ++---------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ConnectionState` | :ref:`get_connection_state` **(** **)** const | ++---------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`poll` **(** **)** | ++---------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`set_local_description` **(** :ref:`String` type, :ref:`String` sdp **)** | ++---------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`set_remote_description` **(** :ref:`String` type, :ref:`String` sdp **)** | ++---------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`was_string_packet` **(** **)** const | ++---------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Signals +------- + +.. _class_WebRTCPeer_signal_new_ice_candidate: + +- **new_ice_candidate** **(** :ref:`String` media, :ref:`int` index, :ref:`String` name **)** + +.. _class_WebRTCPeer_signal_offer_created: + +- **offer_created** **(** :ref:`String` type, :ref:`String` sdp **)** + +Enumerations +------------ + +.. _enum_WebRTCPeer_WriteMode: + +.. _class_WebRTCPeer_constant_WRITE_MODE_TEXT: + +.. _class_WebRTCPeer_constant_WRITE_MODE_BINARY: + +enum **WriteMode**: + +- **WRITE_MODE_TEXT** = **0** + +- **WRITE_MODE_BINARY** = **1** + +.. _enum_WebRTCPeer_ConnectionState: + +.. _class_WebRTCPeer_constant_STATE_NEW: + +.. _class_WebRTCPeer_constant_STATE_CONNECTING: + +.. _class_WebRTCPeer_constant_STATE_CONNECTED: + +.. _class_WebRTCPeer_constant_STATE_DISCONNECTED: + +.. _class_WebRTCPeer_constant_STATE_FAILED: + +.. _class_WebRTCPeer_constant_STATE_CLOSED: + +enum **ConnectionState**: + +- **STATE_NEW** = **0** + +- **STATE_CONNECTING** = **1** + +- **STATE_CONNECTED** = **2** + +- **STATE_DISCONNECTED** = **3** + +- **STATE_FAILED** = **4** + +- **STATE_CLOSED** = **5** + +Property Descriptions +--------------------- + +.. _class_WebRTCPeer_property_write_mode: + +- :ref:`WriteMode` **write_mode** + ++----------+-----------------------+ +| *Setter* | set_write_mode(value) | ++----------+-----------------------+ +| *Getter* | get_write_mode() | ++----------+-----------------------+ + +Method Descriptions +------------------- + +.. _class_WebRTCPeer_method_add_ice_candidate: + +- :ref:`Error` **add_ice_candidate** **(** :ref:`String` media, :ref:`int` index, :ref:`String` name **)** + +.. _class_WebRTCPeer_method_create_offer: + +- :ref:`Error` **create_offer** **(** **)** + +.. _class_WebRTCPeer_method_get_connection_state: + +- :ref:`ConnectionState` **get_connection_state** **(** **)** const + +.. _class_WebRTCPeer_method_poll: + +- :ref:`Error` **poll** **(** **)** + +.. _class_WebRTCPeer_method_set_local_description: + +- :ref:`Error` **set_local_description** **(** :ref:`String` type, :ref:`String` sdp **)** + +.. _class_WebRTCPeer_method_set_remote_description: + +- :ref:`Error` **set_remote_description** **(** :ref:`String` type, :ref:`String` sdp **)** + +.. _class_WebRTCPeer_method_was_string_packet: + +- :ref:`bool` **was_string_packet** **(** **)** const + diff --git a/classes/class_webrtcpeergdnative.rst b/classes/class_webrtcpeergdnative.rst new file mode 100644 index 000000000..24ec077d7 --- /dev/null +++ b/classes/class_webrtcpeergdnative.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the WebRTCPeerGDNative.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_WebRTCPeerGDNative: + +WebRTCPeerGDNative +================== + +**Inherits:** :ref:`WebRTCPeer` **<** :ref:`PacketPeer` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_ysort.rst b/classes/class_ysort.rst index 284f130d2..61f762996 100644 --- a/classes/class_ysort.rst +++ b/classes/class_ysort.rst @@ -28,6 +28,8 @@ Description Sort all child nodes based on their Y positions. The child node must inherit from :ref:`CanvasItem` for it to be sorted. Nodes that have a higher Y position will be drawn later, so they will appear on top of nodes that have a lower Y position. +Nesting of YSort nodes is possible. Children YSort nodes will be sorted in the same space as the parent YSort, allowing to better organize a scene or divide it in multiple ones, yet keep the unique sorting. + Property Descriptions ---------------------