diff --git a/classes/class_@gdscript.rst b/classes/class_@gdscript.rst index 386d67ab7..9a431e2e6 100644 --- a/classes/class_@gdscript.rst +++ b/classes/class_@gdscript.rst @@ -309,7 +309,7 @@ Returns the arc tangent of ``y/x`` in radians. Use to get the angle of tangent ` :: - a = atan(0,-1) # a is 3.141593 + a = atan(0, -1) # a is 3.141593 .. _class_@GDScript_bytes2var: @@ -345,7 +345,7 @@ Returns a character as a String of the given ASCII code. # a is 'A' a = char(65) # a is 'a' - a = char(65+32) + a = char(65 + 32) .. _class_@GDScript_clamp: @@ -388,7 +388,7 @@ Returns the cosine of angle ``s`` in radians. :: # prints 1 and -1 - print(cos(PI*2)) + print(cos(PI * 2)) print(cos(PI)) .. _class_@GDScript_cosh: @@ -668,7 +668,7 @@ Returns the maximum of two values. :: - max(1,2) # returns 2 + max(1, 2) # returns 2 max(-3.99, -4) # returns -3.99 .. _class_@GDScript_min: @@ -679,7 +679,7 @@ Returns the minimum of two values. :: - min(1,2) # returns 1 + min(1, 2) # returns 1 min(-3.99, -4) # returns -4 .. _class_@GDScript_nearest_po2: @@ -726,7 +726,7 @@ Returns the result of ``x`` raised to the power of ``y``. :: - pow(2,5) # returns 32 + pow(2, 5) # returns 32 .. _class_@GDScript_preload: @@ -749,8 +749,8 @@ Converts one or more arguments to strings in the best way possible and prints th :: - a = [1,2,3] - print("a","b",a) # prints ab[1, 2, 3] + a = [1, 2, 3] + print("a", "b", a) # prints ab[1, 2, 3] .. _class_@GDScript_print_debug: @@ -814,10 +814,22 @@ Prints one or more arguments to the console with a tab between each argument. - void **push_error** **(** :ref:`String` message **)** +Pushes an error message to Godot's built-in debugger and to the OS terminal. + +:: + + push_error("test error") # prints "test error" to debugger and terminal as error call + .. _class_@GDScript_push_warning: - void **push_warning** **(** :ref:`String` message **)** +Pushes a warning message to Godot's built-in debugger and to the OS terminal. + +:: + + push_warning("test warning") # prints "test warning" to debugger and terminal as warning call + .. _class_@GDScript_rad2deg: - :ref:`float` **rad2deg** **(** :ref:`float` rad **)** @@ -1022,7 +1034,7 @@ Returns the tangent of angle ``s`` in radians. :: - tan( deg2rad(45) ) # returns 1 + tan(deg2rad(45)) # returns 1 .. _class_@GDScript_tanh: diff --git a/classes/class_acceptdialog.rst b/classes/class_acceptdialog.rst index 0bfc6ce1f..cdc9a8466 100644 --- a/classes/class_acceptdialog.rst +++ b/classes/class_acceptdialog.rst @@ -75,7 +75,7 @@ Property Descriptions | *Getter* | get_hide_on_ok() | +----------+-----------------------+ -If ``true`` the dialog is hidden when the OK button is pressed. You can set it to ``false`` if you want to do e.g. input validation when receiving the :ref:`confirmed` signal, and handle hiding the dialog in your own logic. Default value: ``true``. +If ``true``, the dialog is hidden when the OK button is pressed. You can set it to ``false`` if you want to do e.g. input validation when receiving the :ref:`confirmed` signal, and handle hiding the dialog in your own logic. Default value: ``true``. Note: Some nodes derived from this class can have a different default value, and potentially their own built-in logic overriding this setting. For example :ref:`FileDialog` defaults to ``false``, and has its own input validation code that is called when you press OK, which eventually hides the dialog if the input is valid. As such this property can't be used in :ref:`FileDialog` to disable hiding the dialog when pressing OK. diff --git a/classes/class_animatedsprite.rst b/classes/class_animatedsprite.rst index bb33ae210..41c2f42d4 100644 --- a/classes/class_animatedsprite.rst +++ b/classes/class_animatedsprite.rst @@ -95,7 +95,7 @@ The current animation from the ``frames`` resource. If this value changes, the ` | *Getter* | is_centered() | +----------+---------------------+ -If ``true`` texture will be centered. Default value: ``true``. +If ``true``, texture will be centered. Default value: ``true``. .. _class_AnimatedSprite_flip_h: @@ -107,7 +107,7 @@ If ``true`` texture will be centered. Default value: ``true``. | *Getter* | is_flipped_h() | +----------+-------------------+ -If ``true`` texture is flipped horizontally. Default value: ``false``. +If ``true``, texture is flipped horizontally. Default value: ``false``. .. _class_AnimatedSprite_flip_v: @@ -119,7 +119,7 @@ If ``true`` texture is flipped horizontally. Default value: ``false``. | *Getter* | is_flipped_v() | +----------+-------------------+ -If ``true`` texture is flipped vertically. Default value: ``false``. +If ``true``, texture is flipped vertically. Default value: ``false``. .. _class_AnimatedSprite_frame: @@ -161,7 +161,7 @@ The texture's drawing offset. - :ref:`bool` **playing** -If ``true`` the :ref:`animation` is currently playing. +If ``true``, the :ref:`animation` is currently playing. .. _class_AnimatedSprite_speed_scale: diff --git a/classes/class_animatedsprite3d.rst b/classes/class_animatedsprite3d.rst index 551d75a45..2ace1ae66 100644 --- a/classes/class_animatedsprite3d.rst +++ b/classes/class_animatedsprite3d.rst @@ -97,7 +97,7 @@ The :ref:`SpriteFrames` resource containing the animation(s) - :ref:`bool` **playing** -If ``true`` the :ref:`animation` is currently playing. +If ``true``, the :ref:`animation` is currently playing. Method Descriptions ------------------- diff --git a/classes/class_animation.rst b/classes/class_animation.rst index d1d98f927..2236c665a 100644 --- a/classes/class_animation.rst +++ b/classes/class_animation.rst @@ -487,7 +487,7 @@ Set the given track as imported or not. - void **track_set_interpolation_loop_wrap** **(** :ref:`int` idx, :ref:`bool` interpolation **)** -If ``true`` the track at ``idx`` wraps the interpolation loop. +If ``true``, the track at ``idx`` wraps the interpolation loop. .. _class_Animation_track_set_interpolation_type: diff --git a/classes/class_animationtreeplayer.rst b/classes/class_animationtreeplayer.rst index 12a8ce197..fbdc4a083 100644 --- a/classes/class_animationtreeplayer.rst +++ b/classes/class_animationtreeplayer.rst @@ -203,7 +203,7 @@ Property Descriptions | *Getter* | is_active() | +----------+-------------------+ -If ``true`` the ``AnimationTreePlayer`` is able to play animations. Default value: ``false``. +If ``true``, the ``AnimationTreePlayer`` is able to play animations. Default value: ``false``. .. _class_AnimationTreePlayer_base_path: diff --git a/classes/class_area.rst b/classes/class_area.rst index f1a65be41..05c1c9b66 100644 --- a/classes/class_area.rst +++ b/classes/class_area.rst @@ -188,7 +188,7 @@ The name of the area's audio bus. | *Getter* | is_overriding_audio_bus() | +----------+-------------------------------+ -If ``true`` the area's audio bus overrides the default audio bus. Default value: ``false``. +If ``true``, the area's audio bus overrides the default audio bus. Default value: ``false``. .. _class_Area_collision_layer: @@ -248,7 +248,7 @@ The falloff factor for point gravity. The greater the value, the faster gravity | *Getter* | is_gravity_a_point() | +----------+-----------------------------+ -If ``true`` gravity is calculated from a point (set via ``gravity_vec``). Also see ``space_override``. Default value: ``false``. +If ``true``, gravity is calculated from a point (set via ``gravity_vec``). Also see ``space_override``. Default value: ``false``. .. _class_Area_gravity_vec: @@ -284,7 +284,7 @@ The rate at which objects stop moving in this area. Represents the linear veloci | *Getter* | is_monitorable() | +----------+------------------------+ -If ``true`` other monitoring areas can detect this area. Default value: ``true``. +If ``true``, other monitoring areas can detect this area. Default value: ``true``. .. _class_Area_monitoring: @@ -296,7 +296,7 @@ If ``true`` other monitoring areas can detect this area. Default value: ``true`` | *Getter* | is_monitoring() | +----------+-----------------------+ -If ``true`` the area detects bodies or areas entering and exiting it. Default value: ``true``. +If ``true``, the area detects bodies or areas entering and exiting it. Default value: ``true``. .. _class_Area_priority: @@ -332,7 +332,7 @@ The degree to which this area applies reverb to its associated audio. Ranges fro | *Getter* | is_using_reverb_bus() | +----------+---------------------------+ -If ``true`` the area applies reverb to its associated audio. +If ``true``, the area applies reverb to its associated audio. .. _class_Area_reverb_bus_name: @@ -401,13 +401,13 @@ Returns a list of intersecting :ref:`PhysicsBody`\ s. For per - :ref:`bool` **overlaps_area** **(** :ref:`Node` area **)** const -If ``true`` the given area overlaps the Area. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. +If ``true``, the given area overlaps the Area. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. .. _class_Area_overlaps_body: - :ref:`bool` **overlaps_body** **(** :ref:`Node` body **)** const -If ``true`` the given body overlaps the Area. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. +If ``true``, the given body overlaps the Area. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. .. _class_Area_set_collision_layer_bit: diff --git a/classes/class_area2d.rst b/classes/class_area2d.rst index 6ac4a4587..54bfa93e7 100644 --- a/classes/class_area2d.rst +++ b/classes/class_area2d.rst @@ -180,7 +180,7 @@ The name of the area's audio bus. | *Getter* | is_overriding_audio_bus() | +----------+-------------------------------+ -If ``true`` the area's audio bus overrides the default audio bus. Default value: ``false``. +If ``true``, the area's audio bus overrides the default audio bus. Default value: ``false``. .. _class_Area2D_collision_layer: @@ -240,7 +240,7 @@ The falloff factor for point gravity. The greater the value, the faster gravity | *Getter* | is_gravity_a_point() | +----------+-----------------------------+ -If ``true`` gravity is calculated from a point (set via ``gravity_vec``). Also see ``space_override``. Default value: ``false``. +If ``true``, gravity is calculated from a point (set via ``gravity_vec``). Also see ``space_override``. Default value: ``false``. .. _class_Area2D_gravity_vec: @@ -276,7 +276,7 @@ The rate at which objects stop moving in this area. Represents the linear veloci | *Getter* | is_monitorable() | +----------+------------------------+ -If ``true`` other monitoring areas can detect this area. Default value: ``true``. +If ``true``, other monitoring areas can detect this area. Default value: ``true``. .. _class_Area2D_monitoring: @@ -288,7 +288,7 @@ If ``true`` other monitoring areas can detect this area. Default value: ``true`` | *Getter* | is_monitoring() | +----------+-----------------------+ -If ``true`` the area detects bodies or areas entering and exiting it. Default value: ``true``. +If ``true``, the area detects bodies or areas entering and exiting it. Default value: ``true``. .. _class_Area2D_priority: @@ -345,13 +345,13 @@ Returns a list of intersecting :ref:`PhysicsBody2D`\ s. For - :ref:`bool` **overlaps_area** **(** :ref:`Node` area **)** const -If ``true`` the given area overlaps the Area2D. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. +If ``true``, the given area overlaps the Area2D. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. .. _class_Area2D_overlaps_body: - :ref:`bool` **overlaps_body** **(** :ref:`Node` body **)** const -If ``true`` the given body overlaps the Area2D. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. +If ``true``, the given body overlaps the Area2D. Note that the result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead. .. _class_Area2D_set_collision_layer_bit: diff --git a/classes/class_array.rst b/classes/class_array.rst index 3b827f64b..a5faf105c 100644 --- a/classes/class_array.rst +++ b/classes/class_array.rst @@ -234,10 +234,10 @@ Return true if the array contains given value. :: - [ "inside", 7 ].has("inside") == true - [ "inside", 7 ].has("outside") == false - [ "inside", 7 ].has(7) == true - [ "inside", 7 ].has("7") == false + ["inside", 7].has("inside") == true + ["inside", 7].has("outside") == false + ["inside", 7].has(7) == true + ["inside", 7].has("7") == false .. _class_Array_hash: diff --git a/classes/class_arraymesh.rst b/classes/class_arraymesh.rst index 13339d394..4d46aa117 100644 --- a/classes/class_arraymesh.rst +++ b/classes/class_arraymesh.rst @@ -132,9 +132,9 @@ The ``ArrayMesh`` is used to construct a :ref:`Mesh` by specifying t :: var vertices = PoolVector3Array() - vertices.push_back(Vector3(0,1,0)) - vertices.push_back(Vector3(1,0,0)) - vertices.push_back(Vector3(0,0,1)) + vertices.push_back(Vector3(0, 1, 0)) + vertices.push_back(Vector3(1, 0, 0)) + vertices.push_back(Vector3(0, 0, 1)) # Initialize the ArrayMesh. var arr_mesh = ArrayMesh.new() var arrays = [] diff --git a/classes/class_astar.rst b/classes/class_astar.rst index 481ec663e..6e12cf9b3 100644 --- a/classes/class_astar.rst +++ b/classes/class_astar.rst @@ -92,8 +92,7 @@ Adds a new point at the given position with the given identifier. The algorithm :: var as = AStar.new() - - as.add_point(1, Vector3(1,0,0), 4) # Adds the point (1,0,0) with weight_scale=4 and id=1 + as.add_point(1, Vector3(1, 0, 0), 4) # Adds the point (1, 0, 0) with weight_scale 4 and id 1 If there already exists a point for the given id, its position and weight scale are updated to the given values. @@ -113,17 +112,14 @@ Clears all the points and segments. - void **connect_points** **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** -Creates a segment between the given points. +Creates a segment between the given points. If ``bidirectional`` is ``false``, only movement from ``id`` to ``to_id`` is allowed, not the reverse direction. :: var as = AStar.new() - - as.add_point(1, Vector3(1,1,0)) - as.add_point(2, Vector3(0,5,0)) - - as.connect_points(1, 2, false) # If bidirectional=false it's only possible to go from point 1 to point 2 - # and not from point 2 to point 1. + as.add_point(1, Vector3(1, 1, 0)) + as.add_point(2, Vector3(0, 5, 0)) + as.connect_points(1, 2, false) .. _class_AStar_disconnect_points: @@ -152,15 +148,12 @@ Returns the closest position to ``to_position`` that resides inside a segment be :: var as = AStar.new() - - as.add_point(1, Vector3(0,0,0)) - as.add_point(2, Vector3(0,5,0)) - + as.add_point(1, Vector3(0, 0, 0)) + as.add_point(2, Vector3(0, 5, 0)) as.connect_points(1, 2) - - var res = as.get_closest_position_in_segment(Vector3(3,3,0)) # returns (0, 3, 0) + var res = as.get_closest_position_in_segment(Vector3(3, 3, 0)) # returns (0, 3, 0) -The result is in the segment that goes from ``y=0`` to ``y=5``. It's the closest position in the segment to the given point. +The result is in the segment that goes from ``y = 0`` to ``y = 5``. It's the closest position in the segment to the given point. .. _class_AStar_get_id_path: @@ -171,11 +164,10 @@ Returns an array with the ids of the points that form the path found by AStar be :: var as = AStar.new() - - as.add_point(1, Vector3(0,0,0)) - as.add_point(2, Vector3(0,1,0), 1) # default weight is 1 - as.add_point(3, Vector3(1,1,0)) - as.add_point(4, Vector3(2,0,0)) + as.add_point(1, Vector3(0, 0, 0)) + as.add_point(2, Vector3(0, 1, 0), 1) # default weight is 1 + as.add_point(3, Vector3(1, 1, 0)) + as.add_point(4, Vector3(2, 0, 0)) as.connect_points(1, 2, false) as.connect_points(2, 3, false) @@ -196,11 +188,10 @@ Returns an array with the ids of the points that form the connect with the given :: var as = AStar.new() - - as.add_point(1, Vector3(0,0,0)) - as.add_point(2, Vector3(0,1,0)) - as.add_point(3, Vector3(1,1,0)) - as.add_point(4, Vector3(2,0,0)) + as.add_point(1, Vector3(0, 0, 0)) + as.add_point(2, Vector3(0, 1, 0)) + as.add_point(3, Vector3(1, 1, 0)) + as.add_point(4, Vector3(2, 0, 0)) as.connect_points(1, 2, true) as.connect_points(1, 3, true) diff --git a/classes/class_atlastexture.rst b/classes/class_atlastexture.rst index effdff829..478f8e461 100644 --- a/classes/class_atlastexture.rst +++ b/classes/class_atlastexture.rst @@ -61,7 +61,7 @@ The texture that contains the atlas. Can be any :ref:`Texture` su | *Getter* | has_filter_clip() | +----------+------------------------+ -If ``true`` clips the area outside of the region to avoid bleeding of the surrounding texture pixels. +If ``true``, clips the area outside of the region to avoid bleeding of the surrounding texture pixels. .. _class_AtlasTexture_margin: diff --git a/classes/class_audioeffect.rst b/classes/class_audioeffect.rst index ef247e644..16cca9a0b 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:`AudioEffectCompressor`, :ref:`AudioEffectLimiter`, :ref:`AudioEffectAmplify`, :ref:`AudioEffectFilter`, :ref:`AudioEffectDistortion`, :ref:`AudioEffectDelay`, :ref:`AudioEffectStereoEnhance`, :ref:`AudioEffectReverb`, :ref:`AudioEffectPanner`, :ref:`AudioEffectEQ`, :ref:`AudioEffectPitchShift`, :ref:`AudioEffectRecord`, :ref:`AudioEffectChorus`, :ref:`AudioEffectPhaser` +**Inherited By:** :ref:`AudioEffectCompressor`, :ref:`AudioEffectLimiter`, :ref:`AudioEffectAmplify`, :ref:`AudioEffectFilter`, :ref:`AudioEffectDistortion`, :ref:`AudioEffectDelay`, :ref:`AudioEffectStereoEnhance`, :ref:`AudioEffectReverb`, :ref:`AudioEffectPanner`, :ref:`AudioEffectEQ`, :ref:`AudioEffectRecord`, :ref:`AudioEffectChorus`, :ref:`AudioEffectPitchShift`, :ref:`AudioEffectPhaser` **Category:** Core diff --git a/classes/class_audioeffectdelay.rst b/classes/class_audioeffectdelay.rst index e896816ea..06cb4a2ec 100644 --- a/classes/class_audioeffectdelay.rst +++ b/classes/class_audioeffectdelay.rst @@ -79,7 +79,7 @@ Output percent of original sound. At 0, only delayed sounds are output. Value ca | *Getter* | is_feedback_active() | +----------+----------------------------+ -If ``true`` feedback is enabled. Default value: ``false``. +If ``true``, feedback is enabled. Default value: ``false``. .. _class_AudioEffectDelay_feedback/delay_ms: diff --git a/classes/class_audioserver.rst b/classes/class_audioserver.rst index 2291342c3..64b98ce20 100644 --- a/classes/class_audioserver.rst +++ b/classes/class_audioserver.rst @@ -32,6 +32,8 @@ Methods +---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :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 **)** | @@ -166,6 +168,12 @@ Adds an :ref:`AudioEffect` effect to the bus ``bus_idx`` at ` Generates an :ref:`AudioBusLayout` using the available busses and effects. +.. _class_AudioServer_get_bus_channels: + +- :ref:`int` **get_bus_channels** **(** :ref:`int` bus_idx **)** const + +Returns the amount of channels of the bus at index ``bus_idx``. + .. _class_AudioServer_get_bus_count: - :ref:`int` **get_bus_count** **(** **)** const @@ -244,25 +252,25 @@ Returns the speaker configuration. - :ref:`bool` **is_bus_bypassing_effects** **(** :ref:`int` bus_idx **)** const -If ``true`` the bus at index ``bus_idx`` is bypassing effects. +If ``true``, the bus at index ``bus_idx`` is bypassing effects. .. _class_AudioServer_is_bus_effect_enabled: - :ref:`bool` **is_bus_effect_enabled** **(** :ref:`int` bus_idx, :ref:`int` effect_idx **)** const -If ``true`` the effect at index ``effect_idx`` on the bus at index ``bus_idx`` is enabled. +If ``true``, the effect at index ``effect_idx`` on the bus at index ``bus_idx`` is enabled. .. _class_AudioServer_is_bus_mute: - :ref:`bool` **is_bus_mute** **(** :ref:`int` bus_idx **)** const -If ``true`` the bus at index ``bus_idx`` is muted. +If ``true``, the bus at index ``bus_idx`` is muted. .. _class_AudioServer_is_bus_solo: - :ref:`bool` **is_bus_solo** **(** :ref:`int` bus_idx **)** const -If ``true`` the bus at index ``bus_idx`` is in solo mode. +If ``true``, the bus at index ``bus_idx`` is in solo mode. .. _class_AudioServer_lock: @@ -292,7 +300,7 @@ Removes the effect at index ``effect_idx`` from the bus at index ``bus_idx``. - void **set_bus_bypass_effects** **(** :ref:`int` bus_idx, :ref:`bool` enable **)** -If ``true`` the bus at index ``bus_idx`` is bypassing effects. +If ``true``, the bus at index ``bus_idx`` is bypassing effects. .. _class_AudioServer_set_bus_count: @@ -304,7 +312,7 @@ Adds and removes busses to make the number of busses match ``amount``. - void **set_bus_effect_enabled** **(** :ref:`int` bus_idx, :ref:`int` effect_idx, :ref:`bool` enabled **)** -If ``true`` the effect at index ``effect_idx`` on the bus at index ``bus_idx`` is enabled. +If ``true``, the effect at index ``effect_idx`` on the bus at index ``bus_idx`` is enabled. .. _class_AudioServer_set_bus_layout: @@ -316,7 +324,7 @@ Overwrites the currently used :ref:`AudioBusLayout`. - void **set_bus_mute** **(** :ref:`int` bus_idx, :ref:`bool` enable **)** -If ``true`` the bus at index ``bus_idx`` is muted. +If ``true``, the bus at index ``bus_idx`` is muted. .. _class_AudioServer_set_bus_name: @@ -334,7 +342,7 @@ Connects the output of the bus at ``bus_idx`` to the bus named ``send``. - void **set_bus_solo** **(** :ref:`int` bus_idx, :ref:`bool` enable **)** -If ``true`` the bus at index ``bus_idx`` is in solo mode. +If ``true``, the bus at index ``bus_idx`` is in solo mode. .. _class_AudioServer_set_bus_volume_db: diff --git a/classes/class_audiostreamplayer.rst b/classes/class_audiostreamplayer.rst index 58164d2a0..4a2123676 100644 --- a/classes/class_audiostreamplayer.rst +++ b/classes/class_audiostreamplayer.rst @@ -97,7 +97,7 @@ Property Descriptions | *Getter* | is_autoplay_enabled() | +----------+-----------------------+ -If ``true`` audio plays when added to scene tree. Default value: ``false``. +If ``true``, audio plays when added to scene tree. Default value: ``false``. .. _class_AudioStreamPlayer_bus: @@ -143,7 +143,7 @@ Changes the pitch and the tempo of the audio. | *Getter* | is_playing() | +----------+--------------+ -If ``true`` audio is playing. +If ``true``, audio is playing. .. _class_AudioStreamPlayer_stream: diff --git a/classes/class_audiostreamplayer2d.rst b/classes/class_audiostreamplayer2d.rst index 9e30bba8e..ac3f5c916 100644 --- a/classes/class_audiostreamplayer2d.rst +++ b/classes/class_audiostreamplayer2d.rst @@ -112,7 +112,7 @@ Dampens audio over distance with this as an exponent. | *Getter* | is_autoplay_enabled() | +----------+-----------------------+ -If ``true`` audio plays when added to scene tree. Default value: ``false``. +If ``true``, audio plays when added to scene tree. Default value: ``false``. .. _class_AudioStreamPlayer2D_bus: @@ -158,7 +158,7 @@ Changes the pitch and the tempo of the audio. | *Getter* | is_playing() | +----------+--------------+ -If ``true`` audio is playing. +If ``true``, audio is playing. .. _class_AudioStreamPlayer2D_stream: diff --git a/classes/class_audiostreamplayer3d.rst b/classes/class_audiostreamplayer3d.rst index 915ba87f3..51c57ccfb 100644 --- a/classes/class_audiostreamplayer3d.rst +++ b/classes/class_audiostreamplayer3d.rst @@ -185,7 +185,7 @@ Decides if audio should get quieter with distance linearly, quadratically or log | *Getter* | is_autoplay_enabled() | +----------+-----------------------+ -If ``true`` audio plays when added to scene tree. Default value: ``false``. +If ``true``, audio plays when added to scene tree. Default value: ``false``. .. _class_AudioStreamPlayer3D_bus: @@ -233,7 +233,7 @@ The angle in which the audio reaches cameras undampened. | *Getter* | is_emission_angle_enabled() | +----------+-----------------------------------+ -If ``true`` the audio should be dampened according to the direction of the sound. +If ``true``, the audio should be dampened according to the direction of the sound. .. _class_AudioStreamPlayer3D_emission_angle_filter_attenuation_db: diff --git a/classes/class_audiostreamsample.rst b/classes/class_audiostreamsample.rst index 587769ff6..83c9cd866 100644 --- a/classes/class_audiostreamsample.rst +++ b/classes/class_audiostreamsample.rst @@ -55,6 +55,8 @@ enum **LoopMode**: - **LOOP_PING_PONG** = **2** --- Audio loops the data between loop_begin and loop_end playing back and forth. +- **LOOP_BACKWARD** = **3** --- Audio loops the data between loop_begin and loop_end playing backward only. + .. _enum_AudioStreamSample_Format: enum **Format**: diff --git a/classes/class_bakedlightmap.rst b/classes/class_bakedlightmap.rst index 7447306ab..bd9b2fc82 100644 --- a/classes/class_bakedlightmap.rst +++ b/classes/class_bakedlightmap.rst @@ -142,7 +142,7 @@ Size of affected area. | *Getter* | is_hdr() | +----------+----------------+ -If ``true`` lightmap can capture light values greater than ``1.0``. Turning this off will result in a smaller lightmap. Default value:``false``. +If ``true``, lightmap can capture light values greater than ``1.0``. Turning this off will result in a smaller lightmap. Default value:``false``. .. _class_BakedLightmap_bake_mode: diff --git a/classes/class_basebutton.rst b/classes/class_basebutton.rst index aec1ee69c..4119cbbd3 100644 --- a/classes/class_basebutton.rst +++ b/classes/class_basebutton.rst @@ -150,7 +150,7 @@ To allow both left-click and right-click, set this to 3, because it's BUTTON_MAS | *Getter* | is_disabled() | +----------+---------------------+ -If ``true`` the button is in disabled state and can't be clicked or toggled. +If ``true``, the button is in disabled state and can't be clicked or toggled. .. _class_BaseButton_enabled_focus_mode: @@ -186,7 +186,7 @@ Focus access mode to use when switching between enabled/disabled (see :ref:`Cont | *Getter* | is_pressed() | +----------+--------------------+ -If ``true`` the button's state is pressed. Means the button is pressed down or toggled (if toggle_mode is active). +If ``true``, the button's state is pressed. Means the button is pressed down or toggled (if toggle_mode is active). .. _class_BaseButton_shortcut: @@ -210,7 +210,7 @@ Shortcut associated to the button. | *Getter* | is_shortcut_in_tooltip_enabled() | +----------+----------------------------------+ -If ``true`` the button will add information about its shortcut in the tooltip. +If ``true``, the button will add information about its shortcut in the tooltip. .. _class_BaseButton_toggle_mode: @@ -222,7 +222,7 @@ If ``true`` the button will add information about its shortcut in the tooltip. | *Getter* | is_toggle_mode() | +----------+------------------------+ -If ``true`` the button is in toggle mode. Makes the button flip state between pressed and unpressed each time its area is clicked. +If ``true``, the button is in toggle mode. Makes the button flip state between pressed and unpressed each time its area is clicked. Method Descriptions ------------------- diff --git a/classes/class_bitmap.rst b/classes/class_bitmap.rst index 13a784fdb..f1b57e90c 100644 --- a/classes/class_bitmap.rst +++ b/classes/class_bitmap.rst @@ -36,7 +36,7 @@ Methods +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_bit` **(** :ref:`Vector2` position, :ref:`bool` bit **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bit_rect` **(** :ref:`Rect2` p_rect, :ref:`bool` bit **)** | +| void | :ref:`set_bit_rect` **(** :ref:`Rect2` rect, :ref:`bool` bit **)** | +--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ Description @@ -93,7 +93,7 @@ Sets the bitmap's element at the specified position, to the specified value. .. _class_BitMap_set_bit_rect: -- void **set_bit_rect** **(** :ref:`Rect2` p_rect, :ref:`bool` bit **)** +- void **set_bit_rect** **(** :ref:`Rect2` rect, :ref:`bool` bit **)** Sets a rectangular portion of the bitmap to the specified value. diff --git a/classes/class_bitmapfont.rst b/classes/class_bitmapfont.rst index 789f570f7..668248c0a 100644 --- a/classes/class_bitmapfont.rst +++ b/classes/class_bitmapfont.rst @@ -82,7 +82,7 @@ Ascent (number of pixels above the baseline). | *Getter* | is_distance_field_hint() | +----------+--------------------------------+ -If ``true`` distance field hint is enabled. +If ``true``, distance field hint is enabled. .. _class_BitmapFont_fallback: diff --git a/classes/class_buttongroup.rst b/classes/class_buttongroup.rst index 0e8dc04a9..f3dd1a43a 100644 --- a/classes/class_buttongroup.rst +++ b/classes/class_buttongroup.rst @@ -19,17 +19,12 @@ Group of Buttons. Methods ------- ++--------------------------------------+-----------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_buttons` **(** **)** | +--------------------------------------+-----------------------------------------------------------------------------+ | :ref:`BaseButton` | :ref:`get_pressed_button` **(** **)** | +--------------------------------------+-----------------------------------------------------------------------------+ -Theme Properties ----------------- - -+---------------------------------+---------------------------------------+ -| :ref:`StyleBox` | :ref:`panel` | -+---------------------------------+---------------------------------------+ - Description ----------- @@ -40,9 +35,15 @@ Group of :ref:`Button`. All direct and indirect children buttons b Method Descriptions ------------------- +.. _class_ButtonGroup_get_buttons: + +- :ref:`Array` **get_buttons** **(** **)** + +Returns an :ref:`Array` of :ref:`Button`\ s who have this as their ``ButtonGroup`` (see :ref:`BaseButton.group`). + .. _class_ButtonGroup_get_pressed_button: - :ref:`BaseButton` **get_pressed_button** **(** **)** -Return the pressed button. +Returns the current pressed button. diff --git a/classes/class_camera.rst b/classes/class_camera.rst index 140e60442..964db363d 100644 --- a/classes/class_camera.rst +++ b/classes/class_camera.rst @@ -137,7 +137,7 @@ The culling mask that describes which 3D render layers are rendered by this came | *Getter* | is_current() | +----------+--------------------+ -If ``true`` the ancestor :ref:`Viewport` is currently using this Camera. Default value: ``false``. +If ``true``, the ancestor :ref:`Viewport` is currently using this Camera. Default value: ``false``. .. _class_Camera_doppler_tracking: diff --git a/classes/class_camera2d.rst b/classes/class_camera2d.rst index de25ba1ee..5ad159a75 100644 --- a/classes/class_camera2d.rst +++ b/classes/class_camera2d.rst @@ -129,7 +129,7 @@ The Camera2D's anchor point. See ``ANCHOR_MODE_*`` constants. | *Getter* | is_current() | +----------+--------------+ -If ``true`` the camera is the active camera for the current scene. Only one camera can be current, so setting a different camera ``current`` will disable this one. +If ``true``, the camera is the active camera for the current scene. Only one camera can be current, so setting a different camera ``current`` will disable this one. .. _class_Camera2D_custom_viewport: @@ -165,7 +165,7 @@ Bottom margin needed to drag the camera. A value of ``1`` makes the camera move | *Getter* | is_h_drag_enabled() | +----------+---------------------------+ -If ``true`` the camera only moves when reaching the horizontal drag margins. If ``false`` the camera moves horizontally regardless of margins. Default value: ``true``. +If ``true``, the camera only moves when reaching the horizontal drag margins. If ``false``, the camera moves horizontally regardless of margins. Default value: ``true``. .. _class_Camera2D_drag_margin_left: @@ -213,7 +213,7 @@ Top margin needed to drag the camera. A value of ``1`` makes the camera move onl | *Getter* | is_v_drag_enabled() | +----------+---------------------------+ -If ``true`` the camera only moves when reaching the vertical drag margins. If ``false`` the camera moves vertically regardless of margins. Default value: ``true``. +If ``true``, the camera only moves when reaching the vertical drag margins. If ``false``, the camera moves vertically regardless of margins. Default value: ``true``. .. _class_Camera2D_editor_draw_drag_margin: @@ -225,7 +225,7 @@ If ``true`` the camera only moves when reaching the vertical drag margins. If `` | *Getter* | is_margin_drawing_enabled() | +----------+-----------------------------------+ -If ``true`` draws the camera's drag margin rectangle in the editor. Default value: ``false`` +If ``true``, draws the camera's drag margin rectangle in the editor. Default value: ``false`` .. _class_Camera2D_editor_draw_limits: @@ -237,7 +237,7 @@ If ``true`` draws the camera's drag margin rectangle in the editor. Default valu | *Getter* | is_limit_drawing_enabled() | +----------+----------------------------------+ -If ``true`` draws the camera's limits rectangle in the editor. Default value: ``true`` +If ``true``, draws the camera's limits rectangle in the editor. Default value: ``true`` .. _class_Camera2D_editor_draw_screen: @@ -249,7 +249,7 @@ If ``true`` draws the camera's limits rectangle in the editor. Default value: `` | *Getter* | is_screen_drawing_enabled() | +----------+-----------------------------------+ -If ``true`` draws the camera's screen rectangle in the editor. Default value: ``false`` +If ``true``, draws the camera's screen rectangle in the editor. Default value: ``false`` .. _class_Camera2D_limit_bottom: @@ -297,7 +297,7 @@ Right scroll limit in pixels. The camera stops moving when reaching this value. | *Getter* | is_limit_smoothing_enabled() | +----------+------------------------------------+ -If ``true`` the camera smoothly stops when reaches its limits. Default value: ``false`` +If ``true``, the camera smoothly stops when reaches its limits. Default value: ``false`` .. _class_Camera2D_limit_top: @@ -357,7 +357,7 @@ The vertical offset of the camera, relative to the drag margins. Default value: | *Getter* | is_rotating() | +----------+---------------------+ -If ``true`` the camera rotates with the target. Default value: ``false`` +If ``true``, the camera rotates with the target. Default value: ``false`` .. _class_Camera2D_smoothing_enabled: @@ -369,7 +369,7 @@ If ``true`` the camera rotates with the target. Default value: ``false`` | *Getter* | is_follow_smoothing_enabled() | +----------+------------------------------------+ -If ``true`` the camera smoothly moves towards the target at :ref:`smoothing_speed`. Default value: ``false`` +If ``true``, the camera smoothly moves towards the target at :ref:`smoothing_speed`. Default value: ``false`` .. _class_Camera2D_smoothing_speed: diff --git a/classes/class_canvasitem.rst b/classes/class_canvasitem.rst index b91f85dc6..f54d7899b 100644 --- a/classes/class_canvasitem.rst +++ b/classes/class_canvasitem.rst @@ -59,7 +59,7 @@ Methods +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`draw_multiline_colors` **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_multimesh` **(** :ref:`Mesh` mesh, :ref:`Texture` texture, :ref:`Texture` normal_map=null **)** | +| void | :ref:`draw_multimesh` **(** :ref:`MultiMesh` multimesh, :ref:`Texture` texture, :ref:`Texture` normal_map=null **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`draw_polygon` **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array( ), :ref:`Texture` texture=null, :ref:`Texture` normal_map=null, :ref:`bool` antialiased=false **)** | +----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -274,13 +274,13 @@ The color applied to textures on this ``CanvasItem``. This is not inherited by c | *Getter* | is_draw_behind_parent_enabled() | +----------+---------------------------------+ -If ``true`` the object draws behind its parent. Default value: ``false``. +If ``true``, the object draws behind its parent. Default value: ``false``. .. _class_CanvasItem_show_on_top: - :ref:`bool` **show_on_top** -If ``true`` the object draws on top of its parent. Default value: ``true``. +If ``true``, the object draws on top of its parent. Default value: ``true``. .. _class_CanvasItem_use_parent_material: @@ -292,7 +292,7 @@ If ``true`` the object draws on top of its parent. Default value: ``true``. | *Getter* | get_use_parent_material() | +----------+--------------------------------+ -If ``true`` the parent ``CanvasItem``'s :ref:`material` property is used as this one's material. Default value: ``false``. +If ``true``, the parent ``CanvasItem``'s :ref:`material` property is used as this one's material. Default value: ``false``. .. _class_CanvasItem_visible: @@ -304,7 +304,7 @@ If ``true`` the parent ``CanvasItem``'s :ref:`material`, the correct way to make them visible is to call one of the multiple popup\*() functions instead. Method Descriptions ------------------- @@ -357,7 +357,7 @@ Draws multiple, parallel lines with a uniform ``width``, segment-by-segment colo .. _class_CanvasItem_draw_multimesh: -- void **draw_multimesh** **(** :ref:`Mesh` mesh, :ref:`Texture` texture, :ref:`Texture` normal_map=null **)** +- void **draw_multimesh** **(** :ref:`MultiMesh` multimesh, :ref:`Texture` texture, :ref:`Texture` normal_map=null **)** .. _class_CanvasItem_draw_polygon: @@ -565,7 +565,7 @@ If ``enable`` is ``true``, children will be updated with global transform data. - void **show** **(** **)** -Show the CanvasItem currently hidden. +Show the CanvasItem currently hidden. For controls that inherit :ref:`Popup`, the correct way to make them visible is to call one of the multiple popup\*() functions instead. .. _class_CanvasItem_update: diff --git a/classes/class_centercontainer.rst b/classes/class_centercontainer.rst index 258466839..c7332700d 100644 --- a/classes/class_centercontainer.rst +++ b/classes/class_centercontainer.rst @@ -41,5 +41,5 @@ Property Descriptions | *Getter* | is_using_top_left() | +----------+-------------------------+ -If ``true`` centers children relative to the ``CenterContainer``'s top left corner. Default value: ``false``. +If ``true``, centers children relative to the ``CenterContainer``'s top left corner. Default value: ``false``. diff --git a/classes/class_collisionobject.rst b/classes/class_collisionobject.rst index 57103ddae..5b4aa3bba 100644 --- a/classes/class_collisionobject.rst +++ b/classes/class_collisionobject.rst @@ -105,7 +105,7 @@ Property Descriptions | *Getter* | get_capture_input_on_drag() | +----------+----------------------------------+ -If ``true`` the ``CollisionObject`` will continue to receive input events as the mouse is dragged across its shapes. Default value: ``false``. +If ``true``, the ``CollisionObject`` will continue to receive input events as the mouse is dragged across its shapes. Default value: ``false``. .. _class_CollisionObject_input_ray_pickable: @@ -117,7 +117,7 @@ If ``true`` the ``CollisionObject`` will continue to receive input events as the | *Getter* | is_ray_pickable() | +----------+-------------------------+ -If ``true`` the :ref:`CollisionObject`'s shapes will respond to :ref:`RayCast`\ s. Default value: ``true``. +If ``true``, the :ref:`CollisionObject`'s shapes will respond to :ref:`RayCast`\ s. Default value: ``true``. Method Descriptions ------------------- @@ -150,7 +150,7 @@ Returns an :ref:`Array` of ``owner_id`` identifiers. You can use th - :ref:`bool` **is_shape_owner_disabled** **(** :ref:`int` owner_id **)** const -If ``true`` the shape owner and its shapes are disabled. +If ``true``, the shape owner and its shapes are disabled. .. _class_CollisionObject_remove_shape_owner: @@ -216,7 +216,7 @@ Removes a shape from the given shape owner. - void **shape_owner_set_disabled** **(** :ref:`int` owner_id, :ref:`bool` disabled **)** -If ``true`` disables the given shape owner. +If ``true``, disables the given shape owner. .. _class_CollisionObject_shape_owner_set_transform: diff --git a/classes/class_collisionobject2d.rst b/classes/class_collisionobject2d.rst index 8ecab7193..d995b508e 100644 --- a/classes/class_collisionobject2d.rst +++ b/classes/class_collisionobject2d.rst @@ -9,7 +9,7 @@ CollisionObject2D **Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`Area2D`, :ref:`PhysicsBody2D` +**Inherited By:** :ref:`PhysicsBody2D`, :ref:`Area2D` **Category:** Core @@ -107,7 +107,7 @@ Property Descriptions | *Getter* | is_pickable() | +----------+---------------------+ -If ``true`` this object is pickable. A pickable object can detect the mouse pointer entering/leaving, and if the mouse is inside it, report input events. +If ``true``, this object is pickable. A pickable object can detect the mouse pointer entering/leaving, and if the mouse is inside it, report input events. Method Descriptions ------------------- @@ -140,7 +140,7 @@ Returns an :ref:`Array` of ``owner_id`` identifiers. You can use th - :ref:`bool` **is_shape_owner_disabled** **(** :ref:`int` owner_id **)** const -If ``true`` the shape owner and its shapes are disabled. +If ``true``, the shape owner and its shapes are disabled. .. _class_CollisionObject2D_is_shape_owner_one_way_collision_enabled: @@ -212,7 +212,7 @@ Removes a shape from the given shape owner. - void **shape_owner_set_disabled** **(** :ref:`int` owner_id, :ref:`bool` disabled **)** -If ``true`` disables the given shape owner. +If ``true``, disables the given shape owner. .. _class_CollisionObject2D_shape_owner_set_one_way_collision: diff --git a/classes/class_collisionpolygon2d.rst b/classes/class_collisionpolygon2d.rst index 6d00023a5..28e92c9fa 100644 --- a/classes/class_collisionpolygon2d.rst +++ b/classes/class_collisionpolygon2d.rst @@ -70,7 +70,7 @@ Collision build mode. Use one of the ``BUILD_*`` constants. Default value: ``BUI | *Getter* | is_disabled() | +----------+---------------------+ -If ``true`` no collisions will be detected. +If ``true``, no collisions will be detected. .. _class_CollisionPolygon2D_one_way_collision: @@ -82,7 +82,7 @@ If ``true`` no collisions will be detected. | *Getter* | is_one_way_collision_enabled() | +----------+--------------------------------+ -If ``true`` only edges that face up, relative to CollisionPolygon2D's rotation, will collide with other objects. +If ``true``, only edges that face up, relative to CollisionPolygon2D's rotation, will collide with other objects. .. _class_CollisionPolygon2D_polygon: diff --git a/classes/class_color.rst b/classes/class_color.rst index e604dc712..c748fecde 100644 --- a/classes/class_color.rst +++ b/classes/class_color.rst @@ -462,16 +462,6 @@ Method Descriptions Constructs a color from an HTML hexadecimal color string in ARGB or RGB format. See also :ref:`@GDScript.ColorN`. -The following string formats are supported: - -``"#ff00ff00"`` - ARGB format with '#' - -``"ff00ff00"`` - ARGB format - -``"#ff00ff"`` - RGB format with '#' - -``"ff00ff"`` - RGB format - :: # Each of the following creates the same color RGBA(178, 217, 10, 255) @@ -498,7 +488,7 @@ Constructs a color from an RGB profile using values between 0 and 1. Alpha will :: - var c = Color(0.2, 1.0, .7) # Equivalent to RGBA(51, 255, 178, 255) + var c = Color(0.2, 1.0, 0.7) # Equivalent to RGBA(51, 255, 178, 255) .. _class_Color_Color: @@ -508,7 +498,7 @@ Constructs a color from an RGBA profile using values between 0 and 1. :: - var c = Color(0.2, 1.0, .7, .8) # Equivalent to RGBA(51, 255, 178, 204) + var c = Color(0.2, 1.0, 0.7, 0.8) # Equivalent to RGBA(51, 255, 178, 204) .. _class_Color_blend: @@ -519,8 +509,8 @@ Returns a new color resulting from blending this color over another. If the colo :: var bg = Color(0.0, 1.0, 0.0, 0.5) # Green with alpha of 50% - var fg = Color(1.0, 0.0, 0.0, .5) # Red with alpha of 50% - var blendedColor = bg.blend(fg) # Brown with alpha of 75% + var fg = Color(1.0, 0.0, 0.0, 0.5) # Red with alpha of 50% + var blended_color = bg.blend(fg) # Brown with alpha of 75% .. _class_Color_contrasted: @@ -530,14 +520,14 @@ Returns the most contrasting color. :: - var c = Color(.3, .4, .9) - var contrastedColor = c.contrasted() # Equivalent to RGBA(204, 229, 102, 255) + var c = Color(0.3, 0.4, 0.9) + var contrasted_color = c.contrasted() # Equivalent to RGBA(204, 229, 102, 255) .. _class_Color_darkened: - :ref:`Color` **darkened** **(** :ref:`float` amount **)** -Returns a new color resulting from making this color darker by the specified percentage (0-1). +Returns a new color resulting from making this color darker by the specified percentage (ratio from 0 to 1). :: @@ -560,7 +550,7 @@ Constructs a color from an HSV profile. ``h``, ``s``, and ``v`` are values betwe Returns the color's grayscale representation. -The gray is calculated by ``(r + g + b) / 3``. +The gray value is calculated as ``(r + g + b) / 3``. :: @@ -575,14 +565,14 @@ Returns the inverted color ``(1 - r, 1 - g, 1 - b, 1 - a)``. :: - var c = Color(.3, .4, .9) - var invertedColor = c.inverted() # a color of an RGBA(178, 153, 26, 255) + var c = Color(0.3, 0.4, 0.9) + var inverted_color = c.inverted() # a color of an RGBA(178, 153, 26, 255) .. _class_Color_lightened: - :ref:`Color` **lightened** **(** :ref:`float` amount **)** -Returns a new color resulting from making this color lighter by the specified percentage (0-1). +Returns a new color resulting from making this color lighter by the specified percentage (ratio from 0 to 1). :: @@ -593,7 +583,7 @@ Returns a new color resulting from making this color lighter by the specified pe - :ref:`Color` **linear_interpolate** **(** :ref:`Color` b, :ref:`float` t **)** -Returns the linear interpolation with another color. The value t is between 0 and 1. +Returns the linear interpolation with another color. The interpolation factor ``t`` is between 0 and 1. :: @@ -609,7 +599,7 @@ Returns the color's 32-bit integer in ABGR format (each byte represents a compon :: - var c = Color(1, .5, .2) + var c = Color(1, 0.5, 0.2) print(c.to_abgr32()) # Prints 4281565439 .. _class_Color_to_abgr64: @@ -620,7 +610,7 @@ Returns the color's 64-bit integer in ABGR format (each word represents a compon :: - var c = Color(1, .5, .2) + var c = Color(1, 0.5, 0.2) print(c.to_abgr64()) # Prints -225178692812801 .. _class_Color_to_argb32: @@ -631,7 +621,7 @@ Returns the color's 32-bit integer in ARGB format (each byte represents a compon :: - var c = Color(1, .5, .2) + var c = Color(1, 0.5, 0.2) print(c.to_argb32()) # Prints 4294934323 .. _class_Color_to_argb64: @@ -642,7 +632,7 @@ Returns the color's 64-bit integer in ARGB format (each word represents a compon :: - var c = Color(1, .5, .2) + var c = Color(1, 0.5, 0.2) print(c.to_argb64()) # Prints -2147470541 .. _class_Color_to_html: @@ -655,7 +645,7 @@ Setting ``with_alpha`` to ``false`` excludes alpha from the hexadecimal string. :: - var c = Color(1, 1, 1, .5) + var c = Color(1, 1, 1, 0.5) var s1 = c.to_html() # Results "7fffffff" var s2 = c.to_html(false) # Results 'ffffff' @@ -667,7 +657,7 @@ Returns the color's 32-bit integer in RGBA format (each byte represents a compon :: - var c = Color(1, .5, .2) + var c = Color(1, 0.5, 0.2) print(c.to_rgba32()) # Prints 4286526463 .. _class_Color_to_rgba64: @@ -678,6 +668,6 @@ Returns the color's 64-bit integer in RGBA format (each word represents a compon :: - var c = Color(1, .5, .2) + var c = Color(1, 0.5, 0.2) print(c.to_rgba64()) # Prints -140736629309441 diff --git a/classes/class_colorpicker.rst b/classes/class_colorpicker.rst index e8f241439..7ade0d077 100644 --- a/classes/class_colorpicker.rst +++ b/classes/class_colorpicker.rst @@ -32,9 +32,13 @@ Properties Methods ------- -+-------+---------------------------------------------------------------------------------------------+ -| void | :ref:`add_preset` **(** :ref:`Color` color **)** | -+-------+---------------------------------------------------------------------------------------------+ ++----------------------------------------------+-------------------------------------------------------------------------------------------------+ +| void | :ref:`add_preset` **(** :ref:`Color` color **)** | ++----------------------------------------------+-------------------------------------------------------------------------------------------------+ +| void | :ref:`erase_preset` **(** :ref:`Color` color **)** | ++----------------------------------------------+-------------------------------------------------------------------------------------------------+ +| :ref:`PoolColorArray` | :ref:`get_presets` **(** **)** const | ++----------------------------------------------+-------------------------------------------------------------------------------------------------+ Theme Properties ---------------- @@ -70,6 +74,18 @@ Signals Emitted when the color is changed. +.. _class_ColorPicker_preset_added: + +- **preset_added** **(** :ref:`Color` color **)** + +Emitted when a preset is added. + +.. _class_ColorPicker_preset_removed: + +- **preset_removed** **(** :ref:`Color` color **)** + +Emitted when a preset is removed. + Description ----------- @@ -100,7 +116,7 @@ The currently selected color. | *Getter* | is_deferred_mode() | +----------+--------------------------+ -If ``true`` the color will apply only after the user releases the mouse button, otherwise it will apply immediately even in mouse motion event (which can cause performance issues). +If ``true``, the color will apply only after the user releases the mouse button, otherwise it will apply immediately even in mouse motion event (which can cause performance issues). .. _class_ColorPicker_edit_alpha: @@ -112,7 +128,7 @@ If ``true`` the color will apply only after the user releases the mouse button, | *Getter* | is_editing_alpha() | +----------+-----------------------+ -If ``true`` shows an alpha channel slider (transparency). +If ``true``, shows an alpha channel slider (transparency). .. _class_ColorPicker_raw_mode: @@ -124,7 +140,7 @@ If ``true`` shows an alpha channel slider (transparency). | *Getter* | is_raw_mode() | +----------+---------------------+ -If ``true`` allows the color R, G, B component values to go beyond 1.0, which can be used for certain special operations that require it (like tinting without darkening or rendering sprites in HDR). +If ``true``, allows the color R, G, B component values to go beyond 1.0, which can be used for certain special operations that require it (like tinting without darkening or rendering sprites in HDR). Method Descriptions ------------------- @@ -135,3 +151,15 @@ Method Descriptions Adds the given color to a list of color presets. The presets are displayed in the color picker and the user will be able to select them. Note: the presets list is only for *this* color picker. +.. _class_ColorPicker_erase_preset: + +- void **erase_preset** **(** :ref:`Color` color **)** + +Remove the given color from the list of color presets of this color picker. + +.. _class_ColorPicker_get_presets: + +- :ref:`PoolColorArray` **get_presets** **(** **)** const + +Return the list of colors in the presets of the color picker. + diff --git a/classes/class_colorpickerbutton.rst b/classes/class_colorpickerbutton.rst index 8693cd76f..e6e9013d9 100644 --- a/classes/class_colorpickerbutton.rst +++ b/classes/class_colorpickerbutton.rst @@ -106,7 +106,7 @@ The currently selected color. | *Getter* | is_editing_alpha() | +----------+-----------------------+ -If ``true`` the alpha channel in the displayed :ref:`ColorPicker` will be visible. Default value: ``true``. +If ``true``, the alpha channel in the displayed :ref:`ColorPicker` will be visible. Default value: ``true``. Method Descriptions ------------------- diff --git a/classes/class_container.rst b/classes/class_container.rst index c44068c1c..4b435b218 100644 --- a/classes/class_container.rst +++ b/classes/class_container.rst @@ -9,7 +9,7 @@ Container **Inherits:** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`PanelContainer`, :ref:`GridContainer`, :ref:`ScrollContainer`, :ref:`ViewportContainer`, :ref:`MarginContainer`, :ref:`CenterContainer`, :ref:`TabContainer`, :ref:`GraphNode`, :ref:`SplitContainer`, :ref:`BoxContainer`, :ref:`EditorProperty` +**Inherited By:** :ref:`PanelContainer`, :ref:`EditorProperty`, :ref:`GridContainer`, :ref:`ScrollContainer`, :ref:`ViewportContainer`, :ref:`MarginContainer`, :ref:`CenterContainer`, :ref:`GraphNode`, :ref:`SplitContainer`, :ref:`BoxContainer`, :ref:`TabContainer` **Category:** Core diff --git a/classes/class_convexpolygonshape2d.rst b/classes/class_convexpolygonshape2d.rst index 32b4ab817..1ca8d52a7 100644 --- a/classes/class_convexpolygonshape2d.rst +++ b/classes/class_convexpolygonshape2d.rst @@ -59,5 +59,5 @@ Method Descriptions - void **set_point_cloud** **(** :ref:`PoolVector2Array` point_cloud **)** -Currently, this method does nothing. +Based on the set of points provided, this creates and assigns the :ref:`points` property using the convex hull algorithm. Removing all unneeded points. See :ref:`Geometry.convex_hull_2d` for details. diff --git a/classes/class_csgcombiner.rst b/classes/class_csgcombiner.rst index 78ea551a5..3bd4eca94 100644 --- a/classes/class_csgcombiner.rst +++ b/classes/class_csgcombiner.rst @@ -19,5 +19,5 @@ A CSG node that allows you to combine other CSG modifiers. Description ----------- -For complex arrangements of shapes it is sometimes needed to add structure to your CSG nodes. The CSGCombiner node allows you to create this structure. The node encapsulates the result of the CSG operations of its children. In this way it is possible to do operations on one set of shapes that are children of one CSGCombiner node, and a set of separate operations on a second set of shapes that are children of a second CSGCombiner node, and then do an operation that takes the two end results as their input to create the final shape. +For complex arrangements of shapes, it is sometimes needed to add structure to your CSG nodes. The CSGCombiner node allows you to create this structure. The node encapsulates the result of the CSG operations of its children. In this way, it is possible to do operations on one set of shapes that are children of one CSGCombiner node, and a set of separate operations on a second set of shapes that are children of a second CSGCombiner node, and then do an operation that takes the two end results as its input to create the final shape. diff --git a/classes/class_csgmesh.rst b/classes/class_csgmesh.rst index e923aa8d4..38063ff22 100644 --- a/classes/class_csgmesh.rst +++ b/classes/class_csgmesh.rst @@ -26,7 +26,7 @@ Properties Description ----------- -This CSG node allows you to use any mesh resource as a CSG shape provided it is closed, does not self-intersect, does not contain internal faces and has no edges that connect to more then two faces. +This CSG node allows you to use any mesh resource as a CSG shape, provided it is closed, does not self-intersect, does not contain internal faces and has no edges that connect to more then two faces. Property Descriptions --------------------- diff --git a/classes/class_csgshape.rst b/classes/class_csgshape.rst index ed22c0723..998d42e92 100644 --- a/classes/class_csgshape.rst +++ b/classes/class_csgshape.rst @@ -24,6 +24,10 @@ Properties +-------------------------------------------+--------------------------------------------------------------+ | :ref:`bool` | :ref:`calculate_tangents` | +-------------------------------------------+--------------------------------------------------------------+ +| :ref:`int` | :ref:`collision_layer` | ++-------------------------------------------+--------------------------------------------------------------+ +| :ref:`int` | :ref:`collision_mask` | ++-------------------------------------------+--------------------------------------------------------------+ | :ref:`Operation` | :ref:`operation` | +-------------------------------------------+--------------------------------------------------------------+ | :ref:`float` | :ref:`snap` | @@ -34,9 +38,17 @@ Properties Methods ------- -+--------------------------+----------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_root_shape` **(** **)** const | -+--------------------------+----------------------------------------------------------------------+ ++--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | ++--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | ++--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_root_shape` **(** **)** const | ++--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ @@ -71,6 +83,34 @@ Property Descriptions Calculate tangents for the CSG shape which allows the use of normal maps. This is only applied on the root shape, this setting is ignored on any child. +.. _class_CSGShape_collision_layer: + +- :ref:`int` **collision_layer** + ++----------+----------------------------+ +| *Setter* | set_collision_layer(value) | ++----------+----------------------------+ +| *Getter* | get_collision_layer() | ++----------+----------------------------+ + +The physics layers this area is in. + +Collidable objects can exist in any of 32 different layers. These layers work like a tagging system, and are not visual. A collidable can use these layers to select with which objects it can collide, using the collision_mask property. + +A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A. + +.. _class_CSGShape_collision_mask: + +- :ref:`int` **collision_mask** + ++----------+---------------------------+ +| *Setter* | set_collision_mask(value) | ++----------+---------------------------+ +| *Getter* | get_collision_mask() | ++----------+---------------------------+ + +The physics layers this CSG shape scans for collisions. + .. _class_CSGShape_operation: - :ref:`Operation` **operation** @@ -108,9 +148,33 @@ Adds a collision shape to the physics engine for our CSG shape. This will always Method Descriptions ------------------- +.. _class_CSGShape_get_collision_layer_bit: + +- :ref:`bool` **get_collision_layer_bit** **(** :ref:`int` bit **)** const + +Returns an individual bit on the collision mask. + +.. _class_CSGShape_get_collision_mask_bit: + +- :ref:`bool` **get_collision_mask_bit** **(** :ref:`int` bit **)** const + +Returns an individual bit on the collision mask. + .. _class_CSGShape_is_root_shape: - :ref:`bool` **is_root_shape** **(** **)** const Returns true if this is a root shape and is thus the object that is rendered. +.. _class_CSGShape_set_collision_layer_bit: + +- void **set_collision_layer_bit** **(** :ref:`int` bit, :ref:`bool` value **)** + +Sets individual bits on the layer mask. Use this if you only need to change one layer's value. + +.. _class_CSGShape_set_collision_mask_bit: + +- void **set_collision_mask_bit** **(** :ref:`int` bit, :ref:`bool` value **)** + +Sets individual bits on the collision mask. Use this if you only need to change one layer's value. + diff --git a/classes/class_directionallight.rst b/classes/class_directionallight.rst index d3adbaf49..dc9ac38f0 100644 --- a/classes/class_directionallight.rst +++ b/classes/class_directionallight.rst @@ -95,7 +95,7 @@ Amount of extra bias for shadow splits that are far away. If self shadowing occu | *Getter* | is_blend_splits_enabled() | +----------+---------------------------+ -If ``true`` shadow detail is sacrificed in exchange for smoother transitions between splits. Default value:``false``. +If ``true``, shadow detail is sacrificed in exchange for smoother transitions between splits. Default value:``false``. .. _class_DirectionalLight_directional_shadow_depth_range: diff --git a/classes/class_dynamicfont.rst b/classes/class_dynamicfont.rst index d020602ae..c7bff976b 100644 --- a/classes/class_dynamicfont.rst +++ b/classes/class_dynamicfont.rst @@ -181,7 +181,7 @@ The font size. | *Getter* | get_use_filter() | +----------+-----------------------+ -If ``true`` filtering is used. +If ``true``, filtering is used. .. _class_DynamicFont_use_mipmaps: @@ -193,7 +193,7 @@ If ``true`` filtering is used. | *Getter* | get_use_mipmaps() | +----------+------------------------+ -If ``true`` mipmapping is used. +If ``true``, mipmapping is used. Method Descriptions ------------------- diff --git a/classes/class_editorfiledialog.rst b/classes/class_editorfiledialog.rst index aae979ac7..ee7193b85 100644 --- a/classes/class_editorfiledialog.rst +++ b/classes/class_editorfiledialog.rst @@ -167,7 +167,7 @@ The file system path in the address bar. | *Getter* | is_overwrite_warning_disabled() | +----------+--------------------------------------+ -If ``true`` the ``EditorFileDialog`` will not warn the user before overwriting files. +If ``true``, the ``EditorFileDialog`` will not warn the user before overwriting files. .. _class_EditorFileDialog_display_mode: @@ -203,7 +203,7 @@ The purpose of the ``EditorFileDialog``. Changes allowed behaviors. | *Getter* | is_showing_hidden_files() | +----------+------------------------------+ -If ``true`` hidden files and directories will be visible in the ``EditorFileDialog``. +If ``true``, hidden files and directories will be visible in the ``EditorFileDialog``. Method Descriptions ------------------- diff --git a/classes/class_editorimportplugin.rst b/classes/class_editorimportplugin.rst index 12ea59ea3..2a125327a 100644 --- a/classes/class_editorimportplugin.rst +++ b/classes/class_editorimportplugin.rst @@ -19,31 +19,31 @@ Registers a custom resource importer in the editor. Use the class to parse any f Methods ------- -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_import_options` **(** :ref:`int` preset **)** virtual | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_import_order` **(** **)** virtual | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_importer_name` **(** **)** virtual | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_option_visibility` **(** :ref:`String` option, :ref:`Dictionary` options **)** virtual | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_preset_count` **(** **)** virtual | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_preset_name` **(** :ref:`int` preset **)** virtual | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_priority` **(** **)** virtual | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_recognized_extensions` **(** **)** virtual | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_resource_type` **(** **)** virtual | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_save_extension` **(** **)** virtual | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_visible_name` **(** **)** virtual | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`import` **(** :ref:`String` source_file, :ref:`String` save_path, :ref:`Dictionary` options, :ref:`Array` r_platform_variants, :ref:`Array` r_gen_files **)** virtual | -+------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_import_options` **(** :ref:`int` preset **)** virtual | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_import_order` **(** **)** virtual | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_importer_name` **(** **)** virtual | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_option_visibility` **(** :ref:`String` option, :ref:`Dictionary` options **)** virtual | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_preset_count` **(** **)** virtual | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_preset_name` **(** :ref:`int` preset **)** virtual | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_priority` **(** **)** virtual | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_recognized_extensions` **(** **)** virtual | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_resource_type` **(** **)** virtual | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_save_extension` **(** **)** virtual | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_visible_name` **(** **)** virtual | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`import` **(** :ref:`String` source_file, :ref:`String` save_path, :ref:`Dictionary` options, :ref:`Array` platform_variants, :ref:`Array` gen_files **)** virtual | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -83,7 +83,7 @@ Below is an example EditorImportPlugin that imports a :ref:`Mesh` fr func get_import_options(i): return [{"name": "my_option", "default_value": false}] - func import(source_file, save_path, options, r_platform_variants, r_gen_files): + func import(source_file, save_path, options, platform_variants, gen_files): var file = File.new() if file.open(source_file, File.READ) != OK: return FAILED @@ -169,5 +169,5 @@ Get the name to display in the import window. .. _class_EditorImportPlugin_import: -- :ref:`int` **import** **(** :ref:`String` source_file, :ref:`String` save_path, :ref:`Dictionary` options, :ref:`Array` r_platform_variants, :ref:`Array` r_gen_files **)** virtual +- :ref:`int` **import** **(** :ref:`String` source_file, :ref:`String` save_path, :ref:`Dictionary` options, :ref:`Array` platform_variants, :ref:`Array` gen_files **)** virtual diff --git a/classes/class_editorinterface.rst b/classes/class_editorinterface.rst index 134cff1ad..aaf712332 100644 --- a/classes/class_editorinterface.rst +++ b/classes/class_editorinterface.rst @@ -56,7 +56,7 @@ Methods +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`save_scene_as` **(** :ref:`String` path, :ref:`bool` with_preview=true **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`select_file` **(** :ref:`String` p_file **)** | +| void | :ref:`select_file` **(** :ref:`String` file **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_plugin_enabled` **(** :ref:`String` plugin, :ref:`bool` enabled **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -177,7 +177,7 @@ Saves the scene as a file at ``path``. .. _class_EditorInterface_select_file: -- void **select_file** **(** :ref:`String` p_file **)** +- void **select_file** **(** :ref:`String` file **)** .. _class_EditorInterface_set_plugin_enabled: diff --git a/classes/class_editorplugin.rst b/classes/class_editorplugin.rst index dfcaf954a..2caa77f91 100644 --- a/classes/class_editorplugin.rst +++ b/classes/class_editorplugin.rst @@ -48,8 +48,12 @@ Methods +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** virtual | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`disable_plugin` **(** **)** virtual | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`edit` **(** :ref:`Object` object **)** virtual | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`enable_plugin` **(** **)** virtual | ++------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`forward_canvas_draw_over_viewport` **(** :ref:`Control` overlay **)** virtual | +------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`forward_canvas_force_draw_over_viewport` **(** :ref:`Control` overlay **)** virtual | @@ -296,12 +300,20 @@ This is used, for example, in shader editors to let the plugin know that it must Clear all the state and reset the object being edited to zero. This ensures your plugin does not keep editing a currently existing node, or a node from the wrong scene. +.. _class_EditorPlugin_disable_plugin: + +- void **disable_plugin** **(** **)** virtual + .. _class_EditorPlugin_edit: - void **edit** **(** :ref:`Object` object **)** virtual This function is used for plugins that edit specific object types (nodes or resources). It requests the editor to edit the given object. +.. _class_EditorPlugin_enable_plugin: + +- void **enable_plugin** **(** **)** virtual + .. _class_EditorPlugin_forward_canvas_draw_over_viewport: - void **forward_canvas_draw_over_viewport** **(** :ref:`Control` overlay **)** virtual diff --git a/classes/class_editorscenepostimport.rst b/classes/class_editorscenepostimport.rst index ed7985d4e..70d033381 100644 --- a/classes/class_editorscenepostimport.rst +++ b/classes/class_editorscenepostimport.rst @@ -49,7 +49,7 @@ The :ref:`post_import` callback receive func iterate(node): if node != null: - node.name = "modified_"+node.name + node.name = "modified_" + node.name for child in node.get_children(): iterate(child) diff --git a/classes/class_editorsettings.rst b/classes/class_editorsettings.rst index 3b39606af..e65edc75b 100644 --- a/classes/class_editorsettings.rst +++ b/classes/class_editorsettings.rst @@ -80,7 +80,7 @@ Method Descriptions - void **add_property_info** **(** :ref:`Dictionary` info **)** -Add a custom property info to a property. The dictionary must contain: name::ref:`String`(the name of the property) and type::ref:`int`(see TYPE\_\* in :ref:`@GlobalScope`), and optionally hint::ref:`int`(see PROPERTY_HINT\_\* in :ref:`@GlobalScope`), hint_string::ref:`String`. +Add a custom property info to a property. The dictionary must contain: name::ref:`String`\ (the name of the property) and type::ref:`int`\ (see TYPE\_\* in :ref:`@GlobalScope`), and optionally hint::ref:`int`\ (see PROPERTY_HINT\_\* in :ref:`@GlobalScope`), hint_string::ref:`String`. Example: diff --git a/classes/class_environment.rst b/classes/class_environment.rst index f58797e13..3a61efe24 100644 --- a/classes/class_environment.rst +++ b/classes/class_environment.rst @@ -19,167 +19,173 @@ Resource for environment nodes (like :ref:`WorldEnvironment` | :ref:`adjustment_brightness` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`adjustment_color_correction` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`adjustment_contrast` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`adjustment_enabled` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`adjustment_saturation` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`ambient_light_color` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ambient_light_energy` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ambient_light_sky_contribution` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`auto_exposure_enabled` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`auto_exposure_max_luma` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`auto_exposure_min_luma` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`auto_exposure_scale` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`auto_exposure_speed` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`background_canvas_max_layer` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`background_color` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`background_energy` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`BGMode` | :ref:`background_mode` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`Sky` | :ref:`background_sky` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`background_sky_custom_fov` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`dof_blur_far_amount` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`dof_blur_far_distance` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`dof_blur_far_enabled` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`DOFBlurQuality` | :ref:`dof_blur_far_quality` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`dof_blur_far_transition` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`dof_blur_near_amount` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`dof_blur_near_distance` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`dof_blur_near_enabled` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`DOFBlurQuality` | :ref:`dof_blur_near_quality` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`dof_blur_near_transition` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`fog_color` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`fog_depth_begin` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`fog_depth_curve` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`fog_depth_enabled` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`fog_depth_end` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`fog_enabled` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`fog_height_curve` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`fog_height_enabled` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`fog_height_max` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`fog_height_min` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`fog_sun_amount` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`fog_sun_color` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`fog_transmit_curve` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`fog_transmit_enabled` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`glow_bicubic_upscale` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`GlowBlendMode` | :ref:`glow_blend_mode` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`glow_bloom` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`glow_enabled` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`glow_hdr_luminance_cap` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`glow_hdr_scale` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`glow_hdr_threshold` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`glow_intensity` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`glow_levels/1` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`glow_levels/2` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`glow_levels/3` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`glow_levels/4` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`glow_levels/5` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`glow_levels/6` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`glow_levels/7` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`glow_strength` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ss_reflections_depth_tolerance` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`ss_reflections_enabled` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ss_reflections_fade_in` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ss_reflections_fade_out` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`ss_reflections_max_steps` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`ss_reflections_roughness` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ssao_ao_channel_affect` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ssao_bias` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`SSAOBlur` | :ref:`ssao_blur` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`ssao_color` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ssao_edge_sharpness` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`ssao_enabled` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ssao_intensity` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ssao_intensity2` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ssao_light_affect` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`SSAOQuality` | :ref:`ssao_quality` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ssao_radius` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`ssao_radius2` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tonemap_exposure` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`ToneMapper` | :ref:`tonemap_mode` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`tonemap_white` | -+--------------------------------------------------------+-----------------------------------------------------------------------------------------+ ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`adjustment_brightness` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`adjustment_color_correction` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`adjustment_contrast` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`adjustment_enabled` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`adjustment_saturation` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`ambient_light_color` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`ambient_light_energy` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`ambient_light_sky_contribution` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`auto_exposure_enabled` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`auto_exposure_max_luma` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`auto_exposure_min_luma` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`auto_exposure_scale` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`auto_exposure_speed` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`background_canvas_max_layer` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`background_color` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`background_energy` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`BGMode` | :ref:`background_mode` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`Sky` | :ref:`background_sky` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`background_sky_custom_fov` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`Basis` | :ref:`background_sky_orientation` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`background_sky_rotation` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`background_sky_rotation_degrees` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`dof_blur_far_amount` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`dof_blur_far_distance` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`dof_blur_far_enabled` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`DOFBlurQuality` | :ref:`dof_blur_far_quality` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`dof_blur_far_transition` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`dof_blur_near_amount` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`dof_blur_near_distance` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`dof_blur_near_enabled` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`DOFBlurQuality` | :ref:`dof_blur_near_quality` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`dof_blur_near_transition` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`fog_color` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`fog_depth_begin` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`fog_depth_curve` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`fog_depth_enabled` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`fog_depth_end` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`fog_enabled` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`fog_height_curve` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`fog_height_enabled` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`fog_height_max` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`fog_height_min` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`fog_sun_amount` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`fog_sun_color` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`fog_transmit_curve` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`fog_transmit_enabled` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`glow_bicubic_upscale` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`GlowBlendMode` | :ref:`glow_blend_mode` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`glow_bloom` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`glow_enabled` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`glow_hdr_luminance_cap` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`glow_hdr_scale` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`glow_hdr_threshold` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`glow_intensity` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`glow_levels/1` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`glow_levels/2` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`glow_levels/3` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`glow_levels/4` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`glow_levels/5` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`glow_levels/6` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`glow_levels/7` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`glow_strength` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`ss_reflections_depth_tolerance` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`ss_reflections_enabled` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`ss_reflections_fade_in` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`ss_reflections_fade_out` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`ss_reflections_max_steps` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`ss_reflections_roughness` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`ssao_ao_channel_affect` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`ssao_bias` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`SSAOBlur` | :ref:`ssao_blur` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`ssao_color` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`ssao_edge_sharpness` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`ssao_enabled` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`ssao_intensity` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`ssao_intensity2` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`ssao_light_affect` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`SSAOQuality` | :ref:`ssao_quality` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`ssao_radius` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`ssao_radius2` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`tonemap_exposure` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`ToneMapper` | :ref:`tonemap_mode` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`tonemap_white` | ++--------------------------------------------------------+-------------------------------------------------------------------------------------------+ Enumerations ------------ @@ -511,6 +517,42 @@ Defines the mode of background. :ref:`Sky` resource's custom field of view. +.. _class_Environment_background_sky_orientation: + +- :ref:`Basis` **background_sky_orientation** + ++----------+----------------------------+ +| *Setter* | set_sky_orientation(value) | ++----------+----------------------------+ +| *Getter* | get_sky_orientation() | ++----------+----------------------------+ + +:ref:`Sky` resource's rotation expressed as a :ref:`Basis` + +.. _class_Environment_background_sky_rotation: + +- :ref:`Vector3` **background_sky_rotation** + ++----------+-------------------------+ +| *Setter* | set_sky_rotation(value) | ++----------+-------------------------+ +| *Getter* | get_sky_rotation() | ++----------+-------------------------+ + +:ref:`Sky` resource's rotation expressed as euler angles in radians + +.. _class_Environment_background_sky_rotation_degrees: + +- :ref:`Vector3` **background_sky_rotation_degrees** + ++----------+---------------------------------+ +| *Setter* | set_sky_rotation_degrees(value) | ++----------+---------------------------------+ +| *Getter* | get_sky_rotation_degrees() | ++----------+---------------------------------+ + +:ref:`Sky` resource's rotation expressed as euler angles in degrees + .. _class_Environment_dof_blur_far_amount: - :ref:`float` **dof_blur_far_amount** diff --git a/classes/class_file.rst b/classes/class_file.rst index 2b2f06b58..509249261 100644 --- a/classes/class_file.rst +++ b/classes/class_file.rst @@ -183,7 +183,7 @@ Property Descriptions | *Getter* | get_endian_swap() | +----------+------------------------+ -If ``true`` the file's endianness is swapped. Use this if you're dealing with files written in big endian machines. +If ``true``, the file's endianness is swapped. Use this if you're dealing with files written in big endian machines. Note that this is about the file format, not CPU type. This is always reset to ``false`` whenever you open the file. diff --git a/classes/class_gdnativelibraryresourceloader.rst b/classes/class_gdnativelibraryresourceloader.rst new file mode 100644 index 000000000..785460a22 --- /dev/null +++ b/classes/class_gdnativelibraryresourceloader.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the GDNativeLibraryResourceLoader.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_GDNativeLibraryResourceLoader: + +GDNativeLibraryResourceLoader +============================= + +**Inherits:** :ref:`ResourceFormatLoader` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_gdnativelibraryresourcesaver.rst b/classes/class_gdnativelibraryresourcesaver.rst new file mode 100644 index 000000000..4cb716f03 --- /dev/null +++ b/classes/class_gdnativelibraryresourcesaver.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the GDNativeLibraryResourceSaver.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_GDNativeLibraryResourceSaver: + +GDNativeLibraryResourceSaver +============================ + +**Inherits:** :ref:`ResourceFormatSaver` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_generic6dofjoint.rst b/classes/class_generic6dofjoint.rst index 99ef237c1..8aa96503e 100644 --- a/classes/class_generic6dofjoint.rst +++ b/classes/class_generic6dofjoint.rst @@ -282,7 +282,7 @@ The lower, the longer an impulse from one side takes to travel to the other side | *Getter* | get_flag_x() | +----------+-------------------+ -If ``true`` rotation across the x-axis is limited. +If ``true``, rotation across the x-axis is limited. .. _class_Generic6DOFJoint_angular_limit_x/erp: @@ -366,7 +366,7 @@ The amount of rotational damping across the y-axis. The lower, the more dampenin | *Getter* | get_flag_y() | +----------+-------------------+ -If ``true`` rotation across the y-axis is limited. +If ``true``, rotation across the y-axis is limited. .. _class_Generic6DOFJoint_angular_limit_y/erp: @@ -450,7 +450,7 @@ The amount of rotational damping across the z-axis. The lower, the more dampenin | *Getter* | get_flag_z() | +----------+-------------------+ -If ``true`` rotation across the z-axis is limited. +If ``true``, rotation across the z-axis is limited. .. _class_Generic6DOFJoint_angular_limit_z/erp: @@ -522,7 +522,7 @@ The minimum rotation in positive direction to break loose and rotate around the | *Getter* | get_flag_x() | +----------+-------------------+ -If ``true`` a rotating motor at the x-axis is enabled. +If ``true``, a rotating motor at the x-axis is enabled. .. _class_Generic6DOFJoint_angular_motor_x/force_limit: @@ -558,7 +558,7 @@ Target speed for the motor at the x-axis. | *Getter* | get_flag_y() | +----------+-------------------+ -If ``true`` a rotating motor at the y-axis is enabled. +If ``true``, a rotating motor at the y-axis is enabled. .. _class_Generic6DOFJoint_angular_motor_y/force_limit: @@ -594,7 +594,7 @@ Target speed for the motor at the y-axis. | *Getter* | get_flag_z() | +----------+-------------------+ -If ``true`` a rotating motor at the z-axis is enabled. +If ``true``, a rotating motor at the z-axis is enabled. .. _class_Generic6DOFJoint_angular_motor_z/force_limit: @@ -762,7 +762,7 @@ The amount of damping that happens at the x-motion. | *Getter* | get_flag_x() | +----------+-------------------+ -If ``true`` the linear motion across the x-axis is limited. +If ``true``, the linear motion across the x-axis is limited. .. _class_Generic6DOFJoint_linear_limit_x/lower_distance: @@ -834,7 +834,7 @@ The amount of damping that happens at the y-motion. | *Getter* | get_flag_y() | +----------+-------------------+ -If ``true`` the linear motion across the y-axis is limited. +If ``true``, the linear motion across the y-axis is limited. .. _class_Generic6DOFJoint_linear_limit_y/lower_distance: @@ -906,7 +906,7 @@ The amount of damping that happens at the z-motion. | *Getter* | get_flag_z() | +----------+-------------------+ -If ``true`` the linear motion across the z-axis is limited. +If ``true``, the linear motion across the z-axis is limited. .. _class_Generic6DOFJoint_linear_limit_z/lower_distance: @@ -966,7 +966,7 @@ The maximum difference between the pivot points' z-axis. | *Getter* | get_flag_x() | +----------+-------------------+ -If ``true`` then there is a linear motor on the x-axis. It will attempt to reach the target velocity while staying within the force limits. +If ``true``, then there is a linear motor on the x-axis. It will attempt to reach the target velocity while staying within the force limits. .. _class_Generic6DOFJoint_linear_motor_x/force_limit: @@ -1002,7 +1002,7 @@ The speed that the linear motor will attempt to reach on the x-axis. | *Getter* | get_flag_y() | +----------+-------------------+ -If ``true`` then there is a linear motor on the y-axis. It will attempt to reach the target velocity while staying within the force limits. +If ``true``, then there is a linear motor on the y-axis. It will attempt to reach the target velocity while staying within the force limits. .. _class_Generic6DOFJoint_linear_motor_y/force_limit: @@ -1038,7 +1038,7 @@ The speed that the linear motor will attempt to reach on the y-axis. | *Getter* | get_flag_z() | +----------+-------------------+ -If ``true`` then there is a linear motor on the z-axis. It will attempt to reach the target velocity while staying within the force limits. +If ``true``, then there is a linear motor on the z-axis. It will attempt to reach the target velocity while staying within the force limits. .. _class_Generic6DOFJoint_linear_motor_z/force_limit: diff --git a/classes/class_geometryinstance.rst b/classes/class_geometryinstance.rst index 04d179a3f..e9f175b59 100644 --- a/classes/class_geometryinstance.rst +++ b/classes/class_geometryinstance.rst @@ -174,5 +174,5 @@ If there is a material in material_override, it will be used instead of any mate | *Getter* | get_flag() | +----------+-----------------+ -If ``true`` this GeometryInstance will be used when baking lights using a :ref:`GIProbe` and/or any other form of baked lighting. +If ``true``, this GeometryInstance will be used when baking lights using a :ref:`GIProbe` and/or any other form of baked lighting. diff --git a/classes/class_graphedit.rst b/classes/class_graphedit.rst index 0255d4ff5..17c5c6297 100644 --- a/classes/class_graphedit.rst +++ b/classes/class_graphedit.rst @@ -146,7 +146,7 @@ Emitted when a GraphNode is selected. .. _class_GraphEdit_popup_request: -- **popup_request** **(** :ref:`Vector2` p_position **)** +- **popup_request** **(** :ref:`Vector2` position **)** Signal sent when a popup is requested. Happens on right-clicking in the GraphEdit. 'p_position' is the position of the mouse pointer when the signal is sent. @@ -267,7 +267,7 @@ Remove the connection between 'from_port' slot of 'from' GraphNode and 'to_port' - :ref:`Array` **get_connection_list** **(** **)** const -Return an Array containing the list of connections. A connection consists in a structure of the form {from_slot: 0, from: "GraphNode name 0", to_slot: 1, to: "GraphNode name 1" } +Return an Array containing the list of connections. A connection consists in a structure of the form {from_port: 0, from: "GraphNode name 0", to_port: 1, to: "GraphNode name 1" } .. _class_GraphEdit_get_zoom_hbox: diff --git a/classes/class_graphnode.rst b/classes/class_graphnode.rst index df3a99f73..63afb85c6 100644 --- a/classes/class_graphnode.rst +++ b/classes/class_graphnode.rst @@ -82,6 +82,8 @@ Theme Properties +---------------------------------+-----------------------------------------------------+ | :ref:`Texture` | :ref:`close` | +---------------------------------+-----------------------------------------------------+ +| :ref:`Color` | :ref:`close_color` | ++---------------------------------+-----------------------------------------------------+ | :ref:`int` | :ref:`close_offset` | +---------------------------------+-----------------------------------------------------+ | :ref:`StyleBox` | :ref:`comment` | diff --git a/classes/class_gridmap.rst b/classes/class_gridmap.rst index 59ebc58fb..72dbb7914 100644 --- a/classes/class_gridmap.rst +++ b/classes/class_gridmap.rst @@ -116,7 +116,7 @@ Property Descriptions | *Getter* | get_center_x() | +----------+---------------------+ -If ``true`` grid items are centered on the X axis. +If ``true``, grid items are centered on the X axis. .. _class_GridMap_cell_center_y: @@ -128,7 +128,7 @@ If ``true`` grid items are centered on the X axis. | *Getter* | get_center_y() | +----------+---------------------+ -If ``true`` grid items are centered on the Y axis. +If ``true``, grid items are centered on the Y axis. .. _class_GridMap_cell_center_z: @@ -140,7 +140,7 @@ If ``true`` grid items are centered on the Y axis. | *Getter* | get_center_z() | +----------+---------------------+ -If ``true`` grid items are centered on the Z axis. +If ``true``, grid items are centered on the Z axis. .. _class_GridMap_cell_octant_size: diff --git a/classes/class_hingejoint.rst b/classes/class_hingejoint.rst index 722a9c5c9..efabb37c7 100644 --- a/classes/class_hingejoint.rst +++ b/classes/class_hingejoint.rst @@ -48,7 +48,7 @@ Enumerations enum **Flag**: -- **FLAG_USE_LIMIT** = **0** --- If ``true`` the hinges maximum and minimum rotation, defined by :ref:`angular_limit/lower` and :ref:`angular_limit/upper` has effects. +- **FLAG_USE_LIMIT** = **0** --- If ``true``, the hinges maximum and minimum rotation, defined by :ref:`angular_limit/lower` and :ref:`angular_limit/upper` has effects. - **FLAG_ENABLE_MOTOR** = **1** --- When activated, a motor turns the hinge. @@ -106,7 +106,7 @@ The speed with which the rotation across the axis perpendicular to the hinge get | *Getter* | get_flag() | +----------+-----------------+ -If ``true`` the hinges maximum and minimum rotation, defined by :ref:`angular_limit/lower` and :ref:`angular_limit/upper` has effects. +If ``true``, the hinges maximum and minimum rotation, defined by :ref:`angular_limit/lower` and :ref:`angular_limit/upper` has effects. .. _class_HingeJoint_angular_limit/lower: diff --git a/classes/class_httpclient.rst b/classes/class_httpclient.rst index 4a3507311..013ec47a2 100644 --- a/classes/class_httpclient.rst +++ b/classes/class_httpclient.rst @@ -341,13 +341,13 @@ Returns a STATUS\_\* enum constant. Need to call :ref:`poll` **has_response** **(** **)** const -If ``true`` this ``HTTPClient`` has a response available. +If ``true``, this ``HTTPClient`` has a response available. .. _class_HTTPClient_is_response_chunked: - :ref:`bool` **is_response_chunked** **(** **)** const -If ``true`` this ``HTTPClient`` has a response that is chunked. +If ``true``, this ``HTTPClient`` has a response that is chunked. .. _class_HTTPClient_poll: @@ -364,16 +364,16 @@ Generates a GET/POST application/x-www-form-urlencoded style query string from a :: var fields = {"username": "user", "password": "pass"} - String queryString = httpClient.query_string_from_dict(fields) - returns:= "username=user&password=pass" + String query_string = http_client.query_string_from_dict(fields) + # returns: "username=user&password=pass" Furthermore, if a key has a null value, only the key itself is added, without equal sign and value. If the value is an array, for each value in it a pair with the same key is added. :: var fields = {"single": 123, "not_valued": null, "multiple": [22, 33, 44]} - String queryString = httpClient.query_string_from_dict(fields) - returns:= "single=123¬_valued&multiple=22&multiple=33&multiple=44" + String query_string = http_client.query_string_from_dict(fields) + # returns: "single=123¬_valued&multiple=22&multiple=33&multiple=44" .. _class_HTTPClient_read_response_body_chunk: @@ -394,9 +394,9 @@ To create a POST request with query strings to push to the server, do: :: var fields = {"username" : "user", "password" : "pass"} - var queryString = httpClient.query_string_from_dict(fields) - var headers = ["Content-Type: application/x-www-form-urlencoded", "Content-Length: " + str(queryString.length())] - var result = httpClient.request(httpClient.METHOD_POST, "index.php", headers, queryString) + var query_string = http_client.query_string_from_dict(fields) + var headers = ["Content-Type: application/x-www-form-urlencoded", "Content-Length: " + str(query_string.length())] + var result = http_client.request(http_client.METHOD_POST, "index.php", headers, query_string) .. _class_HTTPClient_request_raw: diff --git a/classes/class_httprequest.rst b/classes/class_httprequest.rst index b537717f7..d3c85f57a 100644 --- a/classes/class_httprequest.rst +++ b/classes/class_httprequest.rst @@ -145,7 +145,7 @@ Maximum number of allowed redirects. | *Getter* | is_using_threads() | +----------+------------------------+ -If ``true`` multithreading is used to improve performance. +If ``true``, multithreading is used to improve performance. Method Descriptions ------------------- diff --git a/classes/class_inputeventaction.rst b/classes/class_inputeventaction.rst index 7b4bec301..1a9ae5a0d 100644 --- a/classes/class_inputeventaction.rst +++ b/classes/class_inputeventaction.rst @@ -60,5 +60,5 @@ The action's name. Actions are accessed via this :ref:`String`. | *Getter* | is_pressed() | +----------+--------------------+ -If ``true`` the action's state is pressed. If ``false`` the action's state is released. +If ``true``, the action's state is pressed. If ``false``, the action's state is released. diff --git a/classes/class_inputeventjoypadbutton.rst b/classes/class_inputeventjoypadbutton.rst index 9b1e57dae..334c99512 100644 --- a/classes/class_inputeventjoypadbutton.rst +++ b/classes/class_inputeventjoypadbutton.rst @@ -62,7 +62,7 @@ Button identifier. One of the ``JOY_BUTTON_*`` constants from :ref:`@GlobalScope | *Getter* | is_pressed() | +----------+--------------------+ -If ``true`` the button's state is pressed. If ``false`` the button's state is released. +If ``true``, the button's state is pressed. If ``false``, the button's state is released. .. _class_InputEventJoypadButton_pressure: diff --git a/classes/class_inputeventkey.rst b/classes/class_inputeventkey.rst index 1ad09cf87..e22b5497d 100644 --- a/classes/class_inputeventkey.rst +++ b/classes/class_inputeventkey.rst @@ -59,7 +59,7 @@ Property Descriptions | *Getter* | is_echo() | +----------+-----------------+ -If ``true`` the key was already pressed before this event. It means the user is holding the key down. +If ``true``, the key was already pressed before this event. It means the user is holding the key down. .. _class_InputEventKey_pressed: @@ -71,7 +71,7 @@ If ``true`` the key was already pressed before this event. It means the user is | *Getter* | is_pressed() | +----------+--------------------+ -If ``true`` the key's state is pressed. If ``false`` the key's state is released. +If ``true``, the key's state is pressed. If ``false``, the key's state is released. .. _class_InputEventKey_scancode: diff --git a/classes/class_inputeventmousebutton.rst b/classes/class_inputeventmousebutton.rst index 13c04da93..585317bc3 100644 --- a/classes/class_inputeventmousebutton.rst +++ b/classes/class_inputeventmousebutton.rst @@ -64,7 +64,7 @@ Mouse button identifier, one of the BUTTON\_\* or BUTTON_WHEEL\_\* constants in | *Getter* | is_doubleclick() | +----------+------------------------+ -If ``true`` the mouse button's state is a double-click. +If ``true``, the mouse button's state is a double-click. .. _class_InputEventMouseButton_factor: @@ -88,5 +88,5 @@ Magnitude. Amount (or delta) of the event. Used for scroll events, indicates scr | *Getter* | is_pressed() | +----------+--------------------+ -If ``true`` the mouse button's state is pressed. If ``false`` the mouse button's state is released. +If ``true``, the mouse button's state is pressed. If ``false``, the mouse button's state is released. diff --git a/classes/class_inputeventscreentouch.rst b/classes/class_inputeventscreentouch.rst index e1ca490ef..45d2780dd 100644 --- a/classes/class_inputeventscreentouch.rst +++ b/classes/class_inputeventscreentouch.rst @@ -76,5 +76,5 @@ Touch position. | *Getter* | is_pressed() | +----------+--------------------+ -If ``true`` the touch's state is pressed. If ``false`` the touch's state is released. +If ``true``, the touch's state is pressed. If ``false``, the touch's state is released. diff --git a/classes/class_interpolatedcamera.rst b/classes/class_interpolatedcamera.rst index d0a3d6d3c..9009bdf09 100644 --- a/classes/class_interpolatedcamera.rst +++ b/classes/class_interpolatedcamera.rst @@ -54,7 +54,7 @@ Property Descriptions | *Getter* | is_interpolation_enabled() | +----------+----------------------------------+ -If ``true`` and a target is set, the camera will move automatically. +If ``true``, and a target is set, the camera will move automatically. .. _class_InterpolatedCamera_speed: diff --git a/classes/class_itemlist.rst b/classes/class_itemlist.rst index de1fa1f4b..9ea1d1488 100644 --- a/classes/class_itemlist.rst +++ b/classes/class_itemlist.rst @@ -243,7 +243,7 @@ Property Descriptions | *Getter* | get_allow_reselect() | +----------+---------------------------+ -If ``true`` the currently selected item may be selected again. +If ``true``, the currently selected item may be selected again. .. _class_ItemList_allow_rmb_select: @@ -255,7 +255,7 @@ If ``true`` the currently selected item may be selected again. | *Getter* | get_allow_rmb_select() | +----------+-----------------------------+ -If ``true`` a right mouse button click can select items. +If ``true``, a right mouse button click can select items. .. _class_ItemList_auto_height: diff --git a/classes/class_joint.rst b/classes/class_joint.rst index 9db270d11..2306d5472 100644 --- a/classes/class_joint.rst +++ b/classes/class_joint.rst @@ -49,7 +49,7 @@ Property Descriptions | *Getter* | get_exclude_nodes_from_collision() | +----------+-----------------------------------------+ -If ``true`` the two bodies of the nodes are not able to collide with each other. +If ``true``, the two bodies of the nodes are not able to collide with each other. .. _class_Joint_nodes/node_a: diff --git a/classes/class_joint2d.rst b/classes/class_joint2d.rst index acec411af..218931369 100644 --- a/classes/class_joint2d.rst +++ b/classes/class_joint2d.rst @@ -61,7 +61,7 @@ When :ref:`node_a` and :ref:`node_b` | *Getter* | get_exclude_nodes_from_collision() | +----------+-----------------------------------------+ -If ``true`` :ref:`node_a` and :ref:`node_b` can collide. Default value: ``false``. +If ``true``, :ref:`node_a` and :ref:`node_b` can collide. Default value: ``false``. .. _class_Joint2D_node_a: diff --git a/classes/class_kinematicbody.rst b/classes/class_kinematicbody.rst index c90956615..3e1152285 100644 --- a/classes/class_kinematicbody.rst +++ b/classes/class_kinematicbody.rst @@ -93,6 +93,8 @@ If the body is at least this close to another body, this body will consider them | *Getter* | get_axis_lock() | +----------+----------------------+ +Lock the body's movement in the x-axis. + .. _class_KinematicBody_move_lock_y: - :ref:`bool` **move_lock_y** @@ -103,6 +105,8 @@ If the body is at least this close to another body, this body will consider them | *Getter* | get_axis_lock() | +----------+----------------------+ +Lock the body's movement in the y-axis. + .. _class_KinematicBody_move_lock_z: - :ref:`bool` **move_lock_z** @@ -113,6 +117,8 @@ If the body is at least this close to another body, this body will consider them | *Getter* | get_axis_lock() | +----------+----------------------+ +Lock the body's movement in the z-axis. + Method Descriptions ------------------- @@ -166,7 +172,7 @@ If ``test_only`` is ``true``, the body does not move but the would-be collision Moves the body along a vector. If the body collides with another, it will slide along the other body rather than stop immediately. If the other body is a ``KinematicBody`` or :ref:`RigidBody`, it will also be affected by the motion of the other body. You can use this to make moving or rotating platforms, or to make nodes push other nodes. -``linear_velocity`` is a value in pixels per second. Unlike in for example :ref:`move_and_collide`, you should *not* multiply it with ``delta`` — this is done by the method. +``linear_velocity`` is a value in pixels per second. Unlike in for example :ref:`move_and_collide`, you should *not* multiply it by ``delta`` — this is done by the method. ``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. diff --git a/classes/class_kinematicbody2d.rst b/classes/class_kinematicbody2d.rst index 98d358744..edce2e2cd 100644 --- a/classes/class_kinematicbody2d.rst +++ b/classes/class_kinematicbody2d.rst @@ -84,7 +84,7 @@ If the body is at least this close to another body, this body will consider them | *Getter* | is_sync_to_physics_enabled() | +----------+------------------------------+ -If ``true`` the body's movement will be synchronized to the physics frame. This is useful when animating movement via :ref:`AnimationPlayer`, for example on moving platforms. +If ``true``, the body's movement will be synchronized to the physics frame. This is useful when animating movement via :ref:`AnimationPlayer`, for example on moving platforms. Method Descriptions ------------------- @@ -137,7 +137,7 @@ Moves the body along the vector ``rel_vec``. The body will stop if it collides. Moves the body along a vector. If the body collides with another, it will slide along the other body rather than stop immediately. If the other body is a ``KinematicBody2D`` or :ref:`RigidBody2D`, it will also be affected by the motion of the other body. You can use this to make moving or rotating platforms, or to make nodes push other nodes. -``linear_velocity`` is a value in pixels per second. Unlike in for example :ref:`move_and_collide`, you should *not* multiply it with ``delta`` — this is done by the method. +``linear_velocity`` is a value in pixels per second. Unlike in for example :ref:`move_and_collide`, you should *not* multiply it by ``delta`` — this is done by the method. ``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. diff --git a/classes/class_light.rst b/classes/class_light.rst index 78f60fe5b..9cd66baa7 100644 --- a/classes/class_light.rst +++ b/classes/class_light.rst @@ -121,7 +121,7 @@ Property Descriptions | *Getter* | is_editor_only() | +----------+------------------------+ -If ``true`` the light only appears in the editor and will not be visible at runtime. Default value:``false``. +If ``true``, the light only appears in the editor and will not be visible at runtime. Default value:``false``. .. _class_Light_light_bake_mode: @@ -193,7 +193,7 @@ Secondary multiplier used with indirect light (light bounces). This works in bak | *Getter* | is_negative() | +----------+---------------------+ -If ``true`` the light's effect is reversed, darkening areas and casting bright shadows. Default value: ``false``. +If ``true``, the light's effect is reversed, darkening areas and casting bright shadows. Default value: ``false``. .. _class_Light_light_specular: @@ -253,7 +253,7 @@ Attempts to reduce :ref:`shadow_bias` gap. | *Getter* | has_shadow() | +----------+-------------------+ -If ``true`` the light will cast shadows. Default value: ``false``. +If ``true``, the light will cast shadows. Default value: ``false``. .. _class_Light_shadow_reverse_cull_face: diff --git a/classes/class_light2d.rst b/classes/class_light2d.rst index 2ea33e988..ed08c3821 100644 --- a/classes/class_light2d.rst +++ b/classes/class_light2d.rst @@ -124,7 +124,7 @@ The Light2D's :ref:`Color`. | *Getter* | is_editor_only() | +----------+------------------------+ -If ``true`` Light2D will only appear when editing the scene. Default value: ``false``. +If ``true``, Light2D will only appear when editing the scene. Default value: ``false``. .. _class_Light2D_enabled: @@ -136,7 +136,7 @@ If ``true`` Light2D will only appear when editing the scene. Default value: ``fa | *Getter* | is_enabled() | +----------+--------------------+ -If ``true`` Light2D will emit light. Default value: ``true``. +If ``true``, Light2D will emit light. Default value: ``true``. .. _class_Light2D_energy: @@ -280,7 +280,7 @@ Shadow buffer size. Default value: ``2048``. | *Getter* | is_shadow_enabled() | +----------+---------------------------+ -If ``true`` the Light2D will cast shadows. Default value: ``false``. +If ``true``, the Light2D will cast shadows. Default value: ``false``. .. _class_Light2D_shadow_filter: diff --git a/classes/class_lineedit.rst b/classes/class_lineedit.rst index d935bab24..6f6a86490 100644 --- a/classes/class_lineedit.rst +++ b/classes/class_lineedit.rst @@ -179,7 +179,7 @@ Text alignment as defined in the ALIGN\_\* enum. | *Getter* | cursor_get_blink_enabled() | +----------+---------------------------------+ -If ``true`` the caret (visual cursor) blinks. +If ``true``, the caret (visual cursor) blinks. .. _class_LineEdit_caret_blink_speed: @@ -215,7 +215,7 @@ The cursor's position inside the ``LineEdit``. When set, the text may scroll to | *Getter* | is_clear_button_enabled() | +----------+---------------------------------+ -If ``true`` the ``LineEdit`` will show a clear button if ``text`` is not empty. +If ``true``, the ``LineEdit`` will show a clear button if ``text`` is not empty. .. _class_LineEdit_context_menu_enabled: @@ -227,7 +227,7 @@ If ``true`` the ``LineEdit`` will show a clear button if ``text`` is not empty. | *Getter* | is_context_menu_enabled() | +----------+---------------------------------+ -If ``true`` the context menu will appear when right clicked. +If ``true``, the context menu will appear when right clicked. .. _class_LineEdit_editable: @@ -239,7 +239,7 @@ If ``true`` the context menu will appear when right clicked. | *Getter* | is_editable() | +----------+---------------------+ -If ``false`` existing text cannot be modified and new text cannot be added. +If ``false``, existing text cannot be modified and new text cannot be added. .. _class_LineEdit_expand_to_text_length: @@ -251,7 +251,7 @@ If ``false`` existing text cannot be modified and new text cannot be added. | *Getter* | get_expand_to_text_length() | +----------+----------------------------------+ -If ``true`` the :ref:`LineEdit` width will increase to stay longer than the :ref:`text`. It will **not** compress if the :ref:`text` is shortened. +If ``true``, the :ref:`LineEdit` width will increase to stay longer than the :ref:`text`. It will **not** compress if the :ref:`text` is shortened. .. _class_LineEdit_focus_mode: diff --git a/classes/class_mainloop.rst b/classes/class_mainloop.rst index abd1dd9cd..91b65e3b0 100644 --- a/classes/class_mainloop.rst +++ b/classes/class_mainloop.rst @@ -74,6 +74,8 @@ Constants - **NOTIFICATION_CRASH** = **92** +- **NOTIFICATION_OS_IME_UPDATE** = **93** + Description ----------- diff --git a/classes/class_menubutton.rst b/classes/class_menubutton.rst index be49ad978..f040fb273 100644 --- a/classes/class_menubutton.rst +++ b/classes/class_menubutton.rst @@ -16,6 +16,13 @@ Brief Description Special button that brings up a :ref:`PopupMenu` when clicked. +Properties +---------- + ++-------------------------+----------------------------------------------------------+ +| :ref:`bool` | :ref:`switch_on_hover` | ++-------------------------+----------------------------------------------------------+ + Methods ------- @@ -66,6 +73,21 @@ Description Special button that brings up a :ref:`PopupMenu` when clicked. That's pretty much all it does, as it's just a helper class when building GUIs. +Property Descriptions +--------------------- + +.. _class_MenuButton_switch_on_hover: + +- :ref:`bool` **switch_on_hover** + ++----------+----------------------------+ +| *Setter* | set_switch_on_hover(value) | ++----------+----------------------------+ +| *Getter* | is_switch_on_hover() | ++----------+----------------------------+ + +If ``true``, when the cursor hovers above another MenuButton within the same parent which also has ``switch_on_hover`` enabled, it will close the current MenuButton and open the other one. + Method Descriptions ------------------- diff --git a/classes/class_meshdatatool.rst b/classes/class_meshdatatool.rst index b378f7679..ea9018cac 100644 --- a/classes/class_meshdatatool.rst +++ b/classes/class_meshdatatool.rst @@ -111,9 +111,9 @@ Below is an example of how the MeshDataTool may be used. var mdt = MeshDataTool.new() mdt.create_from_surface(mesh, 0) for i in range(mdt.get_vertex_count()): - var vertex = mdt.get_vertex(i) - ... - mdt.set_vertex(i, vertex) + var vertex = mdt.get_vertex(i) + ... + mdt.set_vertex(i, vertex) mesh.surface_remove(0) mdt.commit_to_surface(mesh) diff --git a/classes/class_multiplayerapi.rst b/classes/class_multiplayerapi.rst index 41a3a49f9..eb7e4583b 100644 --- a/classes/class_multiplayerapi.rst +++ b/classes/class_multiplayerapi.rst @@ -146,7 +146,7 @@ The peer object to handle the RPC system (effectively enabling networking when s | *Getter* | is_refusing_new_network_connections() | +----------+-------------------------------------------+ -If ``true`` the MultiplayerAPI's :ref:`network_peer` refuses new incoming connections. +If ``true``, the MultiplayerAPI's :ref:`network_peer` refuses new incoming connections. Method Descriptions ------------------- diff --git a/classes/class_networkedmultiplayerpeer.rst b/classes/class_networkedmultiplayerpeer.rst index 9e3254815..25fbacca1 100644 --- a/classes/class_networkedmultiplayerpeer.rst +++ b/classes/class_networkedmultiplayerpeer.rst @@ -128,7 +128,7 @@ Property Descriptions | *Getter* | is_refusing_new_connections() | +----------+-----------------------------------+ -If ``true`` this ``NetworkedMultiplayerPeer`` refuses new connections. Default value: ``false``. +If ``true``, this ``NetworkedMultiplayerPeer`` refuses new connections. Default value: ``false``. .. _class_NetworkedMultiplayerPeer_transfer_mode: diff --git a/classes/class_node2d.rst b/classes/class_node2d.rst index 0a557d789..af5b0fa6a 100644 --- a/classes/class_node2d.rst +++ b/classes/class_node2d.rst @@ -217,7 +217,7 @@ Local :ref:`Transform2D`. | *Getter* | is_z_relative() | +----------+--------------------------+ -If ``true`` the node's Z-index is relative to its parent's Z-index. If this node's Z-index is 2 and its parent's effective Z-index is 3, then this node's effective Z-index will be 2 + 3 = 5. +If ``true``, the node's Z-index is relative to its parent's Z-index. If this node's Z-index is 2 and its parent's effective Z-index is 3, then this node's effective Z-index will be 2 + 3 = 5. .. _class_Node2D_z_index: diff --git a/classes/class_object.rst b/classes/class_object.rst index de4dc54c4..229313602 100644 --- a/classes/class_object.rst +++ b/classes/class_object.rst @@ -141,7 +141,9 @@ Constants Description ----------- -Base class for all non built-in types. Everything not a built-in type starts the inheritance chain from this class. +Base class for all non built-in types. Everything which is not a built-in type starts the inheritance chain from this class. + +Objects can be constructed from scripting languages, using ``Object.new()`` in GDScript, ``new Object`` in C#, or the "Construct Object" node in VisualScript. Objects do not manage memory, if inheriting from one the object will most likely have to be deleted manually (call the :ref:`free` function from the script or delete from C++). diff --git a/classes/class_occluderpolygon2d.rst b/classes/class_occluderpolygon2d.rst index 444a5918e..1e89a57e5 100644 --- a/classes/class_occluderpolygon2d.rst +++ b/classes/class_occluderpolygon2d.rst @@ -58,7 +58,7 @@ Property Descriptions | *Getter* | is_closed() | +----------+-------------------+ -If ``true`` closes the polygon. A closed OccluderPolygon2D occludes the light coming from any direction. An opened OccluderPolygon2D occludes the light only at its outline's direction. Default value ``true``. +If ``true``, closes the polygon. A closed OccluderPolygon2D occludes the light coming from any direction. An opened OccluderPolygon2D occludes the light only at its outline's direction. Default value ``true``. .. _class_OccluderPolygon2D_cull_mode: diff --git a/classes/class_orientedpathfollow.rst b/classes/class_orientedpathfollow.rst index bcc852113..3a9b4ff46 100644 --- a/classes/class_orientedpathfollow.rst +++ b/classes/class_orientedpathfollow.rst @@ -53,7 +53,7 @@ Property Descriptions | *Getter* | get_cubic_interpolation() | +----------+--------------------------------+ -If ``true`` the position between two cached points is interpolated cubically, and linearly otherwise. +If ``true``, the position between two cached points is interpolated cubically, and linearly otherwise. The points along the :ref:`Curve3D` of the :ref:`Path` are precomputed before use, for faster calculations. The point at the requested offset is then calculated interpolating between two adjacent cached points. This may present a problem if the curve makes sharp turns, as the cached points may not follow the curve closely enough. diff --git a/classes/class_os.rst b/classes/class_os.rst index 0e56ec3c5..03cee008b 100644 --- a/classes/class_os.rst +++ b/classes/class_os.rst @@ -97,6 +97,10 @@ Methods +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_executable_path` **(** **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_ime_selection` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_ime_text` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_latin_keyboard_variant` **(** **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_locale` **(** **)** const | @@ -135,6 +139,8 @@ Methods +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_system_dir` **(** :ref:`SystemDir` dir **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_system_time_msecs` **(** **)** const | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_system_time_secs` **(** **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_ticks_msec` **(** **)** const | @@ -211,6 +217,8 @@ Methods +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_icon` **(** :ref:`Image` icon **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ime_active` **(** :ref:`bool` active **)** | ++------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_ime_position` **(** :ref:`Vector2` position **)** | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`set_thread_name` **(** :ref:`String` name **)** | @@ -381,7 +389,7 @@ The exit code passed to the OS when the main loop exits. | *Getter* | is_keep_screen_on() | +----------+---------------------------+ -If ``true`` the engine tries to keep the screen on while the game is running. Useful on mobile. +If ``true``, the engine tries to keep the screen on while the game is running. Useful on mobile. .. _class_OS_low_processor_usage_mode: @@ -393,7 +401,7 @@ If ``true`` the engine tries to keep the screen on while the game is running. Us | *Getter* | is_in_low_processor_usage_mode() | +----------+-------------------------------------+ -If ``true`` the engine optimizes for low processor usage by only refreshing the screen if needed. Can improve battery consumption on mobile. +If ``true``, the engine optimizes for low processor usage by only refreshing the screen if needed. Can improve battery consumption on mobile. .. _class_OS_screen_orientation: @@ -417,7 +425,7 @@ The current screen orientation. | *Getter* | is_vsync_enabled() | +----------+----------------------+ -If ``true`` vertical synchronization (Vsync) is enabled. +If ``true``, vertical synchronization (Vsync) is enabled. .. _class_OS_window_borderless: @@ -429,7 +437,7 @@ If ``true`` vertical synchronization (Vsync) is enabled. | *Getter* | get_borderless_window() | +----------+------------------------------+ -If ``true`` removes the window frame. +If ``true``, removes the window frame. .. _class_OS_window_fullscreen: @@ -441,7 +449,7 @@ If ``true`` removes the window frame. | *Getter* | is_window_fullscreen() | +----------+------------------------------+ -If ``true`` the window is fullscreen. +If ``true``, the window is fullscreen. .. _class_OS_window_maximized: @@ -453,7 +461,7 @@ If ``true`` the window is fullscreen. | *Getter* | is_window_maximized() | +----------+-----------------------------+ -If ``true`` the window is maximized. +If ``true``, the window is maximized. .. _class_OS_window_minimized: @@ -465,7 +473,7 @@ If ``true`` the window is maximized. | *Getter* | is_window_minimized() | +----------+-----------------------------+ -If ``true`` the window is minimized. +If ``true``, the window is minimized. .. _class_OS_window_per_pixel_transparency_enabled: @@ -675,6 +683,18 @@ Returns an environment variable. Returns the path to the current engine executable. +.. _class_OS_get_ime_selection: + +- :ref:`Vector2` **get_ime_selection** **(** **)** const + +Returns IME selection range. + +.. _class_OS_get_ime_text: + +- :ref:`String` **get_ime_text** **(** **)** const + +Returns IME intermediate text. + .. _class_OS_get_latin_keyboard_variant: - :ref:`String` **get_latin_keyboard_variant** **(** **)** const @@ -803,6 +823,12 @@ Returns the amount of static memory being used by the program in bytes. Returns the actual path to commonly used folders across different platforms. Available locations are specified in OS.SystemDir. +.. _class_OS_get_system_time_msecs: + +- :ref:`int` **get_system_time_msecs** **(** **)** const + +Returns the epoch time of the operating system in milliseconds. + .. _class_OS_get_system_time_secs: - :ref:`int` **get_system_time_secs** **(** **)** const @@ -1045,10 +1071,18 @@ Request the user attention to the window. It'll flash the taskbar button on Wind Sets the game's icon. +.. _class_OS_set_ime_active: + +- void **set_ime_active** **(** :ref:`bool` active **)** + +Sets whether IME input mode should be enabled. + .. _class_OS_set_ime_position: - void **set_ime_position** **(** :ref:`Vector2` position **)** +Sets position of IME suggestion list popup (in window coordinates). + .. _class_OS_set_thread_name: - :ref:`Error` **set_thread_name** **(** :ref:`String` name **)** diff --git a/classes/class_parallaxbackground.rst b/classes/class_parallaxbackground.rst index 1d08034c1..d9160a5f2 100644 --- a/classes/class_parallaxbackground.rst +++ b/classes/class_parallaxbackground.rst @@ -75,7 +75,7 @@ Base motion scale of all :ref:`ParallaxLayer` children. | *Getter* | is_ignore_camera_zoom() | +----------+-------------------------------+ -If ``true`` elements in :ref:`ParallaxLayer` child aren't affected by the zoom level of the camera. +If ``true``, elements in :ref:`ParallaxLayer` child aren't affected by the zoom level of the camera. .. _class_ParallaxBackground_scroll_limit_begin: diff --git a/classes/class_particles.rst b/classes/class_particles.rst index 6b9d9bf6c..ecde28874 100644 --- a/classes/class_particles.rst +++ b/classes/class_particles.rst @@ -190,7 +190,7 @@ The number of draw passes when rendering particles. | *Getter* | is_emitting() | +----------+---------------------+ -If ``true`` particles are being emitted. Default value: ``true``. +If ``true``, particles are being emitted. Default value: ``true``. .. _class_Particles_explosiveness: @@ -246,7 +246,7 @@ Amount of time each particle will exist. Default value: ``1``. | *Getter* | get_use_local_coordinates() | +----------+----------------------------------+ -If ``true`` particles use the parent node's coordinate space. If ``false`` they use global coordinates. Default value: ``true``. +If ``true``, particles use the parent node's coordinate space. If ``false``, they use global coordinates. Default value: ``true``. .. _class_Particles_one_shot: @@ -258,7 +258,7 @@ If ``true`` particles use the parent node's coordinate space. If ``false`` they | *Getter* | get_one_shot() | +----------+---------------------+ -If ``true`` only ``amount`` particles will be emitted. Default value: ``false``. +If ``true``, only ``amount`` particles will be emitted. Default value: ``false``. .. _class_Particles_preprocess: diff --git a/classes/class_particles2d.rst b/classes/class_particles2d.rst index 0cdce090e..aacf1ebfb 100644 --- a/classes/class_particles2d.rst +++ b/classes/class_particles2d.rst @@ -117,7 +117,7 @@ Particle draw order. Uses ``DRAW_ORDER_*`` values. Default value: ``DRAW_ORDER_I | *Getter* | is_emitting() | +----------+---------------------+ -If ``true`` particles are being emitted. Default value: ``true``. +If ``true``, particles are being emitted. Default value: ``true``. .. _class_Particles2D_explosiveness: @@ -173,7 +173,7 @@ Amount of time each particle will exist. Default value: ``1``. | *Getter* | get_use_local_coordinates() | +----------+----------------------------------+ -If ``true`` particles use the parent node's coordinate space. If ``false`` they use global coordinates. Default value: ``true``. +If ``true``, particles use the parent node's coordinate space. If ``false``, they use global coordinates. Default value: ``true``. .. _class_Particles2D_normal_map: @@ -195,7 +195,7 @@ If ``true`` particles use the parent node's coordinate space. If ``false`` they | *Getter* | get_one_shot() | +----------+---------------------+ -If ``true`` only one emission cycle occurs. If set ``true`` during a cycle, emission will stop at the cycle's end. Default value: ``false``. +If ``true``, only one emission cycle occurs. If set ``true`` during a cycle, emission will stop at the cycle's end. Default value: ``false``. .. _class_Particles2D_preprocess: diff --git a/classes/class_particlesmaterial.rst b/classes/class_particlesmaterial.rst index b66cff322..08286909c 100644 --- a/classes/class_particlesmaterial.rst +++ b/classes/class_particlesmaterial.rst @@ -496,7 +496,7 @@ The sphere's radius if ``emission_shape`` is set to ``EMISSION_SHAPE_SPHERE``. | *Getter* | get_flag() | +----------+-----------------+ -If ``true`` particles will not move on the z axis. Default value: ``true`` for :ref:`Particles2D`, ``false`` for :ref:`Particles`. +If ``true``, particles will not move on the z axis. Default value: ``true`` for :ref:`Particles2D`, ``false`` for :ref:`Particles`. .. _class_ParticlesMaterial_flag_rotate_y: diff --git a/classes/class_pathfollow.rst b/classes/class_pathfollow.rst index efa9abad4..927fd5a7f 100644 --- a/classes/class_pathfollow.rst +++ b/classes/class_pathfollow.rst @@ -70,7 +70,7 @@ Property Descriptions | *Getter* | get_cubic_interpolation() | +----------+--------------------------------+ -If ``true`` the position between two cached points is interpolated cubically, and linearly otherwise. +If ``true``, the position between two cached points is interpolated cubically, and linearly otherwise. The points along the :ref:`Curve3D` of the :ref:`Path` are precomputed before use, for faster calculations. The point at the requested offset is then calculated interpolating between two adjacent cached points. This may present a problem if the curve makes sharp turns, as the cached points may not follow the curve closely enough. diff --git a/classes/class_pathfollow2d.rst b/classes/class_pathfollow2d.rst index 86dcf01db..4d7b80dac 100644 --- a/classes/class_pathfollow2d.rst +++ b/classes/class_pathfollow2d.rst @@ -57,7 +57,7 @@ Property Descriptions | *Getter* | get_cubic_interpolation() | +----------+--------------------------------+ -If ``true`` the position between two cached points is interpolated cubically, and linearly otherwise. +If ``true``, the position between two cached points is interpolated cubically, and linearly otherwise. The points along the :ref:`Curve2D` of the :ref:`Path2D` are precomputed before use, for faster calculations. The point at the requested offset is then calculated interpolating between two adjacent cached points. This may present a problem if the curve makes sharp turns, as the cached points may not follow the curve closely enough. diff --git a/classes/class_physicsdirectbodystate.rst b/classes/class_physicsdirectbodystate.rst index 108327f64..95948f6f8 100644 --- a/classes/class_physicsdirectbodystate.rst +++ b/classes/class_physicsdirectbodystate.rst @@ -246,7 +246,7 @@ Adds a constant rotational force (i.e. a motor) without affecting position. Applies a single directional impulse without affecting rotation. -This is equivalent to ``apply_impulse(Vector3(0,0,0), impulse)``. +This is equivalent to ``apply_impulse(Vector3(0, 0, 0), impulse)``. .. _class_PhysicsDirectBodyState_apply_impulse: diff --git a/classes/class_physicsserver.rst b/classes/class_physicsserver.rst index 6f5fa434f..1ba2879e9 100644 --- a/classes/class_physicsserver.rst +++ b/classes/class_physicsserver.rst @@ -336,9 +336,9 @@ enum **ShapeType**: enum **HingeJointFlag**: -- **HINGE_JOINT_FLAG_USE_LIMIT** = **0** --- If ``true`` the Hinge has a maximum and a minimum rotation. +- **HINGE_JOINT_FLAG_USE_LIMIT** = **0** --- If ``true``, the Hinge has a maximum and a minimum rotation. -- **HINGE_JOINT_FLAG_ENABLE_MOTOR** = **1** --- If ``true`` a motor turns the Hinge +- **HINGE_JOINT_FLAG_ENABLE_MOTOR** = **1** --- If ``true``, a motor turns the Hinge .. _enum_PhysicsServer_AreaParameter: @@ -666,7 +666,7 @@ Returns the transform matrix for an area. - :ref:`bool` **area_is_ray_pickable** **(** :ref:`RID` area **)** const -If ``true`` area collides with rays. +If ``true``, area collides with rays. .. _class_PhysicsServer_area_remove_shape: @@ -896,7 +896,7 @@ Returns a body state. - :ref:`bool` **body_is_continuous_collision_detection_enabled** **(** :ref:`RID` body **)** const -If ``true`` the continuous collision detection mode is enabled. +If ``true``, the continuous collision detection mode is enabled. .. _class_PhysicsServer_body_is_omitting_force_integration: @@ -908,7 +908,7 @@ Returns whether a body uses a callback function to calculate its own physics (se - :ref:`bool` **body_is_ray_pickable** **(** :ref:`RID` body **)** const -If ``true`` the body can be detected by rays +If ``true``, the body can be detected by rays .. _class_PhysicsServer_body_remove_collision_exception: @@ -950,7 +950,7 @@ Sets the physics layer or layers a body can collide with. - void **body_set_enable_continuous_collision_detection** **(** :ref:`RID` body, :ref:`bool` enable **)** -If ``true`` the continuous collision detection mode is enabled. +If ``true``, the continuous collision detection mode is enabled. Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. diff --git a/classes/class_pluginscript.rst b/classes/class_pluginscript.rst index d659cf117..c3f99f5a7 100644 --- a/classes/class_pluginscript.rst +++ b/classes/class_pluginscript.rst @@ -16,3 +16,19 @@ Brief Description +Methods +------- + ++------------------------------+-------------------------------------------------------+ +| :ref:`Object` | :ref:`new` **(** **)** vararg | ++------------------------------+-------------------------------------------------------+ + +Method Descriptions +------------------- + +.. _class_PluginScript_new: + +- :ref:`Object` **new** **(** **)** vararg + +Returns a new instance of the script. + diff --git a/classes/class_polygon2d.rst b/classes/class_polygon2d.rst index 1c76c9ded..a932b6596 100644 --- a/classes/class_polygon2d.rst +++ b/classes/class_polygon2d.rst @@ -92,7 +92,7 @@ Property Descriptions | *Getter* | get_antialiased() | +----------+------------------------+ -If ``true`` polygon edges will be anti-aliased. Default value: ``false``. +If ``true``, polygon edges will be anti-aliased. Default value: ``false``. .. _class_Polygon2D_bones: @@ -132,7 +132,7 @@ Added padding applied to the bounding box when using ``invert``. Setting this va | *Getter* | get_invert() | +----------+-------------------+ -If ``true`` polygon will be inverted, containing the area outside the defined points and extending to the ``invert_border``. Default value: ``false``. +If ``true``, polygon will be inverted, containing the area outside the defined points and extending to the ``invert_border``. Default value: ``false``. .. _class_Polygon2D_offset: diff --git a/classes/class_popup.rst b/classes/class_popup.rst index e6a90c5ca..0b25ba989 100644 --- a/classes/class_popup.rst +++ b/classes/class_popup.rst @@ -78,7 +78,7 @@ Property Descriptions | *Getter* | is_exclusive() | +----------+----------------------+ -If ``true`` the popup will not be hidden when a click event occurs outside of it, or when it receives the ``ui_cancel`` action event. +If ``true``, the popup will not be hidden when a click event occurs outside of it, or when it receives the ``ui_cancel`` action event. Method Descriptions ------------------- @@ -93,17 +93,17 @@ Popup (show the control in modal form). - void **popup_centered** **(** :ref:`Vector2` size=Vector2( 0, 0 ) **)** -Popup (show the control in modal form) in the center of the screen, at the current size, or at a size determined by "size". +Popup (show the control in modal form) in the center of the screen relative to its current canvas transform, at the current size, or at a size determined by "size". .. _class_Popup_popup_centered_minsize: - void **popup_centered_minsize** **(** :ref:`Vector2` minsize=Vector2( 0, 0 ) **)** -Popup (show the control in modal form) in the center of the screen, ensuring the size is never smaller than ``minsize``. +Popup (show the control in modal form) in the center of the screen relative to the current canvas transform, ensuring the size is never smaller than ``minsize``. .. _class_Popup_popup_centered_ratio: - void **popup_centered_ratio** **(** :ref:`float` ratio=0.75 **)** -Popup (show the control in modal form) in the center of the screen, scaled at a ratio of size of the screen. +Popup (show the control in modal form) in the center of the screen relative to the current canvas transform, scaled at a ratio of size of the screen. diff --git a/classes/class_progressbar.rst b/classes/class_progressbar.rst index 078b65ce5..479c9d765 100644 --- a/classes/class_progressbar.rst +++ b/classes/class_progressbar.rst @@ -56,5 +56,5 @@ Property Descriptions | *Getter* | is_percent_visible() | +----------+----------------------------+ -If ``true`` the fill percentage is displayed on the bar. Default value: ``true``. +If ``true``, the fill percentage is displayed on the bar. Default value: ``true``. diff --git a/classes/class_projectsettings.rst b/classes/class_projectsettings.rst index d7cf969d3..6f0e7df96 100644 --- a/classes/class_projectsettings.rst +++ b/classes/class_projectsettings.rst @@ -32,6 +32,8 @@ Properties +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`application/config/name` | +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`application/config/project_settings_override` | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`application/config/use_custom_user_dir` | +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`application/run/disable_stderr` | @@ -52,6 +54,8 @@ Properties +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`audio/driver` | +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`audio/enable_audio_input` | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`audio/mix_rate` | +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`audio/output_latency` | @@ -596,9 +600,9 @@ Path to an image used for boot splash. - :ref:`String` **application/config/custom_user_dir_name** -This directory is used for storing persistent data (user:// filesystem). If a custom name is set, then system paths will be used to store this on Desktop (AppData on Windows, user ~/.config on Unixes, etc), else the Godot config folder is used. This name needs to be unique, and it's recommended to set it to something before publishing. +This user directory is used for storing persistent data (``user://`` filesystem). By default (no custom name defined), ``user://`` resolves to a project-specific folder in Godot's own configuration folder (see :ref:`OS.get_user_data_dir`). If a custom directory name is defined, this name will be used instead and appended to the system-specific user data directory (same parent folder as the Godot configuration folder documented in :ref:`OS.get_user_data_dir`). -the "use_custom_user_dir" setting must be enabled for this to take effect. +The :ref:`use_custom_user_dir` setting must be enabled for this to take effect. .. _class_ProjectSettings_application/config/icon: @@ -612,11 +616,17 @@ Icon used for the project, set when project loads. Exporters will use this icon Name of the project. It is used from both project manager and by the exporters. Overriding this as name.locale allows setting it in multiple languages. +.. _class_ProjectSettings_application/config/project_settings_override: + +- :ref:`String` **application/config/project_settings_override** + +Specifies a file to override project settings. For example: ``user://custom_settings.cfg``. + .. _class_ProjectSettings_application/config/use_custom_user_dir: - :ref:`bool` **application/config/use_custom_user_dir** -Allow the project to save to its own custom user dir (in AppData on windows or ~/.config on unixes). This setting only works for desktop exporters. A name must be set in the "custom_user_dir_name" setting for this to take effect. +Allow the project to save to its own custom user dir (see :ref:`custom_user_dir_name`). This setting only works for desktop platforms. A name must be set in the :ref:`custom_user_dir_name` setting for this to take effect. .. _class_ProjectSettings_application/run/disable_stderr: @@ -670,6 +680,12 @@ Audio buses will disable automatically when sound goes below a given DB threshol - :ref:`String` **audio/driver** +.. _class_ProjectSettings_audio/enable_audio_input: + +- :ref:`bool` **audio/enable_audio_input** + +This option should be enabled if project works with microphone. + .. _class_ProjectSettings_audio/mix_rate: - :ref:`int` **audio/mix_rate** @@ -1406,13 +1422,13 @@ Log all output to a file. - :ref:`String` **logging/file_logging/log_path** -Path to logs withint he project. Using an user:// based path is recommended. +Path to logs withint he project. Using an ``user://`` based path is recommended. .. _class_ProjectSettings_logging/file_logging/max_log_files: - :ref:`int` **logging/file_logging/max_log_files** -Amount of log files (used for rotation)/ +Amount of log files (used for rotation). .. _class_ProjectSettings_memory/limits/message_queue/max_size_kb: @@ -1801,7 +1817,7 @@ Method Descriptions - void **add_property_info** **(** :ref:`Dictionary` hint **)** -Add a custom property info to a property. The dictionary must contain: name::ref:`String`(the name of the property) and type::ref:`int`(see TYPE\_\* in :ref:`@GlobalScope`), and optionally hint::ref:`int`(see PROPERTY_HINT\_\* in :ref:`@GlobalScope`), hint_string::ref:`String`. +Add a custom property info to a property. The dictionary must contain: name::ref:`String`\ (the name of the property) and type::ref:`int`\ (see TYPE\_\* in :ref:`@GlobalScope`), and optionally hint::ref:`int`\ (see PROPERTY_HINT\_\* in :ref:`@GlobalScope`), hint_string::ref:`String`. Example: diff --git a/classes/class_randomnumbergenerator.rst b/classes/class_randomnumbergenerator.rst index 5d617056c..f4f00e6a4 100644 --- a/classes/class_randomnumbergenerator.rst +++ b/classes/class_randomnumbergenerator.rst @@ -26,15 +26,17 @@ Properties Methods ------- -+----------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`rand_range` **(** :ref:`float` from, :ref:`float` to **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`randf` **(** **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`randi` **(** **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`randomize` **(** **)** | -+----------------------------+------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| :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` **(** **)** | ++----------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- @@ -52,23 +54,29 @@ Property Descriptions Method Descriptions ------------------- -.. _class_RandomNumberGenerator_rand_range: - -- :ref:`float` **rand_range** **(** :ref:`float` from, :ref:`float` to **)** - -Generates pseudo-random float between ``from`` and ``to``. - .. _class_RandomNumberGenerator_randf: - :ref:`float` **randf** **(** **)** Generates pseudo-random float between '0.0' and '1.0'. +.. _class_RandomNumberGenerator_randf_range: + +- :ref:`float` **randf_range** **(** :ref:`float` from, :ref:`float` to **)** + +Generates pseudo-random float between ``from`` and ``to``. + .. _class_RandomNumberGenerator_randi: - :ref:`int` **randi** **(** **)** -Generates pseudo-random 32-bit integer between '0' and '4294967295'. +Generates pseudo-random 32-bit unsigned integer between '0' and '4294967295'. + +.. _class_RandomNumberGenerator_randi_range: + +- :ref:`int` **randi_range** **(** :ref:`int` from, :ref:`int` to **)** + +Generates pseudo-random 32-bit signed integer between ``from`` and ``to``\ (inclusive). .. _class_RandomNumberGenerator_randomize: diff --git a/classes/class_range.rst b/classes/class_range.rst index b65b40a9d..8bdde6503 100644 --- a/classes/class_range.rst +++ b/classes/class_range.rst @@ -85,7 +85,7 @@ Property Descriptions | *Getter* | is_greater_allowed() | +----------+--------------------------+ -If ``true`` :ref:`value` may be greater than :ref:`max_value`. Default value: ``false``. +If ``true``, :ref:`value` may be greater than :ref:`max_value`. Default value: ``false``. .. _class_Range_allow_lesser: @@ -97,7 +97,7 @@ If ``true`` :ref:`value` may be greater than :ref:`max_value< | *Getter* | is_lesser_allowed() | +----------+-------------------------+ -If ``true`` :ref:`value` may be less than :ref:`min_value`. Default value: ``false``. +If ``true``, :ref:`value` may be less than :ref:`min_value`. Default value: ``false``. .. _class_Range_exp_edit: @@ -109,7 +109,7 @@ If ``true`` :ref:`value` may be less than :ref:`min_value` -**Inherited By:** :ref:`RegExMatch`, :ref:`RegEx`, :ref:`EncodedObjectAsID`, :ref:`SurfaceTool`, :ref:`SpatialGizmo`, :ref:`TriangleMesh`, :ref:`AnimationTrackEditPlugin`, :ref:`EditorScenePostImport`, :ref:`Expression`, :ref:`PhysicsShapeQueryResult`, :ref:`EditorSceneImporter`, :ref:`Physics2DTestMotionResult`, :ref:`FuncRef`, :ref:`File`, :ref:`TCP_Server`, :ref:`Physics2DShapeQueryResult`, :ref:`ConfigFile`, :ref:`StreamPeer`, :ref:`GDScriptNativeClass`, :ref:`HTTPClient`, :ref:`AudioStreamPlayback`, :ref:`VisualScriptFunctionState`, :ref:`EditorInspectorPlugin`, :ref:`Resource`, :ref:`KinematicCollision`, :ref:`JSONParseResult`, :ref:`SpatialVelocityTracker`, :ref:`EditorResourcePreviewGenerator`, :ref:`Physics2DShapeQueryParameters`, :ref:`EditorExportPlugin`, :ref:`ARVRInterface`, :ref:`UPNP`, :ref:`EditorScript`, :ref:`MultiplayerAPI`, :ref:`Mutex`, :ref:`PacketPeer`, :ref:`Semaphore`, :ref:`XMLParser`, :ref:`EditorImportPlugin`, :ref:`Directory`, :ref:`WeakRef`, :ref:`GDScriptFunctionState`, :ref:`Marshalls`, :ref:`SceneState`, :ref:`PCKPacker`, :ref:`MeshDataTool`, :ref:`AStar`, :ref:`ResourceImporter`, :ref:`RandomNumberGenerator`, :ref:`EditorResourceConversionPlugin`, :ref:`SceneTreeTimer`, :ref:`UPNPDevice`, :ref:`Thread`, :ref:`ResourceInteractiveLoader`, :ref:`PackedDataContainerRef`, :ref:`KinematicCollision2D`, :ref:`GDNative`, :ref:`PhysicsShapeQueryParameters` +**Inherited By:** :ref:`RegExMatch`, :ref:`RegEx`, :ref:`EncodedObjectAsID`, :ref:`SurfaceTool`, :ref:`SpatialGizmo`, :ref:`TriangleMesh`, :ref:`AnimationTrackEditPlugin`, :ref:`EditorScenePostImport`, :ref:`Expression`, :ref:`PhysicsShapeQueryResult`, :ref:`EditorSceneImporter`, :ref:`Physics2DTestMotionResult`, :ref:`FuncRef`, :ref:`File`, :ref:`TCP_Server`, :ref:`Physics2DShapeQueryResult`, :ref:`ConfigFile`, :ref:`StreamPeer`, :ref:`GDScriptNativeClass`, :ref:`HTTPClient`, :ref:`AudioStreamPlayback`, :ref:`VisualScriptFunctionState`, :ref:`EditorInspectorPlugin`, :ref:`Resource`, :ref:`KinematicCollision`, :ref:`JSONParseResult`, :ref:`SpatialVelocityTracker`, :ref:`EditorResourcePreviewGenerator`, :ref:`Physics2DShapeQueryParameters`, :ref:`EditorExportPlugin`, :ref:`ARVRInterface`, :ref:`UPNP`, :ref:`EditorScript`, :ref:`MultiplayerAPI`, :ref:`Mutex`, :ref:`XMLParser`, :ref:`PacketPeer`, :ref:`Semaphore`, :ref:`EditorImportPlugin`, :ref:`Directory`, :ref:`WeakRef`, :ref:`GDScriptFunctionState`, :ref:`Marshalls`, :ref:`ResourceFormatSaver`, :ref:`SceneState`, :ref:`ResourceFormatLoader`, :ref:`PCKPacker`, :ref:`MeshDataTool`, :ref:`AStar`, :ref:`ResourceImporter`, :ref:`RandomNumberGenerator`, :ref:`EditorResourceConversionPlugin`, :ref:`SceneTreeTimer`, :ref:`UPNPDevice`, :ref:`Thread`, :ref:`PackedDataContainerRef`, :ref:`ResourceInteractiveLoader`, :ref:`KinematicCollision2D`, :ref:`GDNative`, :ref:`PhysicsShapeQueryParameters` **Category:** Core diff --git a/classes/class_remotetransform.rst b/classes/class_remotetransform.rst index 76d880013..fcd1a61aa 100644 --- a/classes/class_remotetransform.rst +++ b/classes/class_remotetransform.rst @@ -63,7 +63,7 @@ The :ref:`NodePath` to the remote node, relative to the RemoteTr | *Getter* | get_update_position() | +----------+----------------------------+ -If ``true`` the remote node's position is updated. Default value: ``true``. +If ``true``, the remote node's position is updated. Default value: ``true``. .. _class_RemoteTransform_update_rotation: @@ -75,7 +75,7 @@ If ``true`` the remote node's position is updated. Default value: ``true``. | *Getter* | get_update_rotation() | +----------+----------------------------+ -If ``true`` the remote node's rotation is updated. Default value: ``true``. +If ``true``, the remote node's rotation is updated. Default value: ``true``. .. _class_RemoteTransform_update_scale: @@ -87,7 +87,7 @@ If ``true`` the remote node's rotation is updated. Default value: ``true``. | *Getter* | get_update_scale() | +----------+-------------------------+ -If ``true`` the remote node's scale is updated. Default value: ``true``. +If ``true``, the remote node's scale is updated. Default value: ``true``. .. _class_RemoteTransform_use_global_coordinates: @@ -99,5 +99,5 @@ If ``true`` the remote node's scale is updated. Default value: ``true``. | *Getter* | get_use_global_coordinates() | +----------+-----------------------------------+ -If ``true`` global coordinates are used. If ``false`` local coordinates are used. Default value: ``true``. +If ``true``, global coordinates are used. If ``false``, local coordinates are used. Default value: ``true``. diff --git a/classes/class_remotetransform2d.rst b/classes/class_remotetransform2d.rst index f8720bde5..b5201185e 100644 --- a/classes/class_remotetransform2d.rst +++ b/classes/class_remotetransform2d.rst @@ -63,7 +63,7 @@ The :ref:`NodePath` to the remote node, relative to the RemoteTr | *Getter* | get_update_position() | +----------+----------------------------+ -If ``true`` the remote node's position is updated. Default value: ``true``. +If ``true``, the remote node's position is updated. Default value: ``true``. .. _class_RemoteTransform2D_update_rotation: @@ -75,7 +75,7 @@ If ``true`` the remote node's position is updated. Default value: ``true``. | *Getter* | get_update_rotation() | +----------+----------------------------+ -If ``true`` the remote node's rotation is updated. Default value: ``true``. +If ``true``, the remote node's rotation is updated. Default value: ``true``. .. _class_RemoteTransform2D_update_scale: @@ -87,7 +87,7 @@ If ``true`` the remote node's rotation is updated. Default value: ``true``. | *Getter* | get_update_scale() | +----------+-------------------------+ -If ``true`` the remote node's scale is updated. Default value: ``true``. +If ``true``, the remote node's scale is updated. Default value: ``true``. .. _class_RemoteTransform2D_use_global_coordinates: @@ -99,5 +99,5 @@ If ``true`` the remote node's scale is updated. Default value: ``true``. | *Getter* | get_use_global_coordinates() | +----------+-----------------------------------+ -If ``true`` global coordinates are used. If ``false`` local coordinates are used. Default value: ``true``. +If ``true``, global coordinates are used. If ``false``, local coordinates are used. Default value: ``true``. diff --git a/classes/class_resource.rst b/classes/class_resource.rst index af1e94249..b7467a575 100644 --- a/classes/class_resource.rst +++ b/classes/class_resource.rst @@ -9,7 +9,7 @@ Resource **Inherits:** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`AnimationNodeStateMachinePlayback`, :ref:`AudioStream`, :ref:`Sky`, :ref:`Theme`, :ref:`TextureLayered`, :ref:`CubeMap`, :ref:`DynamicFontData`, :ref:`InputEvent`, :ref:`VisualShaderNode`, :ref:`Curve2D`, :ref:`Image`, :ref:`Shape`, :ref:`Shape2D`, :ref:`Curve`, :ref:`Mesh`, :ref:`StyleBox`, :ref:`Environment`, :ref:`GDNativeLibrary`, :ref:`Material`, :ref:`PhysicsMaterial`, :ref:`VideoStream`, :ref:`PackedScene`, :ref:`Texture`, :ref:`TextFile`, :ref:`ButtonGroup`, :ref:`TileSet`, :ref:`ShortCut`, :ref:`OpenSimplexNoise`, :ref:`BitMap`, :ref:`Animation`, :ref:`BakedLightmapData`, :ref:`PolygonPathFinder`, :ref:`Translation`, :ref:`Shader`, :ref:`Script`, :ref:`AudioBusLayout`, :ref:`AnimationNode`, :ref:`World`, :ref:`AudioEffect`, :ref:`VisualScriptNode`, :ref:`AnimationNodeStateMachineTransition`, :ref:`World2D`, :ref:`GIProbeData`, :ref:`Font`, :ref:`SpriteFrames`, :ref:`MeshLibrary`, :ref:`Curve3D`, :ref:`NavigationPolygon`, :ref:`EditorSettings`, :ref:`Gradient`, :ref:`OccluderPolygon2D`, :ref:`MultiMesh`, :ref:`PackedDataContainer`, :ref:`NavigationMesh` +**Inherited By:** :ref:`AnimationNodeStateMachinePlayback`, :ref:`AudioStream`, :ref:`Sky`, :ref:`Theme`, :ref:`TextureLayered`, :ref:`DynamicFontData`, :ref:`InputEvent`, :ref:`VisualShaderNode`, :ref:`Curve2D`, :ref:`Image`, :ref:`Shape`, :ref:`Shape2D`, :ref:`Curve`, :ref:`Mesh`, :ref:`StyleBox`, :ref:`Environment`, :ref:`CubeMap`, :ref:`GDNativeLibrary`, :ref:`Material`, :ref:`PhysicsMaterial`, :ref:`VideoStream`, :ref:`PackedScene`, :ref:`Texture`, :ref:`TextFile`, :ref:`ButtonGroup`, :ref:`TileSet`, :ref:`ShortCut`, :ref:`OpenSimplexNoise`, :ref:`BitMap`, :ref:`Animation`, :ref:`BakedLightmapData`, :ref:`PolygonPathFinder`, :ref:`Translation`, :ref:`Shader`, :ref:`Script`, :ref:`AudioBusLayout`, :ref:`AnimationNode`, :ref:`World`, :ref:`AudioEffect`, :ref:`VisualScriptNode`, :ref:`AnimationNodeStateMachineTransition`, :ref:`World2D`, :ref:`GIProbeData`, :ref:`Font`, :ref:`SpriteFrames`, :ref:`MeshLibrary`, :ref:`Curve3D`, :ref:`NavigationPolygon`, :ref:`EditorSettings`, :ref:`Gradient`, :ref:`OccluderPolygon2D`, :ref:`MultiMesh`, :ref:`PackedDataContainer`, :ref:`NavigationMesh` **Category:** Core diff --git a/classes/class_resourceformatdds.rst b/classes/class_resourceformatdds.rst new file mode 100644 index 000000000..8181b2277 --- /dev/null +++ b/classes/class_resourceformatdds.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the ResourceFormatDDS.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_ResourceFormatDDS: + +ResourceFormatDDS +================= + +**Inherits:** :ref:`ResourceFormatLoader` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_resourceformatimporter.rst b/classes/class_resourceformatimporter.rst new file mode 100644 index 000000000..1ebb7b6fa --- /dev/null +++ b/classes/class_resourceformatimporter.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the ResourceFormatImporter.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_ResourceFormatImporter: + +ResourceFormatImporter +====================== + +**Inherits:** :ref:`ResourceFormatLoader` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_resourceformatloader.rst b/classes/class_resourceformatloader.rst new file mode 100644 index 000000000..5ee61899d --- /dev/null +++ b/classes/class_resourceformatloader.rst @@ -0,0 +1,85 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the ResourceFormatLoader.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_ResourceFormatLoader: + +ResourceFormatLoader +==================== + +**Inherits:** :ref:`Reference` **<** :ref:`Object` + +**Inherited By:** :ref:`ResourceFormatLoaderNativeScript`, :ref:`ResourceFormatLoaderText`, :ref:`ResourceFormatLoaderGDScript`, :ref:`ResourceFormatPVR`, :ref:`GDNativeLibraryResourceLoader`, :ref:`ResourceFormatLoaderWebm`, :ref:`ResourceFormatLoaderDynamicFont`, :ref:`ResourceFormatLoaderStreamTexture`, :ref:`ResourceFormatLoaderTheora`, :ref:`ResourceFormatLoaderTextureLayered`, :ref:`ResourceFormatImporter`, :ref:`TranslationLoaderPO`, :ref:`ResourceFormatLoaderImage`, :ref:`ResourceFormatLoaderBinary`, :ref:`ResourceFormatDDS`, :ref:`ResourceFormatLoaderBMFont`, :ref:`ResourceFormatLoaderShader`, :ref:`ResourceFormatPKM` + +**Category:** Core + +Brief Description +----------------- + +Loads a specific resource type from a file. + +Methods +------- + ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`get_dependencies` **(** :ref:`String` path, :ref:`String` add_types **)** virtual | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_recognized_extensions` **(** **)** virtual | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_resource_type` **(** :ref:`String` path **)** virtual | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`handles_type` **(** :ref:`String` typename **)** virtual | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`load` **(** :ref:`String` path, :ref:`String` original_path **)** virtual | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rename_dependencies` **(** :ref:`String` path, :ref:`String` renames **)** virtual | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Description +----------- + +Godot loads resources in the editor or in exported games using ResourceFormatLoaders. They get queried when you call ``load``, or when a resource with internal dependencies is loaded. Each file type may load as a different resource type, so multiple ResourceFormatLoader are registered in the engine. + +Extending this class allows you to define your own. You should give it a global class name with ``class_name`` for it to be registered. You may as well implement a :ref:`ResourceFormatSaver`. + +Note: You can also extend :ref:`EditorImportPlugin` if the resource type you need exists but Godot is unable to load its format. Choosing one way over another depends if the format is suitable or not for the final exported game. Example: it's better to import .PNG textures as .STEX first, so they can be loaded with better efficiency on the graphics card. + +Method Descriptions +------------------- + +.. _class_ResourceFormatLoader_get_dependencies: + +- void **get_dependencies** **(** :ref:`String` path, :ref:`String` add_types **)** virtual + +If implemented, gets the dependencies of a given resource. If ``add_types`` is ``true``, paths should be appended ``::TypeName``, where ``TypeName`` is the class name of the dependency. Note that custom resource types defined by scripts aren't known by the :ref:`ClassDB`, so you might just return ``Resource`` for them. + +.. _class_ResourceFormatLoader_get_recognized_extensions: + +- :ref:`PoolStringArray` **get_recognized_extensions** **(** **)** virtual + +Gets the list of extensions for files this loader is able to read. + +.. _class_ResourceFormatLoader_get_resource_type: + +- :ref:`String` **get_resource_type** **(** :ref:`String` path **)** virtual + +Gets the class name of the resource associated with the given path. If the loader cannot handle it, it should return ``""``. Note that custom resource types defined by scripts aren't known by the :ref:`ClassDB`, so you might just return ``"Resource"`` for them. + +.. _class_ResourceFormatLoader_handles_type: + +- :ref:`bool` **handles_type** **(** :ref:`String` typename **)** virtual + +Tells which resource class this loader can load. Note that custom resource types defined by scripts aren't known by the :ref:`ClassDB`, so you might just handle ``"Resource"`` for them. + +.. _class_ResourceFormatLoader_load: + +- :ref:`Variant` **load** **(** :ref:`String` path, :ref:`String` original_path **)** virtual + +Loads a resource when the engine finds this loader to be compatible. If the loaded resource is the result of an import, ``original_path`` will target the source file. Returns a resource object if succeeded, or an ``ERR_*`` constant listed in :ref:`@GlobalScope` if it failed. + +.. _class_ResourceFormatLoader_rename_dependencies: + +- :ref:`int` **rename_dependencies** **(** :ref:`String` path, :ref:`String` renames **)** virtual + +If implemented, renames dependencies within the given resource and saves it. ``renames`` is a dictionary ``{ String => String }`` mapping old dependency paths to new paths. Returns ``OK`` on success, or an ``ERR_*`` constant listed in :ref:`@GlobalScope` in case of failure. + diff --git a/classes/class_resourceformatloaderbinary.rst b/classes/class_resourceformatloaderbinary.rst new file mode 100644 index 000000000..2c21ec603 --- /dev/null +++ b/classes/class_resourceformatloaderbinary.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the ResourceFormatLoaderBinary.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_ResourceFormatLoaderBinary: + +ResourceFormatLoaderBinary +========================== + +**Inherits:** :ref:`ResourceFormatLoader` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_resourceformatloaderbmfont.rst b/classes/class_resourceformatloaderbmfont.rst new file mode 100644 index 000000000..e7df15722 --- /dev/null +++ b/classes/class_resourceformatloaderbmfont.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the ResourceFormatLoaderBMFont.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_ResourceFormatLoaderBMFont: + +ResourceFormatLoaderBMFont +========================== + +**Inherits:** :ref:`ResourceFormatLoader` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_resourceformatloaderdynamicfont.rst b/classes/class_resourceformatloaderdynamicfont.rst new file mode 100644 index 000000000..8c4dbc2f7 --- /dev/null +++ b/classes/class_resourceformatloaderdynamicfont.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the ResourceFormatLoaderDynamicFont.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_ResourceFormatLoaderDynamicFont: + +ResourceFormatLoaderDynamicFont +=============================== + +**Inherits:** :ref:`ResourceFormatLoader` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_resourceformatloadergdscript.rst b/classes/class_resourceformatloadergdscript.rst new file mode 100644 index 000000000..568fa1c7b --- /dev/null +++ b/classes/class_resourceformatloadergdscript.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the ResourceFormatLoaderGDScript.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_ResourceFormatLoaderGDScript: + +ResourceFormatLoaderGDScript +============================ + +**Inherits:** :ref:`ResourceFormatLoader` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_resourceformatloaderimage.rst b/classes/class_resourceformatloaderimage.rst new file mode 100644 index 000000000..fe09aa7cb --- /dev/null +++ b/classes/class_resourceformatloaderimage.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the ResourceFormatLoaderImage.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_ResourceFormatLoaderImage: + +ResourceFormatLoaderImage +========================= + +**Inherits:** :ref:`ResourceFormatLoader` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_resourceformatloadernativescript.rst b/classes/class_resourceformatloadernativescript.rst new file mode 100644 index 000000000..e1a6414df --- /dev/null +++ b/classes/class_resourceformatloadernativescript.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the ResourceFormatLoaderNativeScript.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_ResourceFormatLoaderNativeScript: + +ResourceFormatLoaderNativeScript +================================ + +**Inherits:** :ref:`ResourceFormatLoader` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_resourceformatloadershader.rst b/classes/class_resourceformatloadershader.rst new file mode 100644 index 000000000..500efe0eb --- /dev/null +++ b/classes/class_resourceformatloadershader.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the ResourceFormatLoaderShader.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_ResourceFormatLoaderShader: + +ResourceFormatLoaderShader +========================== + +**Inherits:** :ref:`ResourceFormatLoader` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_resourceformatloaderstreamtexture.rst b/classes/class_resourceformatloaderstreamtexture.rst new file mode 100644 index 000000000..1835601ef --- /dev/null +++ b/classes/class_resourceformatloaderstreamtexture.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the ResourceFormatLoaderStreamTexture.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_ResourceFormatLoaderStreamTexture: + +ResourceFormatLoaderStreamTexture +================================= + +**Inherits:** :ref:`ResourceFormatLoader` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_resourceformatloadertext.rst b/classes/class_resourceformatloadertext.rst new file mode 100644 index 000000000..877027091 --- /dev/null +++ b/classes/class_resourceformatloadertext.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the ResourceFormatLoaderText.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_ResourceFormatLoaderText: + +ResourceFormatLoaderText +======================== + +**Inherits:** :ref:`ResourceFormatLoader` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_resourceformatloadertexturelayered.rst b/classes/class_resourceformatloadertexturelayered.rst new file mode 100644 index 000000000..e758f18a4 --- /dev/null +++ b/classes/class_resourceformatloadertexturelayered.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the ResourceFormatLoaderTextureLayered.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_ResourceFormatLoaderTextureLayered: + +ResourceFormatLoaderTextureLayered +================================== + +**Inherits:** :ref:`ResourceFormatLoader` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_resourceformatloadertheora.rst b/classes/class_resourceformatloadertheora.rst new file mode 100644 index 000000000..72b93c1e8 --- /dev/null +++ b/classes/class_resourceformatloadertheora.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the ResourceFormatLoaderTheora.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_ResourceFormatLoaderTheora: + +ResourceFormatLoaderTheora +========================== + +**Inherits:** :ref:`ResourceFormatLoader` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_resourceformatloaderwebm.rst b/classes/class_resourceformatloaderwebm.rst new file mode 100644 index 000000000..f6f1bdc3a --- /dev/null +++ b/classes/class_resourceformatloaderwebm.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the ResourceFormatLoaderWebm.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_ResourceFormatLoaderWebm: + +ResourceFormatLoaderWebm +======================== + +**Inherits:** :ref:`ResourceFormatLoader` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_resourceformatpkm.rst b/classes/class_resourceformatpkm.rst new file mode 100644 index 000000000..316db0aad --- /dev/null +++ b/classes/class_resourceformatpkm.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the ResourceFormatPKM.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_ResourceFormatPKM: + +ResourceFormatPKM +================= + +**Inherits:** :ref:`ResourceFormatLoader` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_resourceformatpvr.rst b/classes/class_resourceformatpvr.rst new file mode 100644 index 000000000..76d986601 --- /dev/null +++ b/classes/class_resourceformatpvr.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the ResourceFormatPVR.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_ResourceFormatPVR: + +ResourceFormatPVR +================= + +**Inherits:** :ref:`ResourceFormatLoader` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_resourceformatsaver.rst b/classes/class_resourceformatsaver.rst new file mode 100644 index 000000000..d10d7402f --- /dev/null +++ b/classes/class_resourceformatsaver.rst @@ -0,0 +1,59 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the ResourceFormatSaver.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_ResourceFormatSaver: + +ResourceFormatSaver +=================== + +**Inherits:** :ref:`Reference` **<** :ref:`Object` + +**Inherited By:** :ref:`ResourceFormatSaverBinary`, :ref:`ResourceSaverPNG`, :ref:`ResourceFormatSaverGDScript`, :ref:`ResourceFormatSaverShader`, :ref:`ResourceFormatSaverText`, :ref:`GDNativeLibraryResourceSaver`, :ref:`ResourceFormatSaverNativeScript` + +**Category:** Core + +Brief Description +----------------- + +Saves a specific resource type to a file. + +Methods +------- + ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_recognized_extensions` **(** :ref:`Resource` resource **)** virtual | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`recognize` **(** :ref:`Resource` resource **)** virtual | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`save` **(** :ref:`String` path, :ref:`Resource` resource, :ref:`int` flags **)** virtual | ++------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Description +----------- + +The engine can save resources when you do it from the editor, or when you call :ref:`ResourceSaver.save`. This is accomplished with multiple ``ResourceFormatSaver``\ s, each handling its own format. + +By default, Godot saves resources as ``.tres``, ``.res`` or another built-in format, but you can choose to create your own format by extending this class. You should give it a global class name with ``class_name`` for it to be registered. You may as well implement a :ref:`ResourceFormatLoader`. + +Method Descriptions +------------------- + +.. _class_ResourceFormatSaver_get_recognized_extensions: + +- :ref:`PoolStringArray` **get_recognized_extensions** **(** :ref:`Resource` resource **)** virtual + +Gets the list of extensions for files this saver is able to write. + +.. _class_ResourceFormatSaver_recognize: + +- :ref:`bool` **recognize** **(** :ref:`Resource` resource **)** virtual + +Returns true if the given resource object can be saved by this saver. + +.. _class_ResourceFormatSaver_save: + +- :ref:`int` **save** **(** :ref:`String` path, :ref:`Resource` resource, :ref:`int` flags **)** virtual + +Saves the given resource object to a file. ``flags`` is a bitmask composed with ``FLAG_*`` constants defined in :ref:`ResourceSaver`. Returns ``OK`` on success, or an ``ERR_*`` constant listed in :ref:`@GlobalScope` if it failed. + diff --git a/classes/class_resourceformatsaverbinary.rst b/classes/class_resourceformatsaverbinary.rst new file mode 100644 index 000000000..6a2a608aa --- /dev/null +++ b/classes/class_resourceformatsaverbinary.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the ResourceFormatSaverBinary.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_ResourceFormatSaverBinary: + +ResourceFormatSaverBinary +========================= + +**Inherits:** :ref:`ResourceFormatSaver` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_resourceformatsavergdscript.rst b/classes/class_resourceformatsavergdscript.rst new file mode 100644 index 000000000..03d309ffc --- /dev/null +++ b/classes/class_resourceformatsavergdscript.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the ResourceFormatSaverGDScript.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_ResourceFormatSaverGDScript: + +ResourceFormatSaverGDScript +=========================== + +**Inherits:** :ref:`ResourceFormatSaver` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_resourceformatsavernativescript.rst b/classes/class_resourceformatsavernativescript.rst new file mode 100644 index 000000000..786d930f6 --- /dev/null +++ b/classes/class_resourceformatsavernativescript.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the ResourceFormatSaverNativeScript.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_ResourceFormatSaverNativeScript: + +ResourceFormatSaverNativeScript +=============================== + +**Inherits:** :ref:`ResourceFormatSaver` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_resourceformatsavershader.rst b/classes/class_resourceformatsavershader.rst new file mode 100644 index 000000000..186305147 --- /dev/null +++ b/classes/class_resourceformatsavershader.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the ResourceFormatSaverShader.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_ResourceFormatSaverShader: + +ResourceFormatSaverShader +========================= + +**Inherits:** :ref:`ResourceFormatSaver` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_resourceformatsavertext.rst b/classes/class_resourceformatsavertext.rst new file mode 100644 index 000000000..ee7126928 --- /dev/null +++ b/classes/class_resourceformatsavertext.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the ResourceFormatSaverText.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_ResourceFormatSaverText: + +ResourceFormatSaverText +======================= + +**Inherits:** :ref:`ResourceFormatSaver` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_resourceloader.rst b/classes/class_resourceloader.rst index a26c6f4a5..b1cc3415f 100644 --- a/classes/class_resourceloader.rst +++ b/classes/class_resourceloader.rst @@ -19,23 +19,23 @@ Resource Loader. Methods ------- -+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`exists` **(** :ref:`String` path, :ref:`String` type_hint="" **)** | -+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_dependencies` **(** :ref:`String` path **)** | -+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolStringArray` | :ref:`get_recognized_extensions_for_type` **(** :ref:`String` type **)** | -+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has` **(** :ref:`String` path **)** | -+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_cached` **(** :ref:`String` path **)** | -+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Resource` | :ref:`load` **(** :ref:`String` path, :ref:`String` type_hint="", :ref:`bool` p_no_cache=false **)** | -+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ResourceInteractiveLoader` | :ref:`load_interactive` **(** :ref:`String` path, :ref:`String` type_hint="" **)** | -+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_abort_on_missing_resources` **(** :ref:`bool` abort **)** | -+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`exists` **(** :ref:`String` path, :ref:`String` type_hint="" **)** | ++--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_dependencies` **(** :ref:`String` path **)** | ++--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolStringArray` | :ref:`get_recognized_extensions_for_type` **(** :ref:`String` type **)** | ++--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has` **(** :ref:`String` path **)** | ++--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_cached` **(** :ref:`String` path **)** | ++--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Resource` | :ref:`load` **(** :ref:`String` path, :ref:`String` type_hint="", :ref:`bool` no_cache=false **)** | ++--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ResourceInteractiveLoader` | :ref:`load_interactive` **(** :ref:`String` path, :ref:`String` type_hint="" **)** | ++--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_abort_on_missing_resources` **(** :ref:`bool` abort **)** | ++--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -69,7 +69,7 @@ Return the list of recognized extensions for a resource type. .. _class_ResourceLoader_load: -- :ref:`Resource` **load** **(** :ref:`String` path, :ref:`String` type_hint="", :ref:`bool` p_no_cache=false **)** +- :ref:`Resource` **load** **(** :ref:`String` path, :ref:`String` type_hint="", :ref:`bool` no_cache=false **)** .. _class_ResourceLoader_load_interactive: diff --git a/classes/class_resourcesaverpng.rst b/classes/class_resourcesaverpng.rst new file mode 100644 index 000000000..ce1866581 --- /dev/null +++ b/classes/class_resourcesaverpng.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the ResourceSaverPNG.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_ResourceSaverPNG: + +ResourceSaverPNG +================ + +**Inherits:** :ref:`ResourceFormatSaver` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_richtextlabel.rst b/classes/class_richtextlabel.rst index ac2ec5cdd..767ce9e73 100644 --- a/classes/class_richtextlabel.rst +++ b/classes/class_richtextlabel.rst @@ -238,7 +238,7 @@ Property Descriptions | *Getter* | is_using_bbcode() | +----------+-----------------------+ -If ``true`` the label uses BBCode formatting. Default value: ``false``. +If ``true``, the label uses BBCode formatting. Default value: ``false``. .. _class_RichTextLabel_bbcode_text: @@ -274,7 +274,7 @@ If ``true``, the label underlines meta tags such as url{text}. Default value: `` | *Getter* | is_overriding_selected_font_color() | +----------+-----------------------------------------+ -If ``true`` the label uses the custom font color. Default value: ``false``. +If ``true``, the label uses the custom font color. Default value: ``false``. .. _class_RichTextLabel_percent_visible: diff --git a/classes/class_rigidbody.rst b/classes/class_rigidbody.rst index 493bf5c40..9336a2816 100644 --- a/classes/class_rigidbody.rst +++ b/classes/class_rigidbody.rst @@ -281,7 +281,7 @@ RigidBody's bounciness. | *Getter* | is_able_to_sleep() | +----------+----------------------+ -If ``true`` the RigidBody will not calculate forces and will act as a static body while there is no movement. It will wake up when forces are applied through other collisions or when the ``apply_impulse`` method is used. +If ``true``, the RigidBody will not calculate forces and will act as a static body while there is no movement. It will wake up when forces are applied through other collisions or when the ``apply_impulse`` method is used. .. _class_RigidBody_contact_monitor: @@ -293,7 +293,7 @@ If ``true`` the RigidBody will not calculate forces and will act as a static bod | *Getter* | is_contact_monitor_enabled() | +----------+------------------------------+ -If ``true`` the RigidBody will emit signals when it collides with another RigidBody. +If ``true``, the RigidBody will emit signals when it collides with another RigidBody. .. _class_RigidBody_contacts_reported: @@ -317,7 +317,7 @@ The maximum contacts to report. Bodies can keep a log of the contacts with other | *Getter* | is_using_continuous_collision_detection() | +----------+-----------------------------------------------+ -If ``true`` continuous collision detection is used. +If ``true``, continuous collision detection is used. Continuous collision detection tries to predict where a moving body will collide, instead of moving it and correcting its movement if it collided. Continuous collision detection is more precise, and misses less impacts by small, fast-moving objects. Not using continuous collision detection is faster to compute, but can miss small, fast-moving objects. @@ -331,7 +331,7 @@ Continuous collision detection tries to predict where a moving body will collide | *Getter* | is_using_custom_integrator() | +----------+----------------------------------+ -If ``true`` internal force integration will be disabled (like gravity or air friction) for this body. Other than collision response, the body will only move as determined by the :ref:`_integrate_forces` function, if defined. +If ``true``, internal force integration will be disabled (like gravity or air friction) for this body. Other than collision response, the body will only move as determined by the :ref:`_integrate_forces` function, if defined. .. _class_RigidBody_friction: @@ -425,7 +425,7 @@ The body mode from the MODE\_\* enum. Modes include: MODE_STATIC, MODE_KINEMATIC | *Getter* | is_sleeping() | +----------+---------------------+ -If ``true`` the body is sleeping and will not calculate forces until woken up by a collision or the ``apply_impulse`` method. +If ``true``, the body is sleeping and will not calculate forces until woken up by a collision or the ``apply_impulse`` method. .. _class_RigidBody_weight: @@ -446,7 +446,7 @@ Method Descriptions - void **_integrate_forces** **(** :ref:`PhysicsDirectBodyState` state **)** virtual -Called during physics processing, allowing you to read and safely modify the simulation state for the object. By default it works in addition to the usual physics behavior, but :ref:`set_use_custom_integrator` allows you to disable the default behavior and do fully custom force integration for a body. +Called during physics processing, allowing you to read and safely modify the simulation state for the object. By default, it works in addition to the usual physics behavior, but :ref:`set_use_custom_integrator` allows you to disable the default behavior and do fully custom force integration for a body. .. _class_RigidBody_add_central_force: diff --git a/classes/class_rigidbody2d.rst b/classes/class_rigidbody2d.rst index cfc6a58aa..f16663caa 100644 --- a/classes/class_rigidbody2d.rst +++ b/classes/class_rigidbody2d.rst @@ -228,7 +228,7 @@ The body's bounciness. Default value: ``0``. | *Getter* | is_able_to_sleep() | +----------+----------------------+ -If ``true`` the body will not calculate forces and will act as a static body if there is no movement. The body will wake up when other forces are applied via collisions or by using :ref:`apply_impulse` or :ref:`add_force`. Default value: ``true``. +If ``true``, the body will not calculate forces and will act as a static body if there is no movement. The body will wake up when other forces are applied via collisions or by using :ref:`apply_impulse` or :ref:`add_force`. Default value: ``true``. .. _class_RigidBody2D_contact_monitor: @@ -240,7 +240,7 @@ If ``true`` the body will not calculate forces and will act as a static body if | *Getter* | is_contact_monitor_enabled() | +----------+------------------------------+ -If ``true`` the body will emit signals when it collides with another RigidBody2D. See also :ref:`contacts_reported`. Default value: ``false``. +If ``true``, the body will emit signals when it collides with another RigidBody2D. See also :ref:`contacts_reported`. Default value: ``false``. .. _class_RigidBody2D_contacts_reported: @@ -278,7 +278,7 @@ Continuous collision detection tries to predict where a moving body will collide | *Getter* | is_using_custom_integrator() | +----------+----------------------------------+ -If ``true`` internal force integration is disabled for this body. Aside from collision response, the body will only move as determined by the :ref:`_integrate_forces` function. +If ``true``, internal force integration is disabled for this body. Aside from collision response, the body will only move as determined by the :ref:`_integrate_forces` function. .. _class_RigidBody2D_friction: @@ -384,7 +384,7 @@ The body's mode. See ``MODE_*`` constants. Default value: ``MODE_RIGID``. | *Getter* | is_sleeping() | +----------+---------------------+ -If ``true`` the body is sleeping and will not calculate forces until woken up by a collision or by using :ref:`apply_impulse` or :ref:`add_force`. +If ``true``, the body is sleeping and will not calculate forces until woken up by a collision or by using :ref:`apply_impulse` or :ref:`add_force`. .. _class_RigidBody2D_weight: @@ -405,7 +405,7 @@ Method Descriptions - void **_integrate_forces** **(** :ref:`Physics2DDirectBodyState` state **)** virtual -Allows you to read and safely modify the simulation state for the object. Use this instead of Node._physics_process if you need to directly change the body's ``position`` or other physics properties. By default it works in addition to the usual physics behavior, but :ref:`custom_integrator` allows you to disable the default behavior and write custom force integration for a body. +Allows you to read and safely modify the simulation state for the object. Use this instead of Node._physics_process if you need to directly change the body's ``position`` or other physics properties. By default, it works in addition to the usual physics behavior, but :ref:`custom_integrator` allows you to disable the default behavior and write custom force integration for a body. .. _class_RigidBody2D_add_central_force: diff --git a/classes/class_scenetree.rst b/classes/class_scenetree.rst index ddb8f12ed..0785c9c35 100644 --- a/classes/class_scenetree.rst +++ b/classes/class_scenetree.rst @@ -301,7 +301,7 @@ The default :ref:`MultiplayerAPI` instance for this SceneT | *Getter* | is_multiplayer_poll_enabled() | +----------+-------------------------------------+ -If ``true`` (default) enable the automatic polling of the :ref:`MultiplayerAPI` for this SceneTree during :ref:`idle_frame`. +If ``true``, (default) enable the automatic polling of the :ref:`MultiplayerAPI` for this SceneTree during :ref:`idle_frame`. When ``false`` you need to manually call :ref:`MultiplayerAPI.poll` for processing network packets and delivering RPCs/RSETs. This allows to run RPCs/RSETs in a different loop (e.g. physics, thread, specific time step) and for manual :ref:`Mutex` protection when accessing the :ref:`MultiplayerAPI` from threads. @@ -327,7 +327,7 @@ The peer object to handle the RPC system (effectively enabling networking when s | *Getter* | is_paused() | +----------+------------------+ -If ``true`` the SceneTree is paused. +If ``true``, the SceneTree is paused. Doing so will have the following behavior: @@ -347,7 +347,7 @@ Doing so will have the following behavior: | *Getter* | is_refusing_new_network_connections() | +----------+-------------------------------------------+ -If ``true`` the SceneTree's :ref:`network_peer` refuses new incoming connections. +If ``true``, the SceneTree's :ref:`network_peer` refuses new incoming connections. .. _class_SceneTree_root: @@ -369,7 +369,7 @@ The SceneTree's :ref:`Viewport`. | *Getter* | is_using_font_oversampling() | +----------+----------------------------------+ -If ``true`` font oversampling is used. +If ``true``, font oversampling is used. Method Descriptions ------------------- @@ -496,7 +496,7 @@ Reloads the currently active scene. - void **set_auto_accept_quit** **(** :ref:`bool` enabled **)** -If ``true`` the application automatically accepts quitting. +If ``true``, the application automatically accepts quitting. .. _class_SceneTree_set_group: @@ -520,7 +520,7 @@ Marks the most recent input event as handled. - void **set_quit_on_go_back** **(** :ref:`bool` enabled **)** -If ``true`` the application quits automatically on going back (e.g. on Android). +If ``true``, the application quits automatically on going back (e.g. on Android). .. _class_SceneTree_set_screen_stretch: diff --git a/classes/class_scriptcreatedialog.rst b/classes/class_scriptcreatedialog.rst index d1c71cfef..934e08dd4 100644 --- a/classes/class_scriptcreatedialog.rst +++ b/classes/class_scriptcreatedialog.rst @@ -35,14 +35,14 @@ Emitted when the user clicks the OK button. Description ----------- -The ScriptCreateDialog creates script files according to a given template for a given scripting language. The standard use is to configure its fields prior to calling a :ref:`popup`() method. +The ScriptCreateDialog creates script files according to a given template for a given scripting language. The standard use is to configure its fields prior to calling a :ref:`popup`\ () method. :: func _ready(): - dialog.config("Node", "res://new_node.gd") # for in-engine types - dialog.config("\"res://base_node.gd\"", "res://derived_node.gd") # for script types - dialog.popup_centered() + dialog.config("Node", "res://new_node.gd") # for in-engine types + dialog.config("\"res://base_node.gd\"", "res://derived_node.gd") # for script types + dialog.popup_centered() Method Descriptions ------------------- diff --git a/classes/class_shortcut.rst b/classes/class_shortcut.rst index cd257fd29..a79c7cece 100644 --- a/classes/class_shortcut.rst +++ b/classes/class_shortcut.rst @@ -77,5 +77,5 @@ Returns ``true`` if the shortcut's :ref:`InputEvent` equals `` - :ref:`bool` **is_valid** **(** **)** const -If ``true`` this shortcut is valid. +If ``true``, this shortcut is valid. diff --git a/classes/class_spatial.rst b/classes/class_spatial.rst index e3c96371f..41d74274e 100644 --- a/classes/class_spatial.rst +++ b/classes/class_spatial.rst @@ -243,7 +243,7 @@ Local translation of this node. | *Getter* | is_visible() | +----------+--------------------+ -If ``true`` this node is drawn. Default value: ``true``. +If ``true``, this node is drawn. Default value: ``true``. Method Descriptions ------------------- diff --git a/classes/class_spatialmaterial.rst b/classes/class_spatialmaterial.rst index 304e4064a..6191b062a 100644 --- a/classes/class_spatialmaterial.rst +++ b/classes/class_spatialmaterial.rst @@ -507,7 +507,7 @@ The strength of the anisotropy effect. | *Getter* | get_feature() | +----------+--------------------+ -If ``true`` anisotropy is enabled. Changes the shape of the specular blob and aligns it to tangent space. Default value: ``false``. +If ``true``, anisotropy is enabled. Changes the shape of the specular blob and aligns it to tangent space. Default value: ``false``. .. _class_SpatialMaterial_anisotropy_flowmap: @@ -529,7 +529,7 @@ If ``true`` anisotropy is enabled. Changes the shape of the specular blob and al | *Getter* | get_feature() | +----------+--------------------+ -If ``true`` ambient occlusion is enabled. +If ``true``, ambient occlusion is enabled. .. _class_SpatialMaterial_ao_light_affect: @@ -591,7 +591,7 @@ If ``true`` ambient occlusion is enabled. | *Getter* | get_feature() | +----------+--------------------+ -If ``true`` clearcoat rendering is enabled. Adds a secondary transparent pass to the material. Default value: ``false``. +If ``true``, clearcoat rendering is enabled. Adds a secondary transparent pass to the material. Default value: ``false``. .. _class_SpatialMaterial_clearcoat_gloss: @@ -633,7 +633,7 @@ If ``true`` clearcoat rendering is enabled. Adds a secondary transparent pass to | *Getter* | get_feature() | +----------+--------------------+ -If ``true`` Depth mapping is enabled. See also :ref:`normal_enabled`. +If ``true``, Depth mapping is enabled. See also :ref:`normal_enabled`. .. _class_SpatialMaterial_depth_flip_binormal: @@ -807,7 +807,7 @@ The emitted light's color. See :ref:`emission_enabled`. +If ``true``, transparency is enabled on the body. Default value: ``false``. See also :ref:`params_blend_mode`. .. _class_SpatialMaterial_flags_unshaded: @@ -941,7 +941,7 @@ If ``true`` transparency is enabled on the body. Default value: ``false``. See a | *Getter* | get_flag() | +----------+-----------------+ -If ``true`` the object is unaffected by lighting. Default value: ``false``. +If ``true``, the object is unaffected by lighting. Default value: ``false``. .. _class_SpatialMaterial_flags_use_point_size: @@ -953,7 +953,7 @@ If ``true`` the object is unaffected by lighting. Default value: ``false``. | *Getter* | get_flag() | +----------+-----------------+ -If ``true`` render point size can be changed. Note: this is only effective for objects whose geometry is point-based rather than triangle-based. See also :ref:`params_point_size`. +If ``true``, render point size can be changed. Note: this is only effective for objects whose geometry is point-based rather than triangle-based. See also :ref:`params_point_size`. .. _class_SpatialMaterial_flags_vertex_lighting: @@ -965,7 +965,7 @@ If ``true`` render point size can be changed. Note: this is only effective for o | *Getter* | get_flag() | +----------+-----------------+ -If ``true`` lighting is calculated per vertex rather than per pixel. This may increase performance on low-end devices. Default value: ``false``. +If ``true``, lighting is calculated per vertex rather than per pixel. This may increase performance on low-end devices. Default value: ``false``. .. _class_SpatialMaterial_flags_world_triplanar: @@ -977,7 +977,7 @@ If ``true`` lighting is calculated per vertex rather than per pixel. This may in | *Getter* | get_flag() | +----------+-----------------+ -If ``true`` triplanar mapping is calculated in world space rather than object local space. See also :ref:`uv1_triplanar`. Default value: ``false``. +If ``true``, triplanar mapping is calculated in world space rather than object local space. See also :ref:`uv1_triplanar`. Default value: ``false``. .. _class_SpatialMaterial_metallic: @@ -1033,7 +1033,7 @@ General reflectivity amount. Note: unlike :ref:`metallic`. +If ``true``, enables the vertex grow setting. See :ref:`params_grow_amount`. .. _class_SpatialMaterial_params_grow_amount: @@ -1227,7 +1227,7 @@ The number of horizontal frames in the particle spritesheet. Only enabled when u | *Getter* | get_particles_anim_loop() | +----------+--------------------------------+ -If ``true`` particle animations are looped. Only enabled when using ``BillboardMode.BILLBOARD_PARTICLES``. See :ref:`params_billboard_mode`. +If ``true``, particle animations are looped. Only enabled when using ``BillboardMode.BILLBOARD_PARTICLES``. See :ref:`params_billboard_mode`. .. _class_SpatialMaterial_particles_anim_v_frames: @@ -1261,7 +1261,7 @@ The number of vertical frames in the particle spritesheet. Only enabled when usi | *Getter* | is_proximity_fade_enabled() | +----------+-----------------------------+ -If ``true`` the proximity and distance fade effect is enabled. Default value: ``false``. +If ``true``, the proximity and distance fade effect is enabled. Default value: ``false``. .. _class_SpatialMaterial_refraction_enabled: @@ -1273,7 +1273,7 @@ If ``true`` the proximity and distance fade effect is enabled. Default value: `` | *Getter* | get_feature() | +----------+--------------------+ -If ``true`` the refraction effect is enabled. Distorts transparency based on light from behind the object. Default value: ``false``. +If ``true``, the refraction effect is enabled. Distorts transparency based on light from behind the object. Default value: ``false``. .. _class_SpatialMaterial_refraction_scale: @@ -1327,7 +1327,7 @@ The strength of the refraction effect. | *Getter* | get_feature() | +----------+--------------------+ -If ``true`` rim effect is enabled. Default value: ``false``. +If ``true``, rim effect is enabled. Default value: ``false``. .. _class_SpatialMaterial_rim_texture: @@ -1393,7 +1393,7 @@ Surface reflection. A value of ``0`` represents a perfect mirror while a value o | *Getter* | get_feature() | +----------+--------------------+ -If ``true`` subsurface scattering is enabled. Emulates light that penetrates an object's surface, is scattered, and then emerges. +If ``true``, subsurface scattering is enabled. Emulates light that penetrates an object's surface, is scattered, and then emerges. .. _class_SpatialMaterial_subsurf_scatter_strength: @@ -1439,7 +1439,7 @@ The color used by the transmission effect. Represents the light passing through | *Getter* | get_feature() | +----------+--------------------+ -If ``true`` the transmission effect is enabled. Default value: ``false``. +If ``true``, the transmission effect is enabled. Default value: ``false``. .. _class_SpatialMaterial_transmission_texture: @@ -1541,7 +1541,7 @@ If ``true`` the transmission effect is enabled. Default value: ``false``. | *Getter* | get_flag() | +----------+-----------------+ -If ``true`` the model's vertex colors are processed as sRGB mode. Default value: ``false``. +If ``true``, the model's vertex colors are processed as sRGB mode. Default value: ``false``. .. _class_SpatialMaterial_vertex_color_use_as_albedo: @@ -1553,5 +1553,5 @@ If ``true`` the model's vertex colors are processed as sRGB mode. Default value: | *Getter* | get_flag() | +----------+-----------------+ -If ``true`` the vertex color is used as albedo color. Default value: ``false``. +If ``true``, the vertex color is used as albedo color. Default value: ``false``. diff --git a/classes/class_sprite.rst b/classes/class_sprite.rst index ba3f20200..603c45c8e 100644 --- a/classes/class_sprite.rst +++ b/classes/class_sprite.rst @@ -87,7 +87,7 @@ Property Descriptions | *Getter* | is_centered() | +----------+---------------------+ -If ``true`` texture is centered. Default value: ``true``. +If ``true``, texture is centered. Default value: ``true``. .. _class_Sprite_flip_h: @@ -99,7 +99,7 @@ If ``true`` texture is centered. Default value: ``true``. | *Getter* | is_flipped_h() | +----------+-------------------+ -If ``true`` texture is flipped horizontally. Default value: ``false``. +If ``true``, texture is flipped horizontally. Default value: ``false``. .. _class_Sprite_flip_v: @@ -111,7 +111,7 @@ If ``true`` texture is flipped horizontally. Default value: ``false``. | *Getter* | is_flipped_v() | +----------+-------------------+ -If ``true`` texture is flipped vertically. Default value: ``false``. +If ``true``, texture is flipped vertically. Default value: ``false``. .. _class_Sprite_frame: @@ -171,7 +171,7 @@ The texture's drawing offset. | *Getter* | is_region() | +----------+-------------------+ -If ``true`` texture is cut from a larger atlas texture. See ``region_rect``. Default value: ``false``. +If ``true``, texture is cut from a larger atlas texture. See ``region_rect``. Default value: ``false``. .. _class_Sprite_region_filter_clip: @@ -183,7 +183,7 @@ If ``true`` texture is cut from a larger atlas texture. See ``region_rect``. Def | *Getter* | is_region_filter_clip_enabled() | +----------+---------------------------------+ -If ``true`` the outermost pixels get blurred out. +If ``true``, the outermost pixels get blurred out. .. _class_Sprite_region_rect: diff --git a/classes/class_sprite3d.rst b/classes/class_sprite3d.rst index e885aab0c..829f56557 100644 --- a/classes/class_sprite3d.rst +++ b/classes/class_sprite3d.rst @@ -84,7 +84,7 @@ The number of columns in the sprite sheet. | *Getter* | is_region() | +----------+-------------------+ -If ``true`` texture will be cut from a larger atlas texture. See :ref:`region_rect`. Default value: ``false``. +If ``true``, texture will be cut from a larger atlas texture. See :ref:`region_rect`. Default value: ``false``. .. _class_Sprite3D_region_rect: diff --git a/classes/class_spritebase3d.rst b/classes/class_spritebase3d.rst index 6bfc08fc0..9a9c5a56e 100644 --- a/classes/class_spritebase3d.rst +++ b/classes/class_spritebase3d.rst @@ -121,7 +121,7 @@ The direction in which the front of the texture faces. | *Getter* | is_centered() | +----------+---------------------+ -If ``true`` texture will be centered. Default value: ``true``. +If ``true``, texture will be centered. Default value: ``true``. .. _class_SpriteBase3D_double_sided: @@ -133,7 +133,7 @@ If ``true`` texture will be centered. Default value: ``true``. | *Getter* | get_draw_flag() | +----------+----------------------+ -If ``true`` texture can be seen from the back as well, if ``false``, it is invisible when looking at it from behind. Default value: ``true``. +If ``true``, texture can be seen from the back as well, if ``false``, it is invisible when looking at it from behind. Default value: ``true``. .. _class_SpriteBase3D_flip_h: @@ -145,7 +145,7 @@ If ``true`` texture can be seen from the back as well, if ``false``, it is invis | *Getter* | is_flipped_h() | +----------+-------------------+ -If ``true`` texture is flipped horizontally. Default value: ``false``. +If ``true``, texture is flipped horizontally. Default value: ``false``. .. _class_SpriteBase3D_flip_v: @@ -157,7 +157,7 @@ If ``true`` texture is flipped horizontally. Default value: ``false``. | *Getter* | is_flipped_v() | +----------+-------------------+ -If ``true`` texture is flipped vertically. Default value: ``false``. +If ``true``, texture is flipped vertically. Default value: ``false``. .. _class_SpriteBase3D_modulate: @@ -217,7 +217,7 @@ The size of one pixel's width on the Sprite to scale it in 3D. | *Getter* | get_draw_flag() | +----------+----------------------+ -If ``true`` the :ref:`Light` in the :ref:`Environment` has effects on the Sprite. Default value: ``false``. +If ``true``, the :ref:`Light` in the :ref:`Environment` has effects on the Sprite. Default value: ``false``. .. _class_SpriteBase3D_transparent: @@ -229,7 +229,7 @@ If ``true`` the :ref:`Light` in the :ref:`Environment` **get_animation_loop** **(** :ref:`String` anim **)** const -If ``true`` the given animation will loop. +If ``true``, the given animation will loop. .. _class_SpriteFrames_get_animation_names: @@ -133,7 +133,7 @@ Returns the number of frames in the animation. - :ref:`bool` **has_animation** **(** :ref:`String` anim **)** const -If ``true`` the named animation exists. +If ``true``, the named animation exists. .. _class_SpriteFrames_remove_animation: @@ -157,7 +157,7 @@ Changes the animation's name to ``newname``. - void **set_animation_loop** **(** :ref:`String` anim, :ref:`bool` loop **)** -If ``true`` the animation will loop. +If ``true``, the animation will loop. .. _class_SpriteFrames_set_animation_speed: diff --git a/classes/class_string.rst b/classes/class_string.rst index b84a68969..ca26c650c 100644 --- a/classes/class_string.rst +++ b/classes/class_string.rst @@ -118,6 +118,8 @@ Methods +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_valid_float` **(** **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid_hex_number` **(** :ref:`bool` with_prefix=False **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_valid_html_color` **(** **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_valid_identifier` **(** **)** | @@ -513,6 +515,12 @@ Returns ``true`` if this string is a subsequence of the given string, without co Returns ``true`` if this string contains a valid float. +.. _class_String_is_valid_hex_number: + +- :ref:`bool` **is_valid_hex_number** **(** :ref:`bool` with_prefix=False **)** + +Returns ``true`` if this string contains a valid hexadecimal number. If ``with_prefix`` is ``true``, then a validity of the hexadecimal number is determined by ``0x`` prefix, for instance: ``0xDEADC0DE``. + .. _class_String_is_valid_html_color: - :ref:`bool` **is_valid_html_color** **(** **)** diff --git a/classes/class_tabcontainer.rst b/classes/class_tabcontainer.rst index a682204d3..76bc8f2d8 100644 --- a/classes/class_tabcontainer.rst +++ b/classes/class_tabcontainer.rst @@ -197,7 +197,7 @@ The alignment of all tabs in the tab container. See the ``ALIGN_*`` constants fo | *Getter* | are_tabs_visible() | +----------+-------------------------+ -If ``true`` tabs are visible. If ``false`` tabs' content and titles are hidden. Default value: ``true``. +If ``true``, tabs are visible. If ``false``, tabs' content and titles are hidden. Default value: ``true``. Method Descriptions ------------------- diff --git a/classes/class_tabs.rst b/classes/class_tabs.rst index 272f55eaf..852256ac9 100644 --- a/classes/class_tabs.rst +++ b/classes/class_tabs.rst @@ -312,7 +312,7 @@ Removes tab at index ``tab_idx`` - void **set_select_with_rmb** **(** :ref:`bool` enabled **)** -If ``true`` enables selecting a tab with right mouse button. +If ``true``, enables selecting a tab with right mouse button. .. _class_Tabs_set_tab_disabled: diff --git a/classes/class_textedit.rst b/classes/class_textedit.rst index fc38b63dd..e85179b90 100644 --- a/classes/class_textedit.rst +++ b/classes/class_textedit.rst @@ -295,7 +295,7 @@ Property Descriptions | *Getter* | is_breakpoint_gutter_enabled() | +----------+--------------------------------------+ -If ``true`` the breakpoint gutter is visible. +If ``true``, the breakpoint gutter is visible. .. _class_TextEdit_caret_blink: @@ -307,7 +307,7 @@ If ``true`` the breakpoint gutter is visible. | *Getter* | cursor_get_blink_enabled() | +----------+---------------------------------+ -If ``true`` the caret (visual cursor) blinks. +If ``true``, the caret (visual cursor) blinks. .. _class_TextEdit_caret_blink_speed: @@ -331,9 +331,9 @@ Duration (in seconds) of a caret's blinking cycle. | *Getter* | cursor_is_block_mode() | +----------+------------------------------+ -If ``true`` the caret displays as a rectangle. +If ``true``, the caret displays as a rectangle. -If ``false`` the caret displays as a bar. +If ``false``, the caret displays as a bar. .. _class_TextEdit_caret_moving_by_right_click: @@ -345,9 +345,9 @@ If ``false`` the caret displays as a bar. | *Getter* | is_right_click_moving_caret() | +----------+------------------------------------+ -If ``true`` a right click moves the cursor at the mouse position before displaying the context menu. +If ``true``, a right click moves the cursor at the mouse position before displaying the context menu. -If ``false`` the context menu disregards mouse location. +If ``false``, the context menu disregards mouse location. .. _class_TextEdit_context_menu_enabled: @@ -359,7 +359,7 @@ If ``false`` the context menu disregards mouse location. | *Getter* | is_context_menu_enabled() | +----------+---------------------------------+ -If ``true`` a right click displays the context menu. +If ``true``, a right click displays the context menu. .. _class_TextEdit_hiding_enabled: @@ -391,7 +391,7 @@ If ``true`` a right click displays the context menu. | *Getter* | is_highlight_current_line_enabled() | +----------+-------------------------------------+ -If ``true`` the line containing the cursor is highlighted. +If ``true``, the line containing the cursor is highlighted. .. _class_TextEdit_override_selected_font_color: @@ -413,7 +413,7 @@ If ``true`` the line containing the cursor is highlighted. | *Getter* | is_readonly() | +----------+---------------------+ -If ``true`` read-only mode is enabled. Existing text cannot be modified and new text cannot be added. +If ``true``, read-only mode is enabled. Existing text cannot be modified and new text cannot be added. .. _class_TextEdit_show_line_numbers: @@ -425,7 +425,7 @@ If ``true`` read-only mode is enabled. Existing text cannot be modified and new | *Getter* | is_show_line_numbers_enabled() | +----------+--------------------------------+ -If ``true`` line numbers are displayed to the left of the text. +If ``true``, line numbers are displayed to the left of the text. .. _class_TextEdit_smooth_scrolling: diff --git a/classes/class_texturebutton.rst b/classes/class_texturebutton.rst index a53a8166c..e47fc8f96 100644 --- a/classes/class_texturebutton.rst +++ b/classes/class_texturebutton.rst @@ -78,7 +78,7 @@ Property Descriptions | *Getter* | get_expand() | +----------+-------------------+ -If ``true`` the texture stretches to the edges of the node's bounding rectangle using the :ref:`stretch_mode`. If ``false`` the texture will not scale with the node. Default value: ``false``. +If ``true``, the texture stretches to the edges of the node's bounding rectangle using the :ref:`stretch_mode`. If ``false``, the texture will not scale with the node. Default value: ``false``. .. _class_TextureButton_stretch_mode: diff --git a/classes/class_textureprogress.rst b/classes/class_textureprogress.rst index 94e22ad73..a121c85c3 100644 --- a/classes/class_textureprogress.rst +++ b/classes/class_textureprogress.rst @@ -106,7 +106,7 @@ The fill direction. Uses FILL\_\* constants. | *Getter* | get_nine_patch_stretch() | +----------+-------------------------------+ -If ``true`` Godot treats the bar's textures like :ref:`NinePatchRect`. Use ``stretch_margin_*``, like :ref:`stretch_margin_bottom`, to set up the nine patch's 3x3 grid. Default value: ``false``. +If ``true``, Godot treats the bar's textures like :ref:`NinePatchRect`. Use ``stretch_margin_*``, like :ref:`stretch_margin_bottom`, to set up the nine patch's 3x3 grid. Default value: ``false``. .. _class_TextureProgress_radial_center_offset: diff --git a/classes/class_texturerect.rst b/classes/class_texturerect.rst index 511e761e2..7b975055f 100644 --- a/classes/class_texturerect.rst +++ b/classes/class_texturerect.rst @@ -68,7 +68,7 @@ Property Descriptions | *Getter* | has_expand() | +----------+-------------------+ -If ``true`` the texture scales to fit its bounding rectangle. Default value: ``false``. +If ``true``, the texture scales to fit its bounding rectangle. Default value: ``false``. .. _class_TextureRect_stretch_mode: diff --git a/classes/class_tilemap.rst b/classes/class_tilemap.rst index 3c0232ad6..ea1fd59e5 100644 --- a/classes/class_tilemap.rst +++ b/classes/class_tilemap.rst @@ -61,6 +61,8 @@ Methods +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_cell` **(** :ref:`int` x, :ref:`int` y **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_cell_autotile_coord` **(** :ref:`int` x, :ref:`int` y **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_cellv` **(** :ref:`Vector2` position **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | @@ -238,7 +240,7 @@ Position for tile origin. Uses TILE_ORIGIN\_\* constants. Default value: TILE_OR | *Getter* | is_y_sort_mode_enabled() | +----------+--------------------------+ -If ``true`` the TileMap's children will be drawn in order of their Y coordinate. Default value: ``false``. +If ``true``, the TileMap's children will be drawn in order of their Y coordinate. Default value: ``false``. .. _class_TileMap_collision_bounce: @@ -298,7 +300,7 @@ The collision mask(s) for all colliders in the TileMap. | *Getter* | get_collision_use_kinematic() | +----------+------------------------------------+ -If ``true`` TileMap collisions will be handled as a kinematic body. If ``false`` collisions will be handled as static body. Default value: ``false``. +If ``true``, TileMap collisions will be handled as a kinematic body. If ``false``, collisions will be handled as static body. Default value: ``false``. .. _class_TileMap_mode: @@ -357,6 +359,10 @@ Clears cells that do not exist in the tileset. Returns the tile index of the given cell. +.. _class_TileMap_get_cell_autotile_coord: + +- :ref:`Vector2` **get_cell_autotile_coord** **(** :ref:`int` x, :ref:`int` y **)** const + .. _class_TileMap_get_cellv: - :ref:`int` **get_cellv** **(** :ref:`Vector2` position **)** const diff --git a/classes/class_timer.rst b/classes/class_timer.rst index 461f66114..90a930c0c 100644 --- a/classes/class_timer.rst +++ b/classes/class_timer.rst @@ -82,7 +82,7 @@ Property Descriptions | *Getter* | has_autostart() | +----------+----------------------+ -If ``true`` the timer will automatically start when entering the scene tree. Default value: ``false``. +If ``true``, the timer will automatically start when entering the scene tree. Default value: ``false``. .. _class_Timer_one_shot: @@ -94,7 +94,7 @@ If ``true`` the timer will automatically start when entering the scene tree. Def | *Getter* | is_one_shot() | +----------+---------------------+ -If ``true`` the timer will stop when reaching 0. If ``false`` it will restart. Default value: ``false``. +If ``true``, the timer will stop when reaching 0. If ``false``, it will restart. Default value: ``false``. .. _class_Timer_paused: @@ -106,7 +106,7 @@ If ``true`` the timer will stop when reaching 0. If ``false`` it will restart. D | *Getter* | is_paused() | +----------+-------------------+ -If ``true`` the timer is paused and will not process until it is unpaused again, even if :ref:`start` is called. +If ``true``, the timer is paused and will not process until it is unpaused again, even if :ref:`start` is called. .. _class_Timer_process_mode: diff --git a/classes/class_touchscreenbutton.rst b/classes/class_touchscreenbutton.rst index 8fee97875..fbc434d1d 100644 --- a/classes/class_touchscreenbutton.rst +++ b/classes/class_touchscreenbutton.rst @@ -126,7 +126,7 @@ The button's texture for the normal state. | *Getter* | is_passby_press_enabled() | +----------+---------------------------+ -If ``true`` passby presses are enabled. +If ``true``, passby presses are enabled. .. _class_TouchScreenButton_pressed: @@ -162,7 +162,7 @@ The button's shape. | *Getter* | is_shape_centered() | +----------+---------------------------+ -If ``true`` the button's shape is centered. +If ``true``, the button's shape is centered. .. _class_TouchScreenButton_shape_visible: @@ -174,7 +174,7 @@ If ``true`` the button's shape is centered. | *Getter* | is_shape_visible() | +----------+--------------------------+ -If ``true`` the button's shape is visible. +If ``true``, the button's shape is visible. .. _class_TouchScreenButton_visibility_mode: diff --git a/classes/class_translationloaderpo.rst b/classes/class_translationloaderpo.rst new file mode 100644 index 000000000..dba29221d --- /dev/null +++ b/classes/class_translationloaderpo.rst @@ -0,0 +1,18 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the TranslationLoaderPO.xml source instead. +.. The source is found in doc/classes or modules//doc_classes. + +.. _class_TranslationLoaderPO: + +TranslationLoaderPO +=================== + +**Inherits:** :ref:`ResourceFormatLoader` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + diff --git a/classes/class_tree.rst b/classes/class_tree.rst index 3654799e5..a3787f1db 100644 --- a/classes/class_tree.rst +++ b/classes/class_tree.rst @@ -312,7 +312,7 @@ Property Descriptions | *Getter* | get_allow_reselect() | +----------+---------------------------+ -If ``true`` the currently selected cell may be selected again. +If ``true``, the currently selected cell may be selected again. .. _class_Tree_allow_rmb_select: @@ -324,7 +324,7 @@ If ``true`` the currently selected cell may be selected again. | *Getter* | get_allow_rmb_select() | +----------+-----------------------------+ -If ``true`` a right mouse button click can select items. +If ``true``, a right mouse button click can select items. .. _class_Tree_columns: @@ -360,7 +360,7 @@ The drop mode as an OR combination of flags. See ``DROP_MODE_*`` constants. Once | *Getter* | is_folding_hidden() | +----------+-------------------------+ -If ``true`` the folding arrow is hidden. +If ``true``, the folding arrow is hidden. .. _class_Tree_hide_root: @@ -372,7 +372,7 @@ If ``true`` the folding arrow is hidden. | *Getter* | is_root_hidden() | +----------+----------------------+ -If ``true`` the tree's root is hidden. +If ``true``, the tree's root is hidden. .. _class_Tree_select_mode: @@ -509,7 +509,7 @@ Returns the current selection's column. - void **set_column_expand** **(** :ref:`int` column, :ref:`bool` expand **)** -If ``true`` the column will have the "Expand" flag of :ref:`Control`. +If ``true``, the column will have the "Expand" flag of :ref:`Control`. .. _class_Tree_set_column_min_width: @@ -527,5 +527,5 @@ Set the title of a column. - void **set_column_titles_visible** **(** :ref:`bool` visible **)** -If ``true`` column titles are visible. +If ``true``, column titles are visible. diff --git a/classes/class_treeitem.rst b/classes/class_treeitem.rst index 9f34bb44d..f715977e6 100644 --- a/classes/class_treeitem.rst +++ b/classes/class_treeitem.rst @@ -185,7 +185,7 @@ Property Descriptions | *Getter* | is_collapsed() | +----------+----------------------+ -If ``true`` the TreeItem is collapsed. +If ``true``, the TreeItem is collapsed. .. _class_TreeItem_custom_minimum_height: @@ -209,7 +209,7 @@ The custom minimum height. | *Getter* | is_folding_disabled() | +----------+----------------------------+ -If ``true`` folding is disabled for this TreeItem. +If ``true``, folding is disabled for this TreeItem. Method Descriptions ------------------- @@ -432,7 +432,7 @@ Sets the given column's cell mode to ``mode``. See ``CELL_MODE_*`` constants. - void **set_checked** **(** :ref:`int` column, :ref:`bool` checked **)** -If ``true`` the column ``column`` is checked. +If ``true``, the column ``column`` is checked. .. _class_TreeItem_set_custom_as_button: @@ -462,13 +462,13 @@ The ``callback`` should accept two arguments: the :ref:`TreeItem - void **set_editable** **(** :ref:`int` column, :ref:`bool` enabled **)** -If ``true`` column ``column`` is editable. +If ``true``, column ``column`` is editable. .. _class_TreeItem_set_expand_right: - void **set_expand_right** **(** :ref:`int` column, :ref:`bool` enable **)** -If ``true`` column ``column`` is expanded to the right. +If ``true``, column ``column`` is expanded to the right. .. _class_TreeItem_set_icon: @@ -504,7 +504,7 @@ Sets the given column's icon's texture region. - void **set_selectable** **(** :ref:`int` column, :ref:`bool` selectable **)** -If ``true`` the given column is selectable. +If ``true``, the given column is selectable. .. _class_TreeItem_set_text: diff --git a/classes/class_tween.rst b/classes/class_tween.rst index b2bc20139..23abebbe7 100644 --- a/classes/class_tween.rst +++ b/classes/class_tween.rst @@ -202,7 +202,7 @@ The tween's speed multiplier. For example, set it to ``1.0`` for normal speed, ` | *Getter* | is_repeat() | +----------+-------------------+ -If ``true`` the tween loops. +If ``true``, the tween loops. Method Descriptions ------------------- diff --git a/classes/class_videoplayer.rst b/classes/class_videoplayer.rst index 0dc3d3517..4356903e3 100644 --- a/classes/class_videoplayer.rst +++ b/classes/class_videoplayer.rst @@ -95,7 +95,7 @@ The embedded audio track to play. | *Getter* | has_autoplay() | +----------+---------------------+ -If ``true`` playback starts when the scene loads. Default value: ``false``. +If ``true``, playback starts when the scene loads. Default value: ``false``. .. _class_VideoPlayer_buffering_msec: @@ -131,7 +131,7 @@ Audio bus to use for sound playback. | *Getter* | has_expand() | +----------+-------------------+ -If ``true`` the video scales to the control size. Default value: ``true``. +If ``true``, the video scales to the control size. Default value: ``true``. .. _class_VideoPlayer_paused: @@ -143,7 +143,7 @@ If ``true`` the video scales to the control size. Default value: ``true``. | *Getter* | is_paused() | +----------+-------------------+ -If ``true`` the video is paused. +If ``true``, the video is paused. .. _class_VideoPlayer_stream: diff --git a/classes/class_viewport.rst b/classes/class_viewport.rst index d9fa5b27e..8fd9c2c2d 100644 --- a/classes/class_viewport.rst +++ b/classes/class_viewport.rst @@ -277,7 +277,7 @@ Property Descriptions | *Getter* | use_arvr() | +----------+---------------------+ -If ``true`` the viewport will be used in AR/VR process. Default value: ``false``. +If ``true``, the viewport will be used in AR/VR process. Default value: ``false``. .. _class_Viewport_audio_listener_enable_2d: @@ -289,7 +289,7 @@ If ``true`` the viewport will be used in AR/VR process. Default value: ``false`` | *Getter* | is_audio_listener_2d() | +----------+---------------------------------+ -If ``true`` the viewport will process 2D audio streams. Default value: ``false``. +If ``true``, the viewport will process 2D audio streams. Default value: ``false``. .. _class_Viewport_audio_listener_enable_3d: @@ -301,7 +301,7 @@ If ``true`` the viewport will process 2D audio streams. Default value: ``false`` | *Getter* | is_audio_listener() | +----------+------------------------------+ -If ``true`` the viewport will process 3D audio streams. Default value: ``false``. +If ``true``, the viewport will process 3D audio streams. Default value: ``false``. .. _class_Viewport_canvas_transform: @@ -337,7 +337,7 @@ The overlay mode for test rendered geometry in debug purposes. Default value: `` | *Getter* | is_3d_disabled() | +----------+-----------------------+ -If ``true`` the viewport will disable 3D rendering. For actual disabling use ``usage``. Default value: ``false``. +If ``true``, the viewport will disable 3D rendering. For actual disabling use ``usage``. Default value: ``false``. .. _class_Viewport_global_canvas_transform: @@ -361,7 +361,7 @@ The global canvas transform of the viewport. The canvas transform is relative to | *Getter* | is_input_disabled() | +----------+--------------------------+ -If ``true`` the viewport will not receive input event. Default value: ``false``. +If ``true``, the viewport will not receive input event. Default value: ``false``. .. _class_Viewport_gui_snap_controls_to_pixels: @@ -373,7 +373,7 @@ If ``true`` the viewport will not receive input event. Default value: ``false``. | *Getter* | is_snap_controls_to_pixels_enabled() | +----------+--------------------------------------+ -If ``true`` the GUI controls on the viewport will lay pixel perfectly. Default value: ``true``. +If ``true``, the GUI controls on the viewport will lay pixel perfectly. Default value: ``true``. .. _class_Viewport_handle_input_locally: @@ -395,7 +395,7 @@ If ``true`` the GUI controls on the viewport will lay pixel perfectly. Default v | *Getter* | get_hdr() | +----------+----------------+ -If ``true`` the viewport rendering will receive benefits from High Dynamic Range algorithm. Default value: ``true``. +If ``true``, the viewport rendering will receive benefits from High Dynamic Range algorithm. Default value: ``true``. .. _class_Viewport_keep_3d_linear: @@ -407,7 +407,7 @@ If ``true`` the viewport rendering will receive benefits from High Dynamic Range | *Getter* | get_keep_3d_linear() | +----------+---------------------------+ -If ``true`` the result after 3D rendering will not have a linear to sRGB color conversion applied. This is important when the viewport is used as a render target where the result is used as a texture on a 3D object rendered in another viewport. It is also important if the viewport is used to create data that is not color based (noise, heightmaps, pickmaps, etc.). Do not enable this when the viewport is used as a texture on a 2D object or if the viewport is your final output. +If ``true``, the result after 3D rendering will not have a linear to sRGB color conversion applied. This is important when the viewport is used as a render target where the result is used as a texture on a 3D object rendered in another viewport. It is also important if the viewport is used to create data that is not color based (noise, heightmaps, pickmaps, etc.). Do not enable this when the viewport is used as a texture on a 2D object or if the viewport is your final output. .. _class_Viewport_msaa: @@ -431,7 +431,7 @@ The multisample anti-aliasing mode. Default value: ``MSAA_DISABLED``. | *Getter* | is_using_own_world() | +----------+--------------------------+ -If ``true`` the viewport will use :ref:`World` defined in ``world`` property. Default value: ``false``. +If ``true``, the viewport will use :ref:`World` defined in ``world`` property. Default value: ``false``. .. _class_Viewport_physics_object_picking: @@ -443,7 +443,7 @@ If ``true`` the viewport will use :ref:`World` defined in ``world`` | *Getter* | get_physics_object_picking() | +----------+-----------------------------------+ -If ``true`` the objects rendered by viewport become subjects of mouse picking process. Default value: ``false``. +If ``true``, the objects rendered by viewport become subjects of mouse picking process. Default value: ``false``. .. _class_Viewport_render_target_clear_mode: @@ -479,7 +479,7 @@ The update mode when viewport used as a render target. Default value: ``UPDATE_W | *Getter* | get_vflip() | +----------+------------------+ -If ``true`` the result of rendering will be flipped vertically. Default value: ``false``. +If ``true``, the result of rendering will be flipped vertically. Default value: ``false``. .. _class_Viewport_shadow_atlas_quad_0: @@ -563,7 +563,7 @@ The width and height of viewport. | *Getter* | has_transparent_background() | +----------+-----------------------------------+ -If ``true`` the viewport should render its background as transparent. Default value: ``false``. +If ``true``, the viewport should render its background as transparent. Default value: ``false``. .. _class_Viewport_usage: @@ -724,7 +724,7 @@ Sets the size override of the viewport. If the ``enable`` parameter is ``true`` - void **set_size_override_stretch** **(** :ref:`bool` enabled **)** -If ``true`` the size override affects stretch as well. +If ``true``, the size override affects stretch as well. .. _class_Viewport_unhandled_input: diff --git a/classes/class_viewportcontainer.rst b/classes/class_viewportcontainer.rst index 09e558479..724fdfab7 100644 --- a/classes/class_viewportcontainer.rst +++ b/classes/class_viewportcontainer.rst @@ -43,7 +43,7 @@ Property Descriptions | *Getter* | is_stretch_enabled() | +----------+----------------------+ -If ``true`` the viewport will be scaled to the control's size. Default value:``false``. +If ``true``, the viewport will be scaled to the control's size. Default value:``false``. .. _class_ViewportContainer_stretch_shrink: diff --git a/classes/class_visibilityenabler.rst b/classes/class_visibilityenabler.rst index e17b38e29..b37a0c68d 100644 --- a/classes/class_visibilityenabler.rst +++ b/classes/class_visibilityenabler.rst @@ -56,7 +56,7 @@ Property Descriptions | *Getter* | is_enabler_enabled() | +----------+----------------------+ -If ``true`` :ref:`RigidBody` nodes will be paused. +If ``true``, :ref:`RigidBody` nodes will be paused. .. _class_VisibilityEnabler_pause_animations: @@ -68,5 +68,5 @@ If ``true`` :ref:`RigidBody` nodes will be paused. | *Getter* | is_enabler_enabled() | +----------+----------------------+ -If ``true`` :ref:`AnimationPlayer` nodes will be paused. +If ``true``, :ref:`AnimationPlayer` nodes will be paused. diff --git a/classes/class_visibilityenabler2d.rst b/classes/class_visibilityenabler2d.rst index 29cf90d8d..061d4a3ed 100644 --- a/classes/class_visibilityenabler2d.rst +++ b/classes/class_visibilityenabler2d.rst @@ -72,7 +72,7 @@ Property Descriptions | *Getter* | is_enabler_enabled() | +----------+----------------------+ -If ``true`` :ref:`RigidBody2D` nodes will be paused. +If ``true``, :ref:`RigidBody2D` nodes will be paused. .. _class_VisibilityEnabler2D_pause_animated_sprites: @@ -84,7 +84,7 @@ If ``true`` :ref:`RigidBody2D` nodes will be paused. | *Getter* | is_enabler_enabled() | +----------+----------------------+ -If ``true`` :ref:`AnimatedSprite` nodes will be paused. +If ``true``, :ref:`AnimatedSprite` nodes will be paused. .. _class_VisibilityEnabler2D_pause_animations: @@ -96,7 +96,7 @@ If ``true`` :ref:`AnimatedSprite` nodes will be paused. | *Getter* | is_enabler_enabled() | +----------+----------------------+ -If ``true`` :ref:`AnimationPlayer` nodes will be paused. +If ``true``, :ref:`AnimationPlayer` nodes will be paused. .. _class_VisibilityEnabler2D_pause_particles: @@ -108,7 +108,7 @@ If ``true`` :ref:`AnimationPlayer` nodes will be paused. | *Getter* | is_enabler_enabled() | +----------+----------------------+ -If ``true`` :ref:`Particles2D` nodes will be paused. +If ``true``, :ref:`Particles2D` nodes will be paused. .. _class_VisibilityEnabler2D_physics_process_parent: @@ -120,7 +120,7 @@ If ``true`` :ref:`Particles2D` nodes will be paused. | *Getter* | is_enabler_enabled() | +----------+----------------------+ -If ``true`` the parent's :ref:`Node._physics_process` will be stopped. +If ``true``, the parent's :ref:`Node._physics_process` will be stopped. .. _class_VisibilityEnabler2D_process_parent: @@ -132,5 +132,5 @@ If ``true`` the parent's :ref:`Node._physics_process` will be stopped. +If ``true``, the parent's :ref:`Node._process` will be stopped. diff --git a/classes/class_visibilitynotifier.rst b/classes/class_visibilitynotifier.rst index 2000fdfa6..630066b90 100644 --- a/classes/class_visibilitynotifier.rst +++ b/classes/class_visibilitynotifier.rst @@ -86,5 +86,5 @@ Method Descriptions - :ref:`bool` **is_on_screen** **(** **)** const -If ``true`` the bounding box is on the screen. +If ``true``, the bounding box is on the screen. diff --git a/classes/class_visibilitynotifier2d.rst b/classes/class_visibilitynotifier2d.rst index 497ba6f22..33e827d25 100644 --- a/classes/class_visibilitynotifier2d.rst +++ b/classes/class_visibilitynotifier2d.rst @@ -86,5 +86,5 @@ Method Descriptions - :ref:`bool` **is_on_screen** **(** **)** const -If ``true`` the bounding rectangle is on the screen. +If ``true``, the bounding rectangle is on the screen. diff --git a/classes/class_visualscriptbuiltinfunc.rst b/classes/class_visualscriptbuiltinfunc.rst index 03ab6f4db..9c85f75ab 100644 --- a/classes/class_visualscriptbuiltinfunc.rst +++ b/classes/class_visualscriptbuiltinfunc.rst @@ -122,7 +122,7 @@ enum **BuiltinFunc**: - **LOGIC_MIN** = **45** --- Return the lesser of the two numbers, also known as their minimum. -- **LOGIC_CLAMP** = **46** --- Return the input clamped inside the given range, ensuring the result is never outside it. Equivalent to `min(max(input, range_low), range_high)` +- **LOGIC_CLAMP** = **46** --- Return the input clamped inside the given range, ensuring the result is never outside it. Equivalent to ``min(max(input, range_low), range_high)``. - **LOGIC_NEAREST_PO2** = **47** --- Return the nearest power of 2 to the input. diff --git a/classes/class_visualscriptcondition.rst b/classes/class_visualscriptcondition.rst index a59b4f108..44b979831 100644 --- a/classes/class_visualscriptcondition.rst +++ b/classes/class_visualscriptcondition.rst @@ -19,7 +19,7 @@ A Visual Script node which branches the flow. Description ----------- -A Visual Script node that checks a :ref:`bool` input port. If ``true`` it will exit via the “true” sequence port. If ``false`` it will exit via the "false" sequence port. After exiting either, it exits via the “done” port. Sequence ports may be left disconnected. +A Visual Script node that checks a :ref:`bool` input port. If ``true``, it will exit via the “true” sequence port. If ``false``, it will exit via the "false" sequence port. After exiting either, it exits via the “done” port. Sequence ports may be left disconnected. **Input Ports:** diff --git a/classes/class_visualscriptnode.rst b/classes/class_visualscriptnode.rst index ed575e54a..b1f6aa385 100644 --- a/classes/class_visualscriptnode.rst +++ b/classes/class_visualscriptnode.rst @@ -9,7 +9,7 @@ VisualScriptNode **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`VisualScriptLocalVar`, :ref:`VisualScriptSceneNode`, :ref:`VisualScriptBasicTypeConstant`, :ref:`VisualScriptSequence`, :ref:`VisualScriptVariableSet`, :ref:`VisualScriptSelf`, :ref:`VisualScriptConstant`, :ref:`VisualScriptReturn`, :ref:`VisualScriptSceneTree`, :ref:`VisualScriptIndexSet`, :ref:`VisualScriptResourcePath`, :ref:`VisualScriptPropertyGet`, :ref:`VisualScriptVariableGet`, :ref:`VisualScriptInputAction`, :ref:`VisualScriptEmitSignal`, :ref:`VisualScriptDeconstruct`, :ref:`VisualScriptTypeCast`, :ref:`VisualScriptGlobalConstant`, :ref:`VisualScriptFunctionCall`, :ref:`VisualScriptSwitch`, :ref:`VisualScriptBuiltinFunc`, :ref:`VisualScriptClassConstant`, :ref:`VisualScriptEngineSingleton`, :ref:`VisualScriptCondition`, :ref:`VisualScriptOperator`, :ref:`VisualScriptIterator`, :ref:`VisualScriptCustomNode`, :ref:`VisualScriptYield`, :ref:`VisualScriptSubCall`, :ref:`VisualScriptYieldSignal`, :ref:`VisualScriptIndexGet`, :ref:`VisualScriptLocalVarSet`, :ref:`VisualScriptWhile`, :ref:`VisualScriptConstructor`, :ref:`VisualScriptMathConstant`, :ref:`VisualScriptComment`, :ref:`VisualScriptExpression`, :ref:`VisualScriptPropertySet`, :ref:`VisualScriptFunction`, :ref:`VisualScriptPreload`, :ref:`VisualScriptSelect` +**Inherited By:** :ref:`VisualScriptLocalVar`, :ref:`VisualScriptSceneNode`, :ref:`VisualScriptSequence`, :ref:`VisualScriptVariableSet`, :ref:`VisualScriptSelf`, :ref:`VisualScriptConstant`, :ref:`VisualScriptReturn`, :ref:`VisualScriptSceneTree`, :ref:`VisualScriptIndexSet`, :ref:`VisualScriptResourcePath`, :ref:`VisualScriptPropertyGet`, :ref:`VisualScriptVariableGet`, :ref:`VisualScriptEngineSingleton`, :ref:`VisualScriptEmitSignal`, :ref:`VisualScriptBasicTypeConstant`, :ref:`VisualScriptDeconstruct`, :ref:`VisualScriptTypeCast`, :ref:`VisualScriptGlobalConstant`, :ref:`VisualScriptFunctionCall`, :ref:`VisualScriptSwitch`, :ref:`VisualScriptBuiltinFunc`, :ref:`VisualScriptClassConstant`, :ref:`VisualScriptCondition`, :ref:`VisualScriptOperator`, :ref:`VisualScriptIterator`, :ref:`VisualScriptCustomNode`, :ref:`VisualScriptYield`, :ref:`VisualScriptSubCall`, :ref:`VisualScriptYieldSignal`, :ref:`VisualScriptIndexGet`, :ref:`VisualScriptLocalVarSet`, :ref:`VisualScriptWhile`, :ref:`VisualScriptInputAction`, :ref:`VisualScriptConstructor`, :ref:`VisualScriptMathConstant`, :ref:`VisualScriptComment`, :ref:`VisualScriptExpression`, :ref:`VisualScriptPropertySet`, :ref:`VisualScriptFunction`, :ref:`VisualScriptPreload`, :ref:`VisualScriptSelect` **Category:** Core diff --git a/classes/class_visualscriptreturn.rst b/classes/class_visualscriptreturn.rst index a4b4b1b3d..a3413dc4f 100644 --- a/classes/class_visualscriptreturn.rst +++ b/classes/class_visualscriptreturn.rst @@ -53,7 +53,7 @@ Property Descriptions | *Getter* | is_return_value_enabled() | +----------+--------------------------------+ -If ``true`` the ``return`` input port is available. +If ``true``, the ``return`` input port is available. .. _class_VisualScriptReturn_return_type: diff --git a/classes/class_visualserver.rst b/classes/class_visualserver.rst index 17bf4e52a..58e0fc3db 100644 --- a/classes/class_visualserver.rst +++ b/classes/class_visualserver.rst @@ -208,6 +208,8 @@ Methods +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`environment_set_sky_custom_fov` **(** :ref:`RID` env, :ref:`float` scale **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_sky_orientation` **(** :ref:`RID` env, :ref:`Basis` orientation **)** | ++----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`environment_set_ssao` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` radius, :ref:`float` intensity, :ref:`float` radius2, :ref:`float` intensity2, :ref:`float` bias, :ref:`float` light_affect, :ref:`float` ao_channel_affect, :ref:`Color` color, :ref:`EnvironmentSSAOQuality` quality, :ref:`EnvironmentSSAOBlur` blur, :ref:`float` bilateral_sharpness **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`environment_set_ssr` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`int` max_steps, :ref:`float` fade_in, :ref:`float` fade_out, :ref:`float` depth_tolerance, :ref:`bool` roughness **)** | @@ -588,7 +590,7 @@ Methods +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`scenario_set_fallback_environment` **(** :ref:`RID` scenario, :ref:`RID` environment **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`scenario_set_reflection_atlas_size` **(** :ref:`RID` scenario, :ref:`int` p_size, :ref:`int` subdiv **)** | +| void | :ref:`scenario_set_reflection_atlas_size` **(** :ref:`RID` scenario, :ref:`int` size, :ref:`int` subdiv **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_boot_image` **(** :ref:`Image` image, :ref:`Color` color, :ref:`bool` scale **)** | +----------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -1848,6 +1850,10 @@ Modulates all colors in the given canvas. - void **environment_set_sky_custom_fov** **(** :ref:`RID` env, :ref:`float` scale **)** +.. _class_VisualServer_environment_set_sky_orientation: + +- void **environment_set_sky_orientation** **(** :ref:`RID` env, :ref:`Basis` orientation **)** + .. _class_VisualServer_environment_set_ssao: - void **environment_set_ssao** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` radius, :ref:`float` intensity, :ref:`float` radius2, :ref:`float` intensity2, :ref:`float` bias, :ref:`float` light_affect, :ref:`float` ao_channel_affect, :ref:`Color` color, :ref:`EnvironmentSSAOQuality` quality, :ref:`EnvironmentSSAOBlur` blur, :ref:`float` bilateral_sharpness **)** @@ -2698,7 +2704,7 @@ The callback method must use only 1 argument which will be called with 'userdata .. _class_VisualServer_scenario_set_reflection_atlas_size: -- void **scenario_set_reflection_atlas_size** **(** :ref:`RID` scenario, :ref:`int` p_size, :ref:`int` subdiv **)** +- void **scenario_set_reflection_atlas_size** **(** :ref:`RID` scenario, :ref:`int` size, :ref:`int` subdiv **)** .. _class_VisualServer_set_boot_image: @@ -2896,7 +2902,7 @@ Sets the texture's path. - void **texture_set_shrink_all_x2_on_set_data** **(** :ref:`bool` shrink **)** -If ``true`` sets internal processes to shrink all image data to half the size. +If ``true``, sets internal processes to shrink all image data to half the size. .. _class_VisualServer_texture_set_size_override: @@ -2906,7 +2912,7 @@ If ``true`` sets internal processes to shrink all image data to half the size. - void **textures_keep_original** **(** :ref:`bool` enable **)** -If ``true`` the image will be stored in the texture's images array if overwritten. +If ``true``, the image will be stored in the texture's images array if overwritten. .. _class_VisualServer_viewport_attach_camera: @@ -2960,7 +2966,7 @@ Detaches a viewport from a canvas and vice versa. - void **viewport_set_active** **(** :ref:`RID` viewport, :ref:`bool` active **)** -If ``true`` sets the viewport active, else sets it inactive. +If ``true``, sets the viewport active, else sets it inactive. .. _class_VisualServer_viewport_set_canvas_stacking: @@ -2992,13 +2998,13 @@ Sets the debug draw mode of a viewport. See VIEWPORT_DEBUG_DRAW\_\* constants fo - void **viewport_set_disable_3d** **(** :ref:`RID` viewport, :ref:`bool` disabled **)** -If ``true`` a viewport's 3D rendering is disabled. +If ``true``, a viewport's 3D rendering is disabled. .. _class_VisualServer_viewport_set_disable_environment: - void **viewport_set_disable_environment** **(** :ref:`RID` viewport, :ref:`bool` disabled **)** -If ``true`` rendering of a viewport's environment is disabled. +If ``true``, rendering of a viewport's environment is disabled. .. _class_VisualServer_viewport_set_global_canvas_transform: @@ -3010,13 +3016,13 @@ Sets the viewport's global transformation matrix. - void **viewport_set_hdr** **(** :ref:`RID` viewport, :ref:`bool` enabled **)** -If ``true`` the viewport renders to hdr. +If ``true``, the viewport renders to hdr. .. _class_VisualServer_viewport_set_hide_canvas: - void **viewport_set_hide_canvas** **(** :ref:`RID` viewport, :ref:`bool` hidden **)** -If ``true`` the viewport's canvas is not rendered. +If ``true``, the viewport's canvas is not rendered. .. _class_VisualServer_viewport_set_hide_scenario: @@ -3064,7 +3070,7 @@ Sets the viewport's width and height. - void **viewport_set_transparent_background** **(** :ref:`RID` viewport, :ref:`bool` enabled **)** -If ``true`` the viewport renders its background as transparent. +If ``true``, the viewport renders its background as transparent. .. _class_VisualServer_viewport_set_update_mode: @@ -3082,11 +3088,11 @@ Sets the viewport's 2D/3D mode. See :ref:`ViewportUsage` viewport, :ref:`bool` use_arvr **)** -If ``true`` the viewport uses augmented or virtual reality technologies. See :ref:`ARVRInterface`. +If ``true``, the viewport uses augmented or virtual reality technologies. See :ref:`ARVRInterface`. .. _class_VisualServer_viewport_set_vflip: - void **viewport_set_vflip** **(** :ref:`RID` viewport, :ref:`bool` enabled **)** -If ``true`` the viewport's rendering is flipped vertically. +If ``true``, the viewport's rendering is flipped vertically. diff --git a/classes/class_visualshadernode.rst b/classes/class_visualshadernode.rst index 7f0577bf1..6b6c93ae4 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:`VisualShaderNodeVectorFunc`, :ref:`VisualShaderNodeVectorCompose`, :ref:`VisualShaderNodeTransformDecompose`, :ref:`VisualShaderNodeCubeMapUniform`, :ref:`VisualShaderNodeUniform`, :ref:`VisualShaderNodeTransformVecMult`, :ref:`VisualShaderNodeVectorDecompose`, :ref:`VisualShaderNodeVec3Constant`, :ref:`VisualShaderNodeTransformMult`, :ref:`VisualShaderNodeCubeMap`, :ref:`VisualShaderNodeInput`, :ref:`VisualShaderNodeScalarConstant`, :ref:`VisualShaderNodeScalarFunc`, :ref:`VisualShaderNodeScalarOp`, :ref:`VisualShaderNodeTransformCompose`, :ref:`VisualShaderNodeVectorOp`, :ref:`VisualShaderNodeVectorLen`, :ref:`VisualShaderNodeColorOp`, :ref:`VisualShaderNodeTransformConstant`, :ref:`VisualShaderNodeOutput`, :ref:`VisualShaderNodeVectorInterp`, :ref:`VisualShaderNodeDotProduct`, :ref:`VisualShaderNodeTexture`, :ref:`VisualShaderNodeScalarInterp`, :ref:`VisualShaderNodeColorConstant` +**Inherited By:** :ref:`VisualShaderNodeVectorFunc`, :ref:`VisualShaderNodeVectorCompose`, :ref:`VisualShaderNodeTransformDecompose`, :ref:`VisualShaderNodeCubeMapUniform`, :ref:`VisualShaderNodeUniform`, :ref:`VisualShaderNodeTransformVecMult`, :ref:`VisualShaderNodeVectorDecompose`, :ref:`VisualShaderNodeVec3Constant`, :ref:`VisualShaderNodeTransformMult`, :ref:`VisualShaderNodeInput`, :ref:`VisualShaderNodeScalarConstant`, :ref:`VisualShaderNodeScalarFunc`, :ref:`VisualShaderNodeCubeMap`, :ref:`VisualShaderNodeScalarOp`, :ref:`VisualShaderNodeTransformCompose`, :ref:`VisualShaderNodeVectorOp`, :ref:`VisualShaderNodeVectorLen`, :ref:`VisualShaderNodeColorOp`, :ref:`VisualShaderNodeTransformConstant`, :ref:`VisualShaderNodeOutput`, :ref:`VisualShaderNodeVectorInterp`, :ref:`VisualShaderNodeDotProduct`, :ref:`VisualShaderNodeTexture`, :ref:`VisualShaderNodeScalarInterp`, :ref:`VisualShaderNodeColorConstant` **Category:** Core diff --git a/classes/class_websocketclient.rst b/classes/class_websocketclient.rst index bd7ae7756..790edd51f 100644 --- a/classes/class_websocketclient.rst +++ b/classes/class_websocketclient.rst @@ -100,7 +100,7 @@ Method Descriptions Connect to the given URL requesting one of the given ``protocols`` as sub-protocol. -If ``true`` is passed as ``gd_mp_api``, the client will behave like a network peer for the :ref:`MultiplayerAPI`. Note: connections to non Godot servers will not work, and :ref:`data_received` will not be emitted when this option is true. +If ``true``, is passed as ``gd_mp_api``, the client will behave like a network peer for the :ref:`MultiplayerAPI`. Note: connections to non Godot servers will not work, and :ref:`data_received` will not be emitted when this option is true. .. _class_WebSocketClient_disconnect_from_host: diff --git a/classes/class_windowdialog.rst b/classes/class_windowdialog.rst index f789bd940..c2d6c57d5 100644 --- a/classes/class_windowdialog.rst +++ b/classes/class_windowdialog.rst @@ -75,7 +75,7 @@ Property Descriptions | *Getter* | get_resizable() | +----------+----------------------+ -If ``true`` the user can resize the window. Default value: ``false``. +If ``true``, the user can resize the window. Default value: ``false``. .. _class_WindowDialog_window_title: diff --git a/classes/class_worldenvironment.rst b/classes/class_worldenvironment.rst index 55c9ea837..cf09aacac 100644 --- a/classes/class_worldenvironment.rst +++ b/classes/class_worldenvironment.rst @@ -14,7 +14,7 @@ WorldEnvironment Brief Description ----------------- -Default environment properties for the entire scene (post-processing effects, lightning and background settings). +Default environment properties for the entire scene (post-processing effects, lighting and background settings). Properties ---------- diff --git a/classes/class_ysort.rst b/classes/class_ysort.rst index f80126552..f58cde127 100644 --- a/classes/class_ysort.rst +++ b/classes/class_ysort.rst @@ -41,5 +41,5 @@ Property Descriptions | *Getter* | is_sort_enabled() | +----------+-------------------------+ -If ``true`` child nodes are sorted, otherwise sorting is disabled. Default: ``true``. +If ``true``, child nodes are sorted, otherwise sorting is disabled. Default: ``true``.