From cd7d443fb2a2c36ce53852ed86ebf56513ca78cd Mon Sep 17 00:00:00 2001 From: Poommetee Ketson Date: Wed, 2 Aug 2017 20:00:24 +0700 Subject: [PATCH] Update class reference --- classes/class_@gdscript.rst | 62 ++- classes/class_@global scope.rst | 7 +- classes/class_acceptdialog.rst | 2 +- classes/class_area.rst | 78 +++ classes/class_area2d.rst | 26 + classes/class_array.rst | 17 +- classes/class_arraymesh.rst | 7 - classes/class_astar.rst | 41 +- classes/class_audioeffect.rst | 2 +- classes/class_audioeffectcompressor.rst | 14 +- classes/class_audioeffectlimiter.rst | 14 +- classes/class_audioserver.rst | 6 + classes/class_audiostream.rst | 4 +- ...player.rst => class_audiostreamplayer.rst} | 98 ++-- classes/class_audiostreamplayer2d.rst | 152 ++++++ classes/class_audiostreamplayer3d.rst | 281 ++++++++++ classes/class_audiostreamrandompitch.rst | 56 ++ classes/class_basis.rst | 4 +- classes/class_camera.rst | 15 + classes/class_camera2d.rst | 39 ++ classes/class_canvasitem.rst | 266 ++++----- classes/class_canvasitemmaterial.rst | 68 +++ classes/class_collisionobject.rst | 98 ++-- classes/class_collisionobject2d.rst | 104 ++-- classes/class_collisionpolygon.rst | 33 +- classes/class_collisionpolygon2d.rst | 56 +- classes/class_collisionshape.rst | 27 +- classes/class_collisionshape2d.rst | 56 +- classes/class_control.rst | 51 +- classes/class_curve.rst | 183 +++++++ classes/class_curve3d.rst | 2 +- classes/class_curvetexture.rst | 50 +- classes/class_editorplugin.rst | 67 +++ classes/class_environment.rst | 18 +- classes/class_file.rst | 12 + classes/class_filedialog.rst | 2 +- classes/class_gdfunctionstate.rst | 5 + classes/class_geometryinstance.rst | 2 +- classes/class_giprobe.rst | 13 + classes/class_giprobedata.rst | 13 + classes/class_globalconfig.rst | 150 ------ classes/class_gradienttexture.rst | 85 +-- classes/class_graphedit.rst | 2 +- classes/class_httpclient.rst | 2 +- classes/class_image.rst | 48 +- classes/class_imagetexture.rst | 2 +- classes/class_inputevent.rst | 11 + classes/class_inputmap.rst | 2 +- classes/class_itemlist.rst | 17 +- classes/class_kinematicbody.rst | 256 ++++----- classes/class_kinematicbody2d.rst | 196 +++---- classes/class_material.rst | 28 +- classes/class_mesh.rst | 11 + classes/class_meshdatatool.rst | 12 +- classes/class_meshinstance.rst | 44 +- classes/class_multimesh.rst | 2 +- classes/class_mutex.rst | 2 +- classes/class_ninepatchrect.rst | 33 ++ classes/class_node.rst | 19 +- classes/class_node2d.rst | 2 +- classes/class_object.rst | 26 +- classes/class_optionbutton.rst | 8 +- classes/class_os.rst | 8 +- classes/class_packetpeerudp.rst | 2 +- classes/class_panelcontainer.rst | 2 + classes/class_particleattractor2d.rst | 108 ---- classes/class_particles.rst | 21 +- classes/class_particles2d.rst | 503 ++++++------------ classes/class_particlesmaterial.rst | 17 +- classes/class_physics2ddirectspacestate.rst | 4 +- classes/class_physics2dserver.rst | 62 +-- .../class_physics2dshapequeryparameters.rst | 4 +- classes/class_physicsbody2d.rst | 76 +-- classes/class_poolbytearray.rst | 72 ++- classes/class_poolrealarray.rst | 4 +- classes/class_poolstringarray.rst | 4 +- classes/class_popupmenu.rst | 21 +- classes/class_projectsettings.rst | 150 ++++++ classes/class_rect2.rst | 2 +- classes/class_rect3.rst | 4 +- classes/class_reference.rst | 2 +- classes/class_regex.rst | 44 +- classes/class_remotetransform.rst | 62 ++- classes/class_remotetransform2d.rst | 62 ++- classes/class_resource.rst | 2 +- classes/class_richtextlabel.rst | 177 +++--- classes/class_scenestate.rst | 4 +- classes/class_scenetree.rst | 6 + classes/class_scripteditor.rst | 52 ++ classes/class_scrollcontainer.rst | 2 +- classes/class_shadermaterial.rst | 20 +- classes/class_shape.rst | 2 +- classes/class_slider.rst | 13 + classes/class_spatial.rst | 2 +- classes/class_spatialmaterial.rst | 128 ++++- classes/class_spatialvelocitytracker.rst | 56 ++ classes/class_splitcontainer.rst | 4 +- classes/class_sprite.rst | 110 ++-- classes/class_sprite3d.rst | 2 +- classes/class_spritebase3d.rst | 4 +- classes/class_staticbody.rst | 2 +- classes/class_streampeertcp.rst | 2 +- classes/class_string.rst | 4 +- classes/class_styleboxtexture.rst | 13 + classes/class_tabs.rst | 17 + classes/class_texture.rst | 46 +- classes/class_thread.rst | 2 +- classes/class_tileset.rst | 170 +++--- classes/class_transform2d.rst | 2 +- classes/class_treeitem.rst | 36 ++ classes/class_tween.rst | 2 +- classes/class_undoredo.rst | 14 +- classes/class_vector2.rst | 2 - classes/class_viewport.rst | 2 +- classes/class_visualscriptconstant.rst | 24 +- classes/class_visualscriptemitsignal.rst | 2 +- classes/class_visualscriptfunctioncall.rst | 22 +- classes/class_visualscriptlocalvar.rst | 4 +- classes/class_visualscriptlocalvarset.rst | 4 +- classes/class_visualscriptnode.rst | 2 +- classes/class_visualscriptoperator.rst | 4 +- classes/class_visualscriptpropertyget.rst | 27 +- classes/class_visualscriptpropertyset.rst | 40 +- classes/class_visualscriptreturn.rst | 4 +- classes/class_visualscriptselect.rst | 43 ++ classes/class_visualscripttypecast.rst | 4 +- classes/class_visualscriptvariableget.rst | 2 +- classes/class_visualscriptvariableset.rst | 2 +- classes/class_visualscriptyieldsignal.rst | 8 +- classes/class_world2d.rst | 8 - classes/class_worldenvironment.rst | 2 +- 131 files changed, 3331 insertions(+), 2012 deletions(-) rename classes/{class_audioplayer.rst => class_audiostreamplayer.rst} (58%) create mode 100644 classes/class_audiostreamplayer2d.rst create mode 100644 classes/class_audiostreamplayer3d.rst create mode 100644 classes/class_audiostreamrandompitch.rst create mode 100644 classes/class_canvasitemmaterial.rst create mode 100644 classes/class_curve.rst delete mode 100644 classes/class_globalconfig.rst delete mode 100644 classes/class_particleattractor2d.rst create mode 100644 classes/class_projectsettings.rst create mode 100644 classes/class_scripteditor.rst create mode 100644 classes/class_spatialvelocitytracker.rst create mode 100644 classes/class_visualscriptselect.rst diff --git a/classes/class_@gdscript.rst b/classes/class_@gdscript.rst index 275a5c091..5d1743dc6 100644 --- a/classes/class_@gdscript.rst +++ b/classes/class_@gdscript.rst @@ -168,8 +168,10 @@ Numeric Constants ----------------- - **PI** = **3.141593** --- Constant that represents how many times the diameter of a circumference fits around its perimeter. -- **INF** = **inf** -- **NAN** = **nan** +- **INF** = **inf** --- A positive infinity. (For negative infinity, use -INF). +- **NAN** = **nan** --- Macro constant that expands to an expression of type float that represents a NaN. + +The NaN values are used to identify undefined or non-representable values for floating-point elements, such as the square root of negative numbers or the result of 0/0. Description ----------- @@ -193,19 +195,19 @@ Make a color from red, green, blue and alpha. Arguments can range from 0 to 255. - :ref:`float` **abs** **(** :ref:`float` s **)** -Remove sign (works for integer and float). +Returns the absolute value of parameter s (i.e. unsigned value, works for integer and float). .. _class_@GDScript_acos: - :ref:`float` **acos** **(** :ref:`float` s **)** -Arc-cosine. +Returns the principal value of the arc cosine of s, expressed in radians. In trigonometrics, arc cosine is the inverse operation of cosine. .. _class_@GDScript_asin: - :ref:`float` **asin** **(** :ref:`float` s **)** -Arc-sine. +Returns the principal value of the arc sine of s, expressed in radians. In trigonometrics, arc sine is the inverse operation of sine. .. _class_@GDScript_assert: @@ -217,13 +219,13 @@ Assert that the condition is true. If the condition is false, generates an error - :ref:`float` **atan** **(** :ref:`float` s **)** -Arc-tangent. +Returns the principal value of the arc tangent of s, expressed in radians. In trigonometrics, arc tangent is the inverse operation of tangent. Notice that because of the sign ambiguity, the function cannot determine with certainty in which quadrant the angle falls only by its tangent value. See :ref:`atan2` for an alternative that takes a fractional argument instead. .. _class_@GDScript_atan2: - :ref:`float` **atan2** **(** :ref:`float` x, :ref:`float` y **)** -Arc-tangent that takes a 2D vector as argument, returns the full -pi to +pi range. +Returns the principal value of the arc tangent of y/x, expressed in radians. To compute the value, the function takes into account the sign of both arguments in order to determine the quadrant. .. _class_@GDScript_bytes2var: @@ -235,7 +237,7 @@ Decode a byte array back to a value. - :ref:`float` **ceil** **(** :ref:`float` s **)** -Ceiling (rounds up to nearest integer). +Rounds s upward, returning the smallest integral value that is not less than s. .. _class_@GDScript_char: @@ -245,7 +247,7 @@ Ceiling (rounds up to nearest integer). - :ref:`float` **clamp** **(** :ref:`float` val, :ref:`float` min, :ref:`float` max **)** -Clamp both values to a range. +Clamps a value between a minimum and maximum value. .. _class_@GDScript_convert: @@ -257,13 +259,13 @@ Convert from a type to another in the best way possible. The "type" parameter us - :ref:`float` **cos** **(** :ref:`float` s **)** -Standard cosine function. +Returns the cosine of an angle of s radians. .. _class_@GDScript_cosh: - :ref:`float` **cosh** **(** :ref:`float` s **)** -Hyperbolic cosine. +Returns the hyperbolic cosine of s. .. _class_@GDScript_db2linear: @@ -305,19 +307,25 @@ Easing function, based on exponent. 0 is constant, 1 is linear, 0 to 1 is ease-i - :ref:`float` **exp** **(** :ref:`float` s **)** -Exponential logarithm. +Returns the base-e exponential function of s, which is e raised to the power s: e^s. .. _class_@GDScript_floor: - :ref:`float` **floor** **(** :ref:`float` s **)** -Floor (rounds down to nearest integer). +Rounds s downward, returning the largest integral value that is not greater than s. .. _class_@GDScript_fmod: - :ref:`float` **fmod** **(** :ref:`float` x, :ref:`float` y **)** -Module (remainder of x/y). +Returns the floating-point remainder of x/y (rounded towards zero): + +:: + + fmod = x - tquot \* y + +Where tquot is the truncated (i.e., rounded towards zero) result of: x/y. .. _class_@GDScript_fposmod: @@ -353,10 +361,14 @@ Get an object by its ID. - :ref:`float` **is_inf** **(** :ref:`float` s **)** +Returns whether s is an infinity value (either positive infinity or negative infinity). + .. _class_@GDScript_is_nan: - :ref:`float` **is_nan** **(** :ref:`float` s **)** +Returns whether s is a NaN (Not-A-Number) value. + .. _class_@GDScript_lerp: - :ref:`float` **lerp** **(** :ref:`float` from, :ref:`float` to, :ref:`float` weight **)** @@ -403,7 +415,9 @@ Return the nearest larger power of 2 for an integer. - :ref:`Variant` **parse_json** **(** :ref:`String` json **)** -Parse json text to a Variant (use :ref:`typeof` to check if it is what you expect). +Parse JSON text to a Variant (use :ref:`typeof` to check if it is what you expect). + +Be aware that the JSON specification does not define integer or float types, but only a number type. Therefore, parsing a JSON text will convert every numerical values to :ref:`float` types. .. _class_@GDScript_pow: @@ -499,7 +513,7 @@ Return an array with the given range. Range can be 1 argument N (0 to N-1), two - :ref:`float` **round** **(** :ref:`float` s **)** -Round to nearest integer. +Returns the integral value that is nearest to s, with halfway cases rounded away from zero. .. _class_@GDScript_seed: @@ -517,19 +531,19 @@ Return sign (-1 or +1). - :ref:`float` **sin** **(** :ref:`float` s **)** -Standard sine function. +Returns the sine of an angle of s radians. .. _class_@GDScript_sinh: - :ref:`float` **sinh** **(** :ref:`float` s **)** -Hyperbolic sine. +Returns the hyperbolic sine of s. .. _class_@GDScript_sqrt: - :ref:`float` **sqrt** **(** :ref:`float` s **)** -Square root. +Returns the square root of s. .. _class_@GDScript_stepify: @@ -541,7 +555,7 @@ Snap float value to a given step. - :ref:`String` **str** **(** :ref:`Variant` what, :ref:`Variant` ... **)** -Convert one or more arguments to strings in the best way possible. +Convert one or more arguments to string in the best way possible. .. _class_@GDScript_str2var: @@ -553,13 +567,13 @@ Convert a formatted string that was returned by :ref:`var2str` **tan** **(** :ref:`float` s **)** -Standard tangent function. +Returns the tangent of an angle of s radians. .. _class_@GDScript_tanh: - :ref:`float` **tanh** **(** :ref:`float` s **)** -Hyperbolic tangent. +Returns the hyperbolic tangent of s. .. _class_@GDScript_to_json: @@ -581,6 +595,8 @@ Return the internal type of the given Variant object, using the TYPE\_\* enum in - :ref:`Variant` **validate_json** **(** :ref:`String` json **)** +This method is used to validate the structure and data types of a piece of JSON, similar to XML Schema for XML. + .. _class_@GDScript_var2bytes: - :ref:`PoolByteArray` **var2bytes** **(** :ref:`Variant` var **)** @@ -599,6 +615,8 @@ Convert a value to a formatted string that can later be parsed using :ref:`str2v Return a weak reference to an object. +A weak reference to an object is not enough to keep the object alive: when the only remaining references to a referent are weak references, garbage collection is free to destroy the referent and reuse its memory for something else. However, until the object is actually destroyed the weak reference may return the object even if there are no strong references to it. + .. _class_@GDScript_yield: - :ref:`GDFunctionState` **yield** **(** :ref:`Object` object, :ref:`String` signal **)** diff --git a/classes/class_@global scope.rst b/classes/class_@global scope.rst index 7b1a15a6b..269b2a02c 100644 --- a/classes/class_@global scope.rst +++ b/classes/class_@global scope.rst @@ -17,10 +17,10 @@ Member Variables ---------------- - :ref:`AudioServer` **AudioServer** - [AudioServer] singleton -- :ref:`ClassDB` **ClassDB** -- :ref:`Engine` **Engine** +- :ref:`ClassDB` **ClassDB** - [ClassDB] singleton +- :ref:`Engine` **Engine** - [Engine] singleton - :ref:`Geometry` **Geometry** - [Geometry] singleton -- :ref:`GlobalConfig` **GlobalConfig** +- :ref:`ProjectSettings` **ProjectSettings** - [ProjectSettings] singleton - :ref:`IP` **IP** - [IP] singleton - :ref:`Input` **Input** - [Input] singleton - :ref:`InputMap` **InputMap** - [InputMap] singleton @@ -93,7 +93,6 @@ Numeric Constants - **KEY_F14** = **16777257** --- F14 Key - **KEY_F15** = **16777258** --- F15 Key - **KEY_F16** = **16777259** --- F16 Key -- **KEY_KP_ENTER** = **16777344** --- Enter Key on Numpad - **KEY_KP_MULTIPLY** = **16777345** --- Multiply Key on Numpad - **KEY_KP_DIVIDE** = **16777346** --- Divide Key on Numpad - **KEY_KP_SUBTRACT** = **16777347** --- Subtract Key on Numpad diff --git a/classes/class_acceptdialog.rst b/classes/class_acceptdialog.rst index 18081ab4e..e8f31b207 100644 --- a/classes/class_acceptdialog.rst +++ b/classes/class_acceptdialog.rst @@ -70,7 +70,7 @@ Member Function Description Add custom button to the dialog and return the created button. -The button titled with *text* and the *action* will be passed to :ref:`custom_action` signal when it is pressed. +The button titled with *text* and the *action* will be passed to custom_action signal when it is pressed. .. _class_AcceptDialog_add_cancel: diff --git a/classes/class_area.rst b/classes/class_area.rst index 23dd95660..68634bb0b 100644 --- a/classes/class_area.rst +++ b/classes/class_area.rst @@ -21,6 +21,8 @@ Member Functions +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_angular_damp` **(** **)** const | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_audio_bus` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_collision_layer` **(** **)** const | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | @@ -43,6 +45,12 @@ Member Functions +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_priority` **(** **)** const | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_reverb_amount` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_reverb_bus` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_reverb_uniformity` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_space_override_mode` **(** **)** const | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_gravity_a_point` **(** **)** const | @@ -51,12 +59,20 @@ Member Functions +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_monitoring` **(** **)** const | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_overriding_audio_bus` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_using_reverb_bus` **(** **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`overlaps_area` **(** :ref:`Object` area **)** const | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`overlaps_body` **(** :ref:`Object` body **)** const | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_angular_damp` **(** :ref:`float` angular_damp **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_audio_bus` **(** :ref:`String` name **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_audio_bus_override` **(** :ref:`bool` enable **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_layer` **(** :ref:`int` collision_layer **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | @@ -81,8 +97,16 @@ Member Functions +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_priority` **(** :ref:`float` priority **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_reverb_amount` **(** :ref:`float` amount **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_reverb_bus` **(** :ref:`String` name **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_reverb_uniformity` **(** :ref:`float` amount **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_space_override_mode` **(** :ref:`int` enable **)** | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_reverb_bus` **(** :ref:`bool` enable **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -116,6 +140,8 @@ Member Variables ---------------- - :ref:`float` **angular_damp** +- :ref:`String` **audio_bus_name** +- :ref:`bool` **audio_bus_override** - :ref:`int` **collision_layer** - :ref:`int` **collision_mask** - :ref:`float` **gravity** @@ -126,6 +152,10 @@ Member Variables - :ref:`bool` **monitorable** - :ref:`bool` **monitoring** - :ref:`int` **priority** +- :ref:`float` **reverb_bus_amount** +- :ref:`bool` **reverb_bus_enable** +- :ref:`String` **reverb_bus_name** +- :ref:`float` **reverb_bus_uniformity** - :ref:`int` **space_override** Description @@ -142,6 +172,10 @@ Member Function Description Return the angular damp rate. +.. _class_Area_get_audio_bus: + +- :ref:`String` **get_audio_bus** **(** **)** const + .. _class_Area_get_collision_layer: - :ref:`int` **get_collision_layer** **(** **)** const @@ -208,6 +242,18 @@ Return a list of the bodies (:ref:`PhysicsBody`) that are tot Return the processing order of this area. +.. _class_Area_get_reverb_amount: + +- :ref:`float` **get_reverb_amount** **(** **)** const + +.. _class_Area_get_reverb_bus: + +- :ref:`String` **get_reverb_bus** **(** **)** const + +.. _class_Area_get_reverb_uniformity: + +- :ref:`float` **get_reverb_uniformity** **(** **)** const + .. _class_Area_get_space_override_mode: - :ref:`int` **get_space_override_mode** **(** **)** const @@ -232,6 +278,14 @@ Return whether this area can be detected by other, monitoring, areas. Return whether this area detects bodies/areas entering/exiting it. +.. _class_Area_is_overriding_audio_bus: + +- :ref:`bool` **is_overriding_audio_bus** **(** **)** const + +.. _class_Area_is_using_reverb_bus: + +- :ref:`bool` **is_using_reverb_bus** **(** **)** const + .. _class_Area_overlaps_area: - :ref:`bool` **overlaps_area** **(** :ref:`Object` area **)** const @@ -252,6 +306,14 @@ Set the rate at which objects stop spinning in this area, if there are not any o In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second. +.. _class_Area_set_audio_bus: + +- void **set_audio_bus** **(** :ref:`String` name **)** + +.. _class_Area_set_audio_bus_override: + +- void **set_audio_bus_override** **(** :ref:`bool` enable **)** + .. _class_Area_set_collision_layer: - void **set_collision_layer** **(** :ref:`int` collision_layer **)** @@ -336,6 +398,18 @@ Set the order in which the area is processed. Greater values mean the area gets Areas with the same priority value get evaluated in an unpredictable order, and should be differentiated if evaluation order is to be important. +.. _class_Area_set_reverb_amount: + +- void **set_reverb_amount** **(** :ref:`float` amount **)** + +.. _class_Area_set_reverb_bus: + +- void **set_reverb_bus** **(** :ref:`String` name **)** + +.. _class_Area_set_reverb_uniformity: + +- void **set_reverb_uniformity** **(** :ref:`float` amount **)** + .. _class_Area_set_space_override_mode: - void **set_space_override_mode** **(** :ref:`int` enable **)** @@ -352,4 +426,8 @@ AREA_SPACE_OVERRIDE_REPLACE: This area replaces any gravity/damp, even the defau AREA_SPACE_OVERRIDE_REPLACE_COMBINE: This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one. +.. _class_Area_set_use_reverb_bus: + +- void **set_use_reverb_bus** **(** :ref:`bool` enable **)** + diff --git a/classes/class_area2d.rst b/classes/class_area2d.rst index d2d115f1e..079234e2c 100644 --- a/classes/class_area2d.rst +++ b/classes/class_area2d.rst @@ -21,6 +21,8 @@ Member Functions +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_angular_damp` **(** **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_audio_bus` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_collision_layer` **(** **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | @@ -51,12 +53,18 @@ Member Functions +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_monitoring` **(** **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_overriding_audio_bus` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`overlaps_area` **(** :ref:`Object` area **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`overlaps_body` **(** :ref:`Object` body **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_angular_damp` **(** :ref:`float` angular_damp **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_audio_bus` **(** :ref:`String` name **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_audio_bus_override` **(** :ref:`bool` enable **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_layer` **(** :ref:`int` collision_layer **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | @@ -116,6 +124,8 @@ Member Variables ---------------- - :ref:`float` **angular_damp** +- :ref:`String` **audio_bus_name** +- :ref:`bool` **audio_bus_override** - :ref:`int` **collision_layer** - :ref:`int` **collision_mask** - :ref:`float` **gravity** @@ -142,6 +152,10 @@ Member Function Description Return the angular damp rate. +.. _class_Area2D_get_audio_bus: + +- :ref:`String` **get_audio_bus** **(** **)** const + .. _class_Area2D_get_collision_layer: - :ref:`int` **get_collision_layer** **(** **)** const @@ -232,6 +246,10 @@ Return whether this area can be detected by other, monitoring, areas. Return whether this area detects bodies/areas entering/exiting it. +.. _class_Area2D_is_overriding_audio_bus: + +- :ref:`bool` **is_overriding_audio_bus** **(** **)** const + .. _class_Area2D_overlaps_area: - :ref:`bool` **overlaps_area** **(** :ref:`Object` area **)** const @@ -252,6 +270,14 @@ Set the rate at which objects stop spinning in this area, if there are not any o In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second. +.. _class_Area2D_set_audio_bus: + +- void **set_audio_bus** **(** :ref:`String` name **)** + +.. _class_Area2D_set_audio_bus_override: + +- void **set_audio_bus_override** **(** :ref:`bool` enable **)** + .. _class_Area2D_set_collision_layer: - void **set_collision_layer** **(** :ref:`int` collision_layer **)** diff --git a/classes/class_array.rst b/classes/class_array.rst index 6990f7b87..6f6c5e99a 100644 --- a/classes/class_array.rst +++ b/classes/class_array.rst @@ -90,19 +90,19 @@ Member Function Description - :ref:`Array` **Array** **(** :ref:`PoolColorArray` from **)** -Construct an array from a :ref:`PoolByteArray`. +Construct an array from a :ref:`PoolColorArray`. .. _class_Array_Array: - :ref:`Array` **Array** **(** :ref:`PoolVector3Array` from **)** -Construct an array from a :ref:`PoolByteArray`. +Construct an array from a :ref:`PoolVector3Array`. .. _class_Array_Array: - :ref:`Array` **Array** **(** :ref:`PoolVector2Array` from **)** -Construct an array from a :ref:`PoolByteArray`. +Construct an array from a :ref:`PoolVector2Array`. .. _class_Array_Array: @@ -120,7 +120,7 @@ Construct an array from a :ref:`PoolRealArray`. - :ref:`Array` **Array** **(** :ref:`PoolIntArray` from **)** -Construct an array from a :ref:`PoolByteArray`. +Construct an array from a :ref:`PoolIntArray`. .. _class_Array_Array: @@ -186,7 +186,14 @@ Returns the first element of the array if the array is not empty (size>0). - :ref:`bool` **has** **(** var value **)** -Return true if the array contains given value. ``:ref:` "inside", 7 `.has("inside") == true, :ref:` "inside", 7 `.has("outside") == false, :ref:` "inside", 7 `.has(7) == true, :ref:` "inside", 7 `.has("7") == false`` +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 .. _class_Array_hash: diff --git a/classes/class_arraymesh.rst b/classes/class_arraymesh.rst index 237a5ce91..a44b69caa 100644 --- a/classes/class_arraymesh.rst +++ b/classes/class_arraymesh.rst @@ -85,13 +85,6 @@ Numeric Constants - **ARRAY_FORMAT_BONES** = **64** --- Array format will include bone indices. - **ARRAY_FORMAT_WEIGHTS** = **128** --- Array format will include bone weights. - **ARRAY_FORMAT_INDEX** = **256** --- Index array will be used. -- **PRIMITIVE_POINTS** = **0** --- Render array as points (one vertex equals one point). -- **PRIMITIVE_LINES** = **1** --- Render array as lines (every two vertices a line is created). -- **PRIMITIVE_LINE_STRIP** = **2** --- Render array as line strip. -- **PRIMITIVE_LINE_LOOP** = **3** --- Render array as line loop (like line strip, but closed). -- **PRIMITIVE_TRIANGLES** = **4** --- Render array as triangles (every three vertices a triangle is created). -- **PRIMITIVE_TRIANGLE_STRIP** = **5** --- Render array as triangle strips. -- **PRIMITIVE_TRIANGLE_FAN** = **6** --- Render array as triangle fans. Member Function Description --------------------------- diff --git a/classes/class_astar.rst b/classes/class_astar.rst index 742d808c6..350cdbf50 100644 --- a/classes/class_astar.rst +++ b/classes/class_astar.rst @@ -13,7 +13,7 @@ AStar Brief Description ----------------- - +AStar class representation that uses vectors as edges. Member Functions ---------------- @@ -47,9 +47,18 @@ Member Functions +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_point_weight_scale` **(** :ref:`int` id **)** const | +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_point` **(** :ref:`int` id **)** const | ++--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_point` **(** :ref:`int` id **)** | +--------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +Description +----------- + +A\* (A star) is a computer algorithm that is widely used in pathfinding and graph traversal, the process of plotting an efficiently directed path between multiple points. It enjoys widespread use due to its performance and accuracy. Godot's A\* implementation make use of vectors as points. + +You must add points manually with :ref:`AStar.add_point` and create segments manually with :ref:`AStar.connect_points`. So you can test if there is a path between two points with the :ref:`AStar.are_points_connected` function, get the list of existing ids in the found path with :ref:`AStar.get_id_path`, or the points list with :ref:`AStar.get_point_path`. + Member Function Description --------------------------- @@ -65,24 +74,32 @@ Member Function Description - void **add_point** **(** :ref:`int` id, :ref:`Vector3` pos, :ref:`float` weight_scale=1 **)** -Add a new point at the given position. The ``weight_scale`` has to be 1 or larger. +Add a new point at the given position ``pos`` with the given identifier ``id``. The ``weight_scale`` has to be 1 or larger. .. _class_AStar_are_points_connected: - :ref:`bool` **are_points_connected** **(** :ref:`int` id, :ref:`int` to_id **)** const +Returns if there is a connection/segment between points ``id`` and ``from_id`` + .. _class_AStar_clear: - void **clear** **(** **)** +Clear all the points and segments from AStar instance. + .. _class_AStar_connect_points: - void **connect_points** **(** :ref:`int` id, :ref:`int` to_id, :ref:`bool` bidirectional=true **)** +Create a segment between points ``id`` and ``to_id``. + .. _class_AStar_disconnect_points: - void **disconnect_points** **(** :ref:`int` id, :ref:`int` to_id **)** +Deletes a segment between points ``id`` and ``to_id``. + .. _class_AStar_get_available_point_id: - :ref:`int` **get_available_point_id** **(** **)** const @@ -91,28 +108,48 @@ Add a new point at the given position. The ``weight_scale`` has to be 1 or large - :ref:`int` **get_closest_point** **(** :ref:`Vector3` to_pos **)** const +Returns the id of closest point of given point. -1 is returned if there are no points on AStar. + .. _class_AStar_get_closest_pos_in_segment: - :ref:`Vector3` **get_closest_pos_in_segment** **(** :ref:`Vector3` to_pos **)** const +Returns the position of closest point that has segments. + .. _class_AStar_get_id_path: - :ref:`PoolIntArray` **get_id_path** **(** :ref:`int` from_id, :ref:`int` to_id **)** +Returns an array with the point ids of path found by AStar between two given points. + .. _class_AStar_get_point_path: - :ref:`PoolVector3Array` **get_point_path** **(** :ref:`int` from_id, :ref:`int` to_id **)** +Returns an array with the points of path found by AStar between two given points. + .. _class_AStar_get_point_pos: - :ref:`Vector3` **get_point_pos** **(** :ref:`int` id **)** const +Returns the position of point with given id. + .. _class_AStar_get_point_weight_scale: - :ref:`float` **get_point_weight_scale** **(** :ref:`int` id **)** const +Returns the weight scale of point with given id. + +.. _class_AStar_has_point: + +- :ref:`bool` **has_point** **(** :ref:`int` id **)** const + +Returns if the point with given id exists on AStar; + .. _class_AStar_remove_point: - void **remove_point** **(** :ref:`int` id **)** +Removes the point with given id. + diff --git a/classes/class_audioeffect.rst b/classes/class_audioeffect.rst index e3c70b326..263bc3c9f 100644 --- a/classes/class_audioeffect.rst +++ b/classes/class_audioeffect.rst @@ -8,7 +8,7 @@ AudioEffect **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`AudioEffectCompressor`, :ref:`AudioEffectAmplify`, :ref:`AudioEffectFilter`, :ref:`AudioEffectDistortion`, :ref:`AudioEffectLimiter`, :ref:`AudioEffectDelay`, :ref:`AudioEffectStereoEnhance`, :ref:`AudioEffectReverb`, :ref:`AudioEffectPanner`, :ref:`AudioEffectEQ`, :ref:`AudioEffectChorus`, :ref:`AudioEffectPitchShift`, :ref:`AudioEffectPhaser` +**Inherited By:** :ref:`AudioEffectCompressor`, :ref:`AudioEffectAmplify`, :ref:`AudioEffectFilter`, :ref:`AudioEffectDistortion`, :ref:`AudioEffectLimiter`, :ref:`AudioEffectDelay`, :ref:`AudioEffectStereoEnhance`, :ref:`AudioEffectPanner`, :ref:`AudioEffectReverb`, :ref:`AudioEffectEQ`, :ref:`AudioEffectChorus`, :ref:`AudioEffectPitchShift`, :ref:`AudioEffectPhaser` **Category:** Core diff --git a/classes/class_audioeffectcompressor.rst b/classes/class_audioeffectcompressor.rst index 2d9e3b38d..c562314c4 100644 --- a/classes/class_audioeffectcompressor.rst +++ b/classes/class_audioeffectcompressor.rst @@ -31,7 +31,7 @@ Member Functions +------------------------------+----------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_sidechain` **(** **)** const | +------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_treshold` **(** **)** const | +| :ref:`float` | :ref:`get_threshold` **(** **)** const | +------------------------------+----------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_attack_us` **(** :ref:`float` attack_us **)** | +------------------------------+----------------------------------------------------------------------------------------------------------------------+ @@ -45,7 +45,7 @@ Member Functions +------------------------------+----------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_sidechain` **(** :ref:`String` sidechain **)** | +------------------------------+----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_treshold` **(** :ref:`float` treshold **)** | +| void | :ref:`set_threshold` **(** :ref:`float` threshold **)** | +------------------------------+----------------------------------------------------------------------------------------------------------------------+ Member Variables @@ -57,7 +57,7 @@ Member Variables - :ref:`float` **ratio** - :ref:`float` **release_ms** - :ref:`float` **sidechain** -- :ref:`float` **treshold** +- :ref:`float` **threshold** Member Function Description --------------------------- @@ -86,9 +86,9 @@ Member Function Description - :ref:`String` **get_sidechain** **(** **)** const -.. _class_AudioEffectCompressor_get_treshold: +.. _class_AudioEffectCompressor_get_threshold: -- :ref:`float` **get_treshold** **(** **)** const +- :ref:`float` **get_threshold** **(** **)** const .. _class_AudioEffectCompressor_set_attack_us: @@ -114,8 +114,8 @@ Member Function Description - void **set_sidechain** **(** :ref:`String` sidechain **)** -.. _class_AudioEffectCompressor_set_treshold: +.. _class_AudioEffectCompressor_set_threshold: -- void **set_treshold** **(** :ref:`float` treshold **)** +- void **set_threshold** **(** :ref:`float` threshold **)** diff --git a/classes/class_audioeffectlimiter.rst b/classes/class_audioeffectlimiter.rst index a37a52531..4a9ea19f3 100644 --- a/classes/class_audioeffectlimiter.rst +++ b/classes/class_audioeffectlimiter.rst @@ -25,7 +25,7 @@ Member Functions +----------------------------+----------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_soft_clip_ratio` **(** **)** const | +----------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_treshold_db` **(** **)** const | +| :ref:`float` | :ref:`get_threshold_db` **(** **)** const | +----------------------------+----------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_ceiling_db` **(** :ref:`float` ceiling **)** | +----------------------------+----------------------------------------------------------------------------------------------------------------------------+ @@ -33,7 +33,7 @@ Member Functions +----------------------------+----------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_soft_clip_ratio` **(** :ref:`float` soft_clip **)** | +----------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_treshold_db` **(** :ref:`float` treshold **)** | +| void | :ref:`set_threshold_db` **(** :ref:`float` threshold **)** | +----------------------------+----------------------------------------------------------------------------------------------------------------------------+ Member Variables @@ -42,7 +42,7 @@ Member Variables - :ref:`float` **ceiling_db** - :ref:`float` **soft_clip_db** - :ref:`float` **soft_clip_ratio** -- :ref:`float` **treshold_db** +- :ref:`float` **threshold_db** Member Function Description --------------------------- @@ -59,9 +59,9 @@ Member Function Description - :ref:`float` **get_soft_clip_ratio** **(** **)** const -.. _class_AudioEffectLimiter_get_treshold_db: +.. _class_AudioEffectLimiter_get_threshold_db: -- :ref:`float` **get_treshold_db** **(** **)** const +- :ref:`float` **get_threshold_db** **(** **)** const .. _class_AudioEffectLimiter_set_ceiling_db: @@ -75,8 +75,8 @@ Member Function Description - void **set_soft_clip_ratio** **(** :ref:`float` soft_clip **)** -.. _class_AudioEffectLimiter_set_treshold_db: +.. _class_AudioEffectLimiter_set_threshold_db: -- void **set_treshold_db** **(** :ref:`float` treshold **)** +- void **set_threshold_db** **(** :ref:`float` threshold **)** diff --git a/classes/class_audioserver.rst b/classes/class_audioserver.rst index b63438ccd..516238cb0 100644 --- a/classes/class_audioserver.rst +++ b/classes/class_audioserver.rst @@ -31,6 +31,8 @@ Member Functions +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`get_bus_effect_count` **(** :ref:`int` bus_idx, :ref:`Object` arg1, :ref:`int` arg2 **)** | +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_bus_index` **(** :ref:`String` bus_name **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_bus_name` **(** :ref:`int` bus_idx **)** const | +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_bus_peak_volume_left_db` **(** :ref:`int` bus_idx, :ref:`int` channel **)** const | @@ -121,6 +123,10 @@ Member Function Description - void **get_bus_effect_count** **(** :ref:`int` bus_idx, :ref:`Object` arg1, :ref:`int` arg2 **)** +.. _class_AudioServer_get_bus_index: + +- :ref:`int` **get_bus_index** **(** :ref:`String` bus_name **)** const + .. _class_AudioServer_get_bus_name: - :ref:`String` **get_bus_name** **(** :ref:`int` bus_idx **)** const diff --git a/classes/class_audiostream.rst b/classes/class_audiostream.rst index 8b363150b..a4513f3d3 100644 --- a/classes/class_audiostream.rst +++ b/classes/class_audiostream.rst @@ -8,7 +8,7 @@ AudioStream **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`AudioStreamSample`, :ref:`AudioStreamOGGVorbis` +**Inherited By:** :ref:`AudioStreamSample`, :ref:`AudioStreamRandomPitch`, :ref:`AudioStreamOGGVorbis` **Category:** Core @@ -20,5 +20,5 @@ Base class for audio streams. Description ----------- -Base class for audio streams. Audio streams are used for music playback, or other types of streamed sounds that don't fit or require more flexibility than a :ref:`Sample`. +Base class for audio streams. Audio streams are used for music playback, or other types of streamed sounds that don't fit or require more flexibility than a Sample. diff --git a/classes/class_audioplayer.rst b/classes/class_audiostreamplayer.rst similarity index 58% rename from classes/class_audioplayer.rst rename to classes/class_audiostreamplayer.rst index f12e2e160..847e8b0b2 100644 --- a/classes/class_audioplayer.rst +++ b/classes/class_audiostreamplayer.rst @@ -1,10 +1,10 @@ .. Generated automatically by doc/tools/makerst.py in Godot's source tree. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. -.. _class_AudioPlayer: +.. _class_AudioStreamPlayer: -AudioPlayer -=========== +AudioStreamPlayer +================= **Inherits:** :ref:`Node` **<** :ref:`Object` @@ -18,37 +18,37 @@ Brief Description Member Functions ---------------- -+------------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_bus` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_mix_target` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_pos` **(** **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_stream` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_volume_db` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_autoplay_enabled` **(** **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_playing` **(** **)** const | -+------------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`play` **(** :ref:`float` from_pos=0 **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`seek` **(** :ref:`float` to_pos **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_autoplay` **(** :ref:`bool` enable **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bus` **(** :ref:`String` bus **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mix_target` **(** :ref:`int` mix_target **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_stream` **(** :ref:`AudioStream` stream **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_volume_db` **(** :ref:`float` volume_db **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** **)** | -+------------------------------+------------------------------------------------------------------------------------------------------------+ ++------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_bus` **(** **)** const | ++------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_mix_target` **(** **)** const | ++------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_pos` **(** **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_stream` **(** **)** const | ++------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_volume_db` **(** **)** const | ++------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_autoplay_enabled` **(** **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_playing` **(** **)** const | ++------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`play` **(** :ref:`float` from_pos=0 **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`seek` **(** :ref:`float` to_pos **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_autoplay` **(** :ref:`bool` enable **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus` **(** :ref:`String` bus **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_mix_target` **(** :ref:`int` mix_target **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_stream` **(** :ref:`AudioStream` stream **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_volume_db` **(** :ref:`float` volume_db **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++------------------------------+------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -63,63 +63,63 @@ Member Variables Member Function Description --------------------------- -.. _class_AudioPlayer_get_bus: +.. _class_AudioStreamPlayer_get_bus: - :ref:`String` **get_bus** **(** **)** const -.. _class_AudioPlayer_get_mix_target: +.. _class_AudioStreamPlayer_get_mix_target: - :ref:`int` **get_mix_target** **(** **)** const -.. _class_AudioPlayer_get_pos: +.. _class_AudioStreamPlayer_get_pos: - :ref:`float` **get_pos** **(** **)** -.. _class_AudioPlayer_get_stream: +.. _class_AudioStreamPlayer_get_stream: - :ref:`Object` **get_stream** **(** **)** const -.. _class_AudioPlayer_get_volume_db: +.. _class_AudioStreamPlayer_get_volume_db: - :ref:`float` **get_volume_db** **(** **)** const -.. _class_AudioPlayer_is_autoplay_enabled: +.. _class_AudioStreamPlayer_is_autoplay_enabled: - :ref:`bool` **is_autoplay_enabled** **(** **)** -.. _class_AudioPlayer_is_playing: +.. _class_AudioStreamPlayer_is_playing: - :ref:`bool` **is_playing** **(** **)** const -.. _class_AudioPlayer_play: +.. _class_AudioStreamPlayer_play: - void **play** **(** :ref:`float` from_pos=0 **)** -.. _class_AudioPlayer_seek: +.. _class_AudioStreamPlayer_seek: - void **seek** **(** :ref:`float` to_pos **)** -.. _class_AudioPlayer_set_autoplay: +.. _class_AudioStreamPlayer_set_autoplay: - void **set_autoplay** **(** :ref:`bool` enable **)** -.. _class_AudioPlayer_set_bus: +.. _class_AudioStreamPlayer_set_bus: - void **set_bus** **(** :ref:`String` bus **)** -.. _class_AudioPlayer_set_mix_target: +.. _class_AudioStreamPlayer_set_mix_target: - void **set_mix_target** **(** :ref:`int` mix_target **)** -.. _class_AudioPlayer_set_stream: +.. _class_AudioStreamPlayer_set_stream: - void **set_stream** **(** :ref:`AudioStream` stream **)** -.. _class_AudioPlayer_set_volume_db: +.. _class_AudioStreamPlayer_set_volume_db: - void **set_volume_db** **(** :ref:`float` volume_db **)** -.. _class_AudioPlayer_stop: +.. _class_AudioStreamPlayer_stop: - void **stop** **(** **)** diff --git a/classes/class_audiostreamplayer2d.rst b/classes/class_audiostreamplayer2d.rst new file mode 100644 index 000000000..b6f1fff0b --- /dev/null +++ b/classes/class_audiostreamplayer2d.rst @@ -0,0 +1,152 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. + +.. _class_AudioStreamPlayer2D: + +AudioStreamPlayer2D +=================== + +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_area_mask` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_attenuation` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_bus` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_max_distance` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_pos` **(** **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_stream` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_volume_db` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_autoplay_enabled` **(** **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_playing` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`play` **(** :ref:`float` from_pos=0 **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`seek` **(** :ref:`float` to_pos **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_area_mask` **(** :ref:`int` mask **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_attenuation` **(** :ref:`float` curve **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_autoplay` **(** :ref:`bool` enable **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus` **(** :ref:`String` bus **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_max_distance` **(** :ref:`float` pixels **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_stream` **(** :ref:`AudioStream` stream **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_volume_db` **(** :ref:`float` volume_db **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`int` **area_mask** +- :ref:`float` **attenuation** +- :ref:`bool` **autoplay** +- :ref:`String` **bus** +- :ref:`float` **max_distance** +- :ref:`bool` **playing** +- :ref:`AudioStream` **stream** +- :ref:`float` **volume_db** + +Member Function Description +--------------------------- + +.. _class_AudioStreamPlayer2D_get_area_mask: + +- :ref:`int` **get_area_mask** **(** **)** const + +.. _class_AudioStreamPlayer2D_get_attenuation: + +- :ref:`float` **get_attenuation** **(** **)** const + +.. _class_AudioStreamPlayer2D_get_bus: + +- :ref:`String` **get_bus** **(** **)** const + +.. _class_AudioStreamPlayer2D_get_max_distance: + +- :ref:`float` **get_max_distance** **(** **)** const + +.. _class_AudioStreamPlayer2D_get_pos: + +- :ref:`float` **get_pos** **(** **)** + +.. _class_AudioStreamPlayer2D_get_stream: + +- :ref:`Object` **get_stream** **(** **)** const + +.. _class_AudioStreamPlayer2D_get_volume_db: + +- :ref:`float` **get_volume_db** **(** **)** const + +.. _class_AudioStreamPlayer2D_is_autoplay_enabled: + +- :ref:`bool` **is_autoplay_enabled** **(** **)** + +.. _class_AudioStreamPlayer2D_is_playing: + +- :ref:`bool` **is_playing** **(** **)** const + +.. _class_AudioStreamPlayer2D_play: + +- void **play** **(** :ref:`float` from_pos=0 **)** + +.. _class_AudioStreamPlayer2D_seek: + +- void **seek** **(** :ref:`float` to_pos **)** + +.. _class_AudioStreamPlayer2D_set_area_mask: + +- void **set_area_mask** **(** :ref:`int` mask **)** + +.. _class_AudioStreamPlayer2D_set_attenuation: + +- void **set_attenuation** **(** :ref:`float` curve **)** + +.. _class_AudioStreamPlayer2D_set_autoplay: + +- void **set_autoplay** **(** :ref:`bool` enable **)** + +.. _class_AudioStreamPlayer2D_set_bus: + +- void **set_bus** **(** :ref:`String` bus **)** + +.. _class_AudioStreamPlayer2D_set_max_distance: + +- void **set_max_distance** **(** :ref:`float` pixels **)** + +.. _class_AudioStreamPlayer2D_set_stream: + +- void **set_stream** **(** :ref:`AudioStream` stream **)** + +.. _class_AudioStreamPlayer2D_set_volume_db: + +- void **set_volume_db** **(** :ref:`float` volume_db **)** + +.. _class_AudioStreamPlayer2D_stop: + +- void **stop** **(** **)** + + diff --git a/classes/class_audiostreamplayer3d.rst b/classes/class_audiostreamplayer3d.rst new file mode 100644 index 000000000..b1f5ea708 --- /dev/null +++ b/classes/class_audiostreamplayer3d.rst @@ -0,0 +1,281 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. + +.. _class_AudioStreamPlayer3D: + +AudioStreamPlayer3D +=================== + +**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_area_mask` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_attenuation_filter_cutoff_hz` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_attenuation_filter_db` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_attenuation_model` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_bus` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_doppler_tracking` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_emission_angle` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_emission_angle_filter_attenuation_db` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_max_db` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_max_distance` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_out_of_range_mode` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_pos` **(** **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_stream` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_unit_db` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_unit_size` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_autoplay_enabled` **(** **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_emission_angle_enabled` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_playing` **(** **)** const | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`play` **(** :ref:`float` from_pos=0 **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`seek` **(** :ref:`float` to_pos **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_area_mask` **(** :ref:`int` mask **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_attenuation_filter_cutoff_hz` **(** :ref:`float` degrees **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_attenuation_filter_db` **(** :ref:`float` db **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_attenuation_model` **(** :ref:`int` model **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_autoplay` **(** :ref:`bool` enable **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bus` **(** :ref:`String` bus **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_doppler_tracking` **(** :ref:`int` mode **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_emission_angle` **(** :ref:`float` degrees **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_emission_angle_enabled` **(** :ref:`bool` enabled **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_emission_angle_filter_attenuation_db` **(** :ref:`float` db **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_max_db` **(** :ref:`float` max_db **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_max_distance` **(** :ref:`float` metres **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_out_of_range_mode` **(** :ref:`int` mode **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_stream` **(** :ref:`AudioStream` stream **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_unit_db` **(** :ref:`float` unit_db **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_unit_size` **(** :ref:`float` unit_size **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`int` **area_mask** +- :ref:`float` **attenuation_filter_cutoff_hz** +- :ref:`float` **attenuation_filter_db** +- :ref:`int` **attenuation_model** +- :ref:`bool` **autoplay** +- :ref:`String` **bus** +- :ref:`int` **doppler_tracking** +- :ref:`float` **emission_angle_degrees** +- :ref:`bool` **emission_angle_enabled** +- :ref:`float` **emission_angle_filter_attenuation_db** +- :ref:`float` **max_db** +- :ref:`float` **max_distance** +- :ref:`int` **out_of_range_mode** +- :ref:`bool` **playing** +- :ref:`AudioStream` **stream** +- :ref:`float` **unit_db** +- :ref:`float` **unit_size** + +Numeric Constants +----------------- + +- **ATTENUATION_INVERSE_DISTANCE** = **0** +- **ATTENUATION_INVERSE_SQUARE_DISTANCE** = **1** +- **ATTENUATION_LOGARITHMIC** = **2** +- **OUT_OF_RANGE_MIX** = **0** +- **OUT_OF_RANGE_PAUSE** = **1** +- **DOPPLER_TRACKING_DISABLED** = **0** +- **DOPPLER_TRACKING_IDLE_STEP** = **1** +- **DOPPLER_TRACKING_FIXED_STEP** = **2** + +Member Function Description +--------------------------- + +.. _class_AudioStreamPlayer3D_get_area_mask: + +- :ref:`int` **get_area_mask** **(** **)** const + +.. _class_AudioStreamPlayer3D_get_attenuation_filter_cutoff_hz: + +- :ref:`float` **get_attenuation_filter_cutoff_hz** **(** **)** const + +.. _class_AudioStreamPlayer3D_get_attenuation_filter_db: + +- :ref:`float` **get_attenuation_filter_db** **(** **)** const + +.. _class_AudioStreamPlayer3D_get_attenuation_model: + +- :ref:`int` **get_attenuation_model** **(** **)** const + +.. _class_AudioStreamPlayer3D_get_bus: + +- :ref:`String` **get_bus** **(** **)** const + +.. _class_AudioStreamPlayer3D_get_doppler_tracking: + +- :ref:`int` **get_doppler_tracking** **(** **)** const + +.. _class_AudioStreamPlayer3D_get_emission_angle: + +- :ref:`float` **get_emission_angle** **(** **)** const + +.. _class_AudioStreamPlayer3D_get_emission_angle_filter_attenuation_db: + +- :ref:`float` **get_emission_angle_filter_attenuation_db** **(** **)** const + +.. _class_AudioStreamPlayer3D_get_max_db: + +- :ref:`float` **get_max_db** **(** **)** const + +.. _class_AudioStreamPlayer3D_get_max_distance: + +- :ref:`float` **get_max_distance** **(** **)** const + +.. _class_AudioStreamPlayer3D_get_out_of_range_mode: + +- :ref:`int` **get_out_of_range_mode** **(** **)** const + +.. _class_AudioStreamPlayer3D_get_pos: + +- :ref:`float` **get_pos** **(** **)** + +.. _class_AudioStreamPlayer3D_get_stream: + +- :ref:`Object` **get_stream** **(** **)** const + +.. _class_AudioStreamPlayer3D_get_unit_db: + +- :ref:`float` **get_unit_db** **(** **)** const + +.. _class_AudioStreamPlayer3D_get_unit_size: + +- :ref:`float` **get_unit_size** **(** **)** const + +.. _class_AudioStreamPlayer3D_is_autoplay_enabled: + +- :ref:`bool` **is_autoplay_enabled** **(** **)** + +.. _class_AudioStreamPlayer3D_is_emission_angle_enabled: + +- :ref:`bool` **is_emission_angle_enabled** **(** **)** const + +.. _class_AudioStreamPlayer3D_is_playing: + +- :ref:`bool` **is_playing** **(** **)** const + +.. _class_AudioStreamPlayer3D_play: + +- void **play** **(** :ref:`float` from_pos=0 **)** + +.. _class_AudioStreamPlayer3D_seek: + +- void **seek** **(** :ref:`float` to_pos **)** + +.. _class_AudioStreamPlayer3D_set_area_mask: + +- void **set_area_mask** **(** :ref:`int` mask **)** + +.. _class_AudioStreamPlayer3D_set_attenuation_filter_cutoff_hz: + +- void **set_attenuation_filter_cutoff_hz** **(** :ref:`float` degrees **)** + +.. _class_AudioStreamPlayer3D_set_attenuation_filter_db: + +- void **set_attenuation_filter_db** **(** :ref:`float` db **)** + +.. _class_AudioStreamPlayer3D_set_attenuation_model: + +- void **set_attenuation_model** **(** :ref:`int` model **)** + +.. _class_AudioStreamPlayer3D_set_autoplay: + +- void **set_autoplay** **(** :ref:`bool` enable **)** + +.. _class_AudioStreamPlayer3D_set_bus: + +- void **set_bus** **(** :ref:`String` bus **)** + +.. _class_AudioStreamPlayer3D_set_doppler_tracking: + +- void **set_doppler_tracking** **(** :ref:`int` mode **)** + +.. _class_AudioStreamPlayer3D_set_emission_angle: + +- void **set_emission_angle** **(** :ref:`float` degrees **)** + +.. _class_AudioStreamPlayer3D_set_emission_angle_enabled: + +- void **set_emission_angle_enabled** **(** :ref:`bool` enabled **)** + +.. _class_AudioStreamPlayer3D_set_emission_angle_filter_attenuation_db: + +- void **set_emission_angle_filter_attenuation_db** **(** :ref:`float` db **)** + +.. _class_AudioStreamPlayer3D_set_max_db: + +- void **set_max_db** **(** :ref:`float` max_db **)** + +.. _class_AudioStreamPlayer3D_set_max_distance: + +- void **set_max_distance** **(** :ref:`float` metres **)** + +.. _class_AudioStreamPlayer3D_set_out_of_range_mode: + +- void **set_out_of_range_mode** **(** :ref:`int` mode **)** + +.. _class_AudioStreamPlayer3D_set_stream: + +- void **set_stream** **(** :ref:`AudioStream` stream **)** + +.. _class_AudioStreamPlayer3D_set_unit_db: + +- void **set_unit_db** **(** :ref:`float` unit_db **)** + +.. _class_AudioStreamPlayer3D_set_unit_size: + +- void **set_unit_size** **(** :ref:`float` unit_size **)** + +.. _class_AudioStreamPlayer3D_stop: + +- void **stop** **(** **)** + + diff --git a/classes/class_audiostreamrandompitch.rst b/classes/class_audiostreamrandompitch.rst new file mode 100644 index 000000000..67416ba4c --- /dev/null +++ b/classes/class_audiostreamrandompitch.rst @@ -0,0 +1,56 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. + +.. _class_AudioStreamRandomPitch: + +AudioStreamRandomPitch +====================== + +**Inherits:** :ref:`AudioStream` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_audio_stream` **(** **)** const | ++------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_random_pitch` **(** **)** const | ++------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_audio_stream` **(** :ref:`Object` stream **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_random_pitch` **(** :ref:`float` scale **)** | ++------------------------------+-------------------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`AudioStream` **audio_stream** +- :ref:`float` **random_pitch** + +Member Function Description +--------------------------- + +.. _class_AudioStreamRandomPitch_get_audio_stream: + +- :ref:`Object` **get_audio_stream** **(** **)** const + +.. _class_AudioStreamRandomPitch_get_random_pitch: + +- :ref:`float` **get_random_pitch** **(** **)** const + +.. _class_AudioStreamRandomPitch_set_audio_stream: + +- void **set_audio_stream** **(** :ref:`Object` stream **)** + +.. _class_AudioStreamRandomPitch_set_random_pitch: + +- void **set_random_pitch** **(** :ref:`float` scale **)** + + diff --git a/classes/class_basis.rst b/classes/class_basis.rst index 96b163d65..eb9259012 100644 --- a/classes/class_basis.rst +++ b/classes/class_basis.rst @@ -195,12 +195,12 @@ Return the transposed version of the matrix. - :ref:`Vector3` **xform** **(** :ref:`Vector3` v **)** -Return a vector transformed (multiplied) by the matrix and return it. +Return a vector transformed (multiplied) by the matrix. .. _class_Basis_xform_inv: - :ref:`Vector3` **xform_inv** **(** :ref:`Vector3` v **)** -Return a vector transformed (multiplied) by the transposed matrix and return it. Note that this is a multiplication by inverse only when the matrix represents a rotation-reflection. +Return a vector transformed (multiplied) by the transposed matrix. Note that this results in a multiplication by the inverse of the matrix only if it represents a rotation-reflection. diff --git a/classes/class_camera.rst b/classes/class_camera.rst index 12f2e1ca4..d9f8589ed 100644 --- a/classes/class_camera.rst +++ b/classes/class_camera.rst @@ -27,6 +27,8 @@ Member Functions +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_cull_mask` **(** **)** const | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_doppler_tracking` **(** **)** const | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Environment` | :ref:`get_environment` **(** **)** const | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_fov` **(** **)** const | @@ -61,6 +63,8 @@ Member Functions +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_cull_mask` **(** :ref:`int` mask **)** | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_doppler_tracking` **(** :ref:`int` mode **)** | ++----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_environment` **(** :ref:`Environment` env **)** | +----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_h_offset` **(** :ref:`float` ofs **)** | @@ -83,6 +87,9 @@ Numeric Constants - **PROJECTION_ORTHOGONAL** = **1** --- Orthogonal Projection (objects remain the same size on the screen no matter how far away they are). - **KEEP_WIDTH** = **0** - **KEEP_HEIGHT** = **1** +- **DOPPLER_TRACKING_DISABLED** = **0** +- **DOPPLER_TRACKING_IDLE_STEP** = **1** +- **DOPPLER_TRACKING_FIXED_STEP** = **2** Description ----------- @@ -106,6 +113,10 @@ Get the camera transform. Subclassed cameras (such as CharacterCamera) may provi - :ref:`int` **get_cull_mask** **(** **)** const +.. _class_Camera_get_doppler_tracking: + +- :ref:`int` **get_doppler_tracking** **(** **)** const + .. _class_Camera_get_environment: - :ref:`Environment` **get_environment** **(** **)** const @@ -182,6 +193,10 @@ Return a 3D position in worldspace, that is the result of projecting a point on - void **set_cull_mask** **(** :ref:`int` mask **)** +.. _class_Camera_set_doppler_tracking: + +- void **set_doppler_tracking** **(** :ref:`int` mode **)** + .. _class_Camera_set_environment: - void **set_environment** **(** :ref:`Environment` env **)** diff --git a/classes/class_camera2d.rst b/classes/class_camera2d.rst index 3d50d21bb..e8f99abc3 100644 --- a/classes/class_camera2d.rst +++ b/classes/class_camera2d.rst @@ -53,10 +53,16 @@ Member Functions +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_h_drag_enabled` **(** **)** const | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_limit_drawing_enabled` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_limit_smoothing_enabled` **(** **)** const | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_margin_drawing_enabled` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_rotating` **(** **)** const | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_screen_drawing_enabled` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_v_drag_enabled` **(** **)** const | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`make_current` **(** **)** | @@ -79,12 +85,18 @@ Member Functions +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_limit` **(** :ref:`int` margin, :ref:`int` limit **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_limit_drawing_enabled` **(** :ref:`bool` limit_drawing_enabled **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_limit_smoothing_enabled` **(** :ref:`bool` limit_smoothing_enabled **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_margin_drawing_enabled` **(** :ref:`bool` margin_drawing_enabled **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_offset` **(** :ref:`Vector2` offset **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_rotating` **(** :ref:`bool` rotating **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_screen_drawing_enabled` **(** :ref:`bool` screen_drawing_enabled **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_v_drag_enabled` **(** :ref:`bool` enabled **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_v_offset` **(** :ref:`float` ofs **)** | @@ -103,6 +115,9 @@ Member Variables - :ref:`float` **drag_margin_right** - :ref:`float` **drag_margin_top** - :ref:`bool` **drag_margin_v_enabled** +- :ref:`bool` **editor_draw_drag_margin** +- :ref:`bool` **editor_draw_limits** +- :ref:`bool` **editor_draw_screen** - :ref:`int` **limit_bottom** - :ref:`int` **limit_left** - :ref:`int` **limit_right** @@ -212,14 +227,26 @@ Return true of this is the current camera (see :ref:`make_current` **is_h_drag_enabled** **(** **)** const +.. _class_Camera2D_is_limit_drawing_enabled: + +- :ref:`bool` **is_limit_drawing_enabled** **(** **)** const + .. _class_Camera2D_is_limit_smoothing_enabled: - :ref:`bool` **is_limit_smoothing_enabled** **(** **)** const +.. _class_Camera2D_is_margin_drawing_enabled: + +- :ref:`bool` **is_margin_drawing_enabled** **(** **)** const + .. _class_Camera2D_is_rotating: - :ref:`bool` **is_rotating** **(** **)** const +.. _class_Camera2D_is_screen_drawing_enabled: + +- :ref:`bool` **is_screen_drawing_enabled** **(** **)** const + .. _class_Camera2D_is_v_drag_enabled: - :ref:`bool` **is_v_drag_enabled** **(** **)** const @@ -274,6 +301,10 @@ Set the margins needed to drag the camera (relative to the screen size). Margin Set the scrolling limit in pixels. +.. _class_Camera2D_set_limit_drawing_enabled: + +- void **set_limit_drawing_enabled** **(** :ref:`bool` limit_drawing_enabled **)** + .. _class_Camera2D_set_limit_smoothing_enabled: - void **set_limit_smoothing_enabled** **(** :ref:`bool` limit_smoothing_enabled **)** @@ -282,6 +313,10 @@ Smooth camera when reaching camera limits. This requires camera smoothing being enabled to have a noticeable effect. +.. _class_Camera2D_set_margin_drawing_enabled: + +- void **set_margin_drawing_enabled** **(** :ref:`bool` margin_drawing_enabled **)** + .. _class_Camera2D_set_offset: - void **set_offset** **(** :ref:`Vector2` offset **)** @@ -292,6 +327,10 @@ Set the scroll offset. Useful for looking around or camera shake animations. - void **set_rotating** **(** :ref:`bool` rotating **)** +.. _class_Camera2D_set_screen_drawing_enabled: + +- void **set_screen_drawing_enabled** **(** :ref:`bool` screen_drawing_enabled **)** + .. _class_Camera2D_set_v_drag_enabled: - void **set_v_drag_enabled** **(** :ref:`bool` enabled **)** diff --git a/classes/class_canvasitem.rst b/classes/class_canvasitem.rst index 6373a6464..52b208a40 100644 --- a/classes/class_canvasitem.rst +++ b/classes/class_canvasitem.rst @@ -20,123 +20,127 @@ Base class of anything 2D. Member Functions ---------------- -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_draw` **(** **)** virtual | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`draw_char` **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` char, :ref:`String` next, :ref:`Color` modulate=Color(1,1,1,1) **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_circle` **(** :ref:`Vector2` pos, :ref:`float` radius, :ref:`Color` color **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_colored_polygon` **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`PoolVector2Array` uvs=PoolVector2Array([]), :ref:`Texture` texture=NULL **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_line` **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1, :ref:`bool` antialiased=false **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_polygon` **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array([]), :ref:`Texture` texture=NULL **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_primitive` **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs, :ref:`Texture` texture=NULL, :ref:`float` width=1 **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_rect` **(** :ref:`Rect2` rect, :ref:`Color` color **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_set_transform` **(** :ref:`Vector2` pos, :ref:`float` rot, :ref:`Vector2` scale **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_set_transform_matrix` **(** :ref:`Transform2D` xform **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_string` **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` text, :ref:`Color` modulate=Color(1,1,1,1), :ref:`int` clip_w=-1 **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_style_box` **(** :ref:`StyleBox` style_box, :ref:`Rect2` rect **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_texture` **(** :ref:`Texture` texture, :ref:`Vector2` pos, :ref:`Color` modulate=Color(1,1,1,1) **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_texture_rect` **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color(1,1,1,1), :ref:`bool` transpose=false **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_texture_rect_region` **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color(1,1,1,1), :ref:`bool` transpose=false **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`edit_get_state` **(** **)** const | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`edit_rotate` **(** :ref:`float` degrees **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`edit_set_rect` **(** :ref:`Rect2` rect **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`edit_set_state` **(** :ref:`Variant` state **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_canvas` **(** **)** const | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_canvas_item` **(** **)** const | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_canvas_transform` **(** **)** const | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_global_mouse_position` **(** **)** const | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_global_transform` **(** **)** const | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_global_transform_with_canvas` **(** **)** const | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_item_and_children_rect` **(** **)** const | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_item_rect` **(** **)** const | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_light_mask` **(** **)** const | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_local_mouse_pos` **(** **)** const | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ShaderMaterial` | :ref:`get_material` **(** **)** const | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_modulate` **(** **)** const | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_self_modulate` **(** **)** const | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_transform` **(** **)** const | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_use_parent_material` **(** **)** const | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_viewport_rect` **(** **)** const | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_viewport_transform` **(** **)** const | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_world_2d` **(** **)** const | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`hide` **(** **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_draw_behind_parent_enabled` **(** **)** const | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_local_transform_notification_enabled` **(** **)** const | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_set_as_toplevel` **(** **)** const | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_transform_notification_enabled` **(** **)** const | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_visible` **(** **)** const | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_visible_in_tree` **(** **)** const | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`make_canvas_pos_local` **(** :ref:`Vector2` screen_point **)** const | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`make_input_local` **(** :ref:`Object` event **)** const | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_as_toplevel` **(** :ref:`bool` enable **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_draw_behind_parent` **(** :ref:`bool` enable **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_light_mask` **(** :ref:`int` light_mask **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_material` **(** :ref:`ShaderMaterial` material **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_modulate` **(** :ref:`Color` modulate **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_notify_local_transform` **(** :ref:`bool` enable **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_notify_transform` **(** :ref:`bool` enable **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_self_modulate` **(** :ref:`Color` self_modulate **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_parent_material` **(** :ref:`bool` enable **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_visible` **(** :ref:`bool` arg0 **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`show` **(** **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`update` **(** **)** | -+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_draw` **(** **)** virtual | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`draw_char` **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` char, :ref:`String` next, :ref:`Color` modulate=Color(1,1,1,1) **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_circle` **(** :ref:`Vector2` pos, :ref:`float` radius, :ref:`Color` color **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_colored_polygon` **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`PoolVector2Array` uvs=PoolVector2Array([]), :ref:`Texture` texture=NULL, :ref:`Texture` normal_map=NULL **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_line` **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1, :ref:`bool` antialiased=false **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_polygon` **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array([]), :ref:`Texture` texture=NULL, :ref:`Texture` normal_map=NULL **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_polyline` **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`float` width=1, :ref:`bool` antialiased=false **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_polyline_colors` **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1, :ref:`bool` antialiased=false **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_primitive` **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs, :ref:`Texture` texture=NULL, :ref:`float` width=1, :ref:`Texture` normal_map=NULL **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_rect` **(** :ref:`Rect2` rect, :ref:`Color` color, :ref:`bool` filled=true **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_set_transform` **(** :ref:`Vector2` pos, :ref:`float` rot, :ref:`Vector2` scale **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_set_transform_matrix` **(** :ref:`Transform2D` xform **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_string` **(** :ref:`Font` font, :ref:`Vector2` pos, :ref:`String` text, :ref:`Color` modulate=Color(1,1,1,1), :ref:`int` clip_w=-1 **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_style_box` **(** :ref:`StyleBox` style_box, :ref:`Rect2` rect **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_texture` **(** :ref:`Texture` texture, :ref:`Vector2` pos, :ref:`Color` modulate=Color(1,1,1,1), :ref:`Texture` normal_map=NULL **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_texture_rect` **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color(1,1,1,1), :ref:`bool` transpose=false, :ref:`Texture` normal_map=NULL **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_texture_rect_region` **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color(1,1,1,1), :ref:`bool` transpose=false, :ref:`Texture` normal_map=NULL, :ref:`bool` clip_uv=true **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`edit_get_state` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`edit_rotate` **(** :ref:`float` degrees **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`edit_set_rect` **(** :ref:`Rect2` rect **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`edit_set_state` **(** :ref:`Variant` state **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_canvas` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_canvas_item` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_canvas_transform` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_global_mouse_position` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_global_transform` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_global_transform_with_canvas` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_item_and_children_rect` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_item_rect` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_light_mask` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_local_mouse_pos` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Material` | :ref:`get_material` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_modulate` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_self_modulate` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_transform` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_use_parent_material` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_viewport_rect` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`get_viewport_transform` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_world_2d` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`hide` **(** **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_draw_behind_parent_enabled` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_local_transform_notification_enabled` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_set_as_toplevel` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_transform_notification_enabled` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_visible` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_visible_in_tree` **(** **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`make_canvas_pos_local` **(** :ref:`Vector2` screen_point **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`make_input_local` **(** :ref:`Object` event **)** const | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_as_toplevel` **(** :ref:`bool` enable **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_draw_behind_parent` **(** :ref:`bool` enable **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_light_mask` **(** :ref:`int` light_mask **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_material` **(** :ref:`Material` material **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_modulate` **(** :ref:`Color` modulate **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_notify_local_transform` **(** :ref:`bool` enable **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_notify_transform` **(** :ref:`bool` enable **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_self_modulate` **(** :ref:`Color` self_modulate **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_parent_material` **(** :ref:`bool` enable **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_visible` **(** :ref:`bool` arg0 **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`show` **(** **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`update` **(** **)** | ++----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -158,7 +162,7 @@ Member Variables ---------------- - :ref:`int` **light_mask** -- :ref:`ShaderMaterial` **material** +- ShaderMaterial,CanvasItemMaterial **material** - :ref:`Color` **modulate** - :ref:`Color` **self_modulate** - :ref:`bool` **show_behind_parent** @@ -216,7 +220,7 @@ Draw a colored circle. .. _class_CanvasItem_draw_colored_polygon: -- void **draw_colored_polygon** **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`PoolVector2Array` uvs=PoolVector2Array([]), :ref:`Texture` texture=NULL **)** +- void **draw_colored_polygon** **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`PoolVector2Array` uvs=PoolVector2Array([]), :ref:`Texture` texture=NULL, :ref:`Texture` normal_map=NULL **)** Draw a colored polygon of any amount of points, convex or concave. @@ -228,19 +232,27 @@ Draw a line from a 2D point to another, with a given color and width. It can be .. _class_CanvasItem_draw_polygon: -- void **draw_polygon** **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array([]), :ref:`Texture` texture=NULL **)** +- void **draw_polygon** **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs=PoolVector2Array([]), :ref:`Texture` texture=NULL, :ref:`Texture` normal_map=NULL **)** Draw a polygon of any amount of points, convex or concave. +.. _class_CanvasItem_draw_polyline: + +- void **draw_polyline** **(** :ref:`PoolVector2Array` points, :ref:`Color` color, :ref:`float` width=1, :ref:`bool` antialiased=false **)** + +.. _class_CanvasItem_draw_polyline_colors: + +- void **draw_polyline_colors** **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`float` width=1, :ref:`bool` antialiased=false **)** + .. _class_CanvasItem_draw_primitive: -- void **draw_primitive** **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs, :ref:`Texture` texture=NULL, :ref:`float` width=1 **)** +- void **draw_primitive** **(** :ref:`PoolVector2Array` points, :ref:`PoolColorArray` colors, :ref:`PoolVector2Array` uvs, :ref:`Texture` texture=NULL, :ref:`float` width=1, :ref:`Texture` normal_map=NULL **)** Draw a custom primitive, 1 point for a point, 2 points for a line, 3 points for a triangle and 4 points for a quad. .. _class_CanvasItem_draw_rect: -- void **draw_rect** **(** :ref:`Rect2` rect, :ref:`Color` color **)** +- void **draw_rect** **(** :ref:`Rect2` rect, :ref:`Color` color, :ref:`bool` filled=true **)** Draw a colored rectangle. @@ -268,19 +280,19 @@ Draw a styled rectangle. .. _class_CanvasItem_draw_texture: -- void **draw_texture** **(** :ref:`Texture` texture, :ref:`Vector2` pos, :ref:`Color` modulate=Color(1,1,1,1) **)** +- void **draw_texture** **(** :ref:`Texture` texture, :ref:`Vector2` pos, :ref:`Color` modulate=Color(1,1,1,1), :ref:`Texture` normal_map=NULL **)** Draw a texture at a given position. .. _class_CanvasItem_draw_texture_rect: -- void **draw_texture_rect** **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color(1,1,1,1), :ref:`bool` transpose=false **)** +- void **draw_texture_rect** **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color(1,1,1,1), :ref:`bool` transpose=false, :ref:`Texture` normal_map=NULL **)** Draw a textured rectangle at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture. .. _class_CanvasItem_draw_texture_rect_region: -- void **draw_texture_rect_region** **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color(1,1,1,1), :ref:`bool` transpose=false **)** +- void **draw_texture_rect_region** **(** :ref:`Texture` texture, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color(1,1,1,1), :ref:`bool` transpose=false, :ref:`Texture` normal_map=NULL, :ref:`bool` clip_uv=true **)** Draw a textured rectangle region at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture. @@ -368,7 +380,7 @@ Get the mouse position relative to this item's position. .. _class_CanvasItem_get_material: -- :ref:`ShaderMaterial` **get_material** **(** **)** const +- :ref:`Material` **get_material** **(** **)** const Get the material of this item. @@ -478,7 +490,7 @@ Set the ligtht mask number of this item. .. _class_CanvasItem_set_material: -- void **set_material** **(** :ref:`ShaderMaterial` material **)** +- void **set_material** **(** :ref:`Material` material **)** Set the material of this item. diff --git a/classes/class_canvasitemmaterial.rst b/classes/class_canvasitemmaterial.rst new file mode 100644 index 000000000..27fce1016 --- /dev/null +++ b/classes/class_canvasitemmaterial.rst @@ -0,0 +1,68 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. + +.. _class_CanvasItemMaterial: + +CanvasItemMaterial +================== + +**Inherits:** :ref:`Material` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_blend_mode` **(** **)** const | ++------------------------+---------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_light_mode` **(** **)** const | ++------------------------+---------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_blend_mode` **(** :ref:`int` blend_mode **)** | ++------------------------+---------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_light_mode` **(** :ref:`int` light_mode **)** | ++------------------------+---------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`int` **blend_mode** +- :ref:`int` **light_mode** + +Numeric Constants +----------------- + +- **BLEND_MODE_MIX** = **0** +- **BLEND_MODE_ADD** = **1** +- **BLEND_MODE_SUB** = **2** +- **BLEND_MODE_MUL** = **3** +- **BLEND_MODE_PREMULT_ALPHA** = **4** +- **LIGHT_MODE_NORMAL** = **0** +- **LIGHT_MODE_UNSHADED** = **1** +- **LIGHT_MODE_LIGHT_ONLY** = **2** + +Member Function Description +--------------------------- + +.. _class_CanvasItemMaterial_get_blend_mode: + +- :ref:`int` **get_blend_mode** **(** **)** const + +.. _class_CanvasItemMaterial_get_light_mode: + +- :ref:`int` **get_light_mode** **(** **)** const + +.. _class_CanvasItemMaterial_set_blend_mode: + +- void **set_blend_mode** **(** :ref:`int` blend_mode **)** + +.. _class_CanvasItemMaterial_set_light_mode: + +- void **set_light_mode** **(** :ref:`int` light_mode **)** + + diff --git a/classes/class_collisionobject.rst b/classes/class_collisionobject.rst index be18e7d2a..ec66abc8e 100644 --- a/classes/class_collisionobject.rst +++ b/classes/class_collisionobject.rst @@ -23,36 +23,30 @@ Member Functions +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_input_event` **(** :ref:`Object` camera, :ref:`InputEvent` event, :ref:`Vector3` click_pos, :ref:`Vector3` click_normal, :ref:`int` shape_idx **)** virtual | +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_shape` **(** :ref:`Shape` shape, :ref:`Transform` transform=Transform() **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_shapes` **(** **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_capture_input_on_drag` **(** **)** const | +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`create_shape_owner` **(** :ref:`Object` owner **)** | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_rid` **(** **)** const | +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Shape` | :ref:`get_shape` **(** :ref:`int` shape_idx **)** const | +| :ref:`Array` | :ref:`get_shape_owners` **(** **)** | +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_shape_count` **(** **)** const | +| void | :ref:`shape_owner_clear_shapes` **(** :ref:`int` owner_id **)** | +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform` | :ref:`get_shape_transform` **(** :ref:`int` shape_idx **)** const | +| :ref:`Shape` | :ref:`shape_owner_get_shape` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`shape_owner_get_shape_count` **(** :ref:`int` owner_id **)** | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform` | :ref:`shape_owner_get_transform` **(** :ref:`int` owner_id **)** | ++------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shape_owner_remove_shape` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** | +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_ray_pickable` **(** **)** const | +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_shape_set_as_trigger` **(** :ref:`int` shape_idx **)** const | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_shape` **(** :ref:`int` shape_idx **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_capture_input_on_drag` **(** :ref:`bool` enable **)** | +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_ray_pickable` **(** :ref:`bool` ray_pickable **)** | +------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shape` **(** :ref:`int` shape_idx, :ref:`Shape` shape **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shape_as_trigger` **(** :ref:`int` shape_idx, :ref:`bool` enable **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shape_transform` **(** :ref:`int` shape_idx, :ref:`Transform` transform **)** | -+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -74,46 +68,60 @@ Member Function Description - void **_input_event** **(** :ref:`Object` camera, :ref:`InputEvent` event, :ref:`Vector3` click_pos, :ref:`Vector3` click_normal, :ref:`int` shape_idx **)** virtual -.. _class_CollisionObject_add_shape: - -- void **add_shape** **(** :ref:`Shape` shape, :ref:`Transform` transform=Transform() **)** - -.. _class_CollisionObject_clear_shapes: - -- void **clear_shapes** **(** **)** - .. _class_CollisionObject_get_capture_input_on_drag: - :ref:`bool` **get_capture_input_on_drag** **(** **)** const +.. _class_CollisionObject_create_shape_owner: + +- :ref:`int` **create_shape_owner** **(** :ref:`Object` owner **)** + +Creates new holder for the shapes. Argument is a :ref:`CollisionShape` node. It will return owner_id which usually you will want to save for later use. + .. _class_CollisionObject_get_rid: - :ref:`RID` **get_rid** **(** **)** const -.. _class_CollisionObject_get_shape: +.. _class_CollisionObject_get_shape_owners: -- :ref:`Shape` **get_shape** **(** :ref:`int` shape_idx **)** const +- :ref:`Array` **get_shape_owners** **(** **)** -.. _class_CollisionObject_get_shape_count: +Shape owner is a node which is holding concrete shape resources. This method will return an array which is holding an integer numbers that are representing unique ID of each owner. You can use those ids when you are using others shape_owner methods. -- :ref:`int` **get_shape_count** **(** **)** const +.. _class_CollisionObject_shape_owner_clear_shapes: -.. _class_CollisionObject_get_shape_transform: +- void **shape_owner_clear_shapes** **(** :ref:`int` owner_id **)** -- :ref:`Transform` **get_shape_transform** **(** :ref:`int` shape_idx **)** const +Will remove all the shapes associated with given owner. + +.. _class_CollisionObject_shape_owner_get_shape: + +- :ref:`Shape` **shape_owner_get_shape** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** + +Will return a :ref:`Shape`. First argument owner_id is an integer that can be obtained from :ref:`get_shape_owners`. Shape_id is a position of the shape inside owner; it's a value in range from 0 to :ref:`shape_owner_get_shape_count`. + +.. _class_CollisionObject_shape_owner_get_shape_count: + +- :ref:`int` **shape_owner_get_shape_count** **(** :ref:`int` owner_id **)** + +Returns number of shapes to which given owner is associated to. + +.. _class_CollisionObject_shape_owner_get_transform: + +- :ref:`Transform` **shape_owner_get_transform** **(** :ref:`int` owner_id **)** + +Will return :ref:`Transform` of an owner node. + +.. _class_CollisionObject_shape_owner_remove_shape: + +- void **shape_owner_remove_shape** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** + +Removes related shape from the owner. .. _class_CollisionObject_is_ray_pickable: - :ref:`bool` **is_ray_pickable** **(** **)** const -.. _class_CollisionObject_is_shape_set_as_trigger: - -- :ref:`bool` **is_shape_set_as_trigger** **(** :ref:`int` shape_idx **)** const - -.. _class_CollisionObject_remove_shape: - -- void **remove_shape** **(** :ref:`int` shape_idx **)** - .. _class_CollisionObject_set_capture_input_on_drag: - void **set_capture_input_on_drag** **(** :ref:`bool` enable **)** @@ -122,16 +130,4 @@ Member Function Description - void **set_ray_pickable** **(** :ref:`bool` ray_pickable **)** -.. _class_CollisionObject_set_shape: - -- void **set_shape** **(** :ref:`int` shape_idx, :ref:`Shape` shape **)** - -.. _class_CollisionObject_set_shape_as_trigger: - -- void **set_shape_as_trigger** **(** :ref:`int` shape_idx, :ref:`bool` enable **)** - -.. _class_CollisionObject_set_shape_transform: - -- void **set_shape_transform** **(** :ref:`int` shape_idx, :ref:`Transform` transform **)** - diff --git a/classes/class_collisionobject2d.rst b/classes/class_collisionobject2d.rst index 4266b7122..c3d2024a0 100644 --- a/classes/class_collisionobject2d.rst +++ b/classes/class_collisionobject2d.rst @@ -23,32 +23,26 @@ Member Functions +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_input_event` **(** :ref:`Object` viewport, :ref:`InputEvent` event, :ref:`int` shape_idx **)** virtual | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_shape` **(** :ref:`Shape2D` shape, :ref:`Transform2D` transform=((1, 0), (0, 1), (0, 0)) **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_shapes` **(** **)** | +| :ref:`int` | :ref:`create_shape_owner` **(** :ref:`Object` owner **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_rid` **(** **)** const | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Shape2D` | :ref:`get_shape` **(** :ref:`int` shape_idx **)** const | +| :ref:`Array` | :ref:`get_shape_owners` **(** **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_shape_count` **(** **)** const | +| void | :ref:`shape_owner_clear_shapes` **(** :ref:`int` owner_id **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`get_shape_transform` **(** :ref:`int` shape_idx **)** const | +| :ref:`Shape2D` | :ref:`shape_owner_get_shape` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`shape_owner_get_shape_count` **(** :ref:`int` owner_id **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`shape_owner_get_transform` **(** :ref:`int` owner_id **)** | ++----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shape_owner_remove_shape` **(** :ref:`int` owner_id, :ref:`int` shape_id **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_pickable` **(** **)** const | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_shape_set_as_trigger` **(** :ref:`int` shape_idx **)** const | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_shape` **(** :ref:`int` shape_idx **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_pickable` **(** :ref:`bool` enabled **)** | +----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shape` **(** :ref:`int` shape_idx, :ref:`Shape` shape **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shape_as_trigger` **(** :ref:`int` shape_idx, :ref:`bool` enable **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shape_transform` **(** :ref:`int` shape_idx, :ref:`Transform2D` transform **)** | -+----------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -78,17 +72,11 @@ Member Function Description - void **_input_event** **(** :ref:`Object` viewport, :ref:`InputEvent` event, :ref:`int` shape_idx **)** virtual -.. _class_CollisionObject2D_add_shape: +.. _class_CollisionObject2D_create_shape_owner: -- void **add_shape** **(** :ref:`Shape2D` shape, :ref:`Transform2D` transform=((1, 0), (0, 1), (0, 0)) **)** +- :ref:`int` **create_shape_owner** **(** :ref:`Object` owner **)** -Add a :ref:`Shape2D` to the collision body, with a given custom transform. - -.. _class_CollisionObject2D_clear_shapes: - -- void **clear_shapes** **(** **)** - -Remove all shapes. +Creates new holder for the shapes. Argument is a :ref:`CollisionShape2D` node. It will return owner_id which usually you will want to save for later use. .. _class_CollisionObject2D_get_rid: @@ -96,23 +84,41 @@ Remove all shapes. Return the RID of this object. -.. _class_CollisionObject2D_get_shape: +.. _class_CollisionObject2D_get_shape_owners: -- :ref:`Shape2D` **get_shape** **(** :ref:`int` shape_idx **)** const +- :ref:`Array` **get_shape_owners** **(** **)** -Return the shape in the given index. +Shape owner is a node which is holding concrete shape resources. This method will return an array which is holding an integer numbers that are representing unique ID of each owner. You can use those ids when you are using others shape_owner methods. -.. _class_CollisionObject2D_get_shape_count: +.. _class_CollisionObject2D_shape_owner_clear_shapes: -- :ref:`int` **get_shape_count** **(** **)** const +- void **shape_owner_clear_shapes** **(** :ref:`int` owner_id **)** -Return the amount of shapes in the collision body. Because a :ref:`CollisionPolygon2D` can generate more than one :ref:`Shape2D`, the amount returned does not have to match the sum of :ref:`CollisionShape2D` and :ref:`CollisionPolygon2D`. +Will remove all the shapes associated with given owner. -.. _class_CollisionObject2D_get_shape_transform: +.. _class_CollisionObject2D_shape_owner_get_shape: -- :ref:`Transform2D` **get_shape_transform** **(** :ref:`int` shape_idx **)** const +- :ref:`Shape2D` **shape_owner_get_shape** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** -Return the shape transform in the given index. +Will return a :ref:`Shape2D`. First argument owner_id is an integer that can be obtained from :ref:`get_shape_owners`. Shape_id is a position of the shape inside owner; it's a value in range from 0 to :ref:`shape_owner_get_shape_count`. + +.. _class_CollisionObject2D_shape_owner_get_shape_count: + +- :ref:`int` **shape_owner_get_shape_count** **(** :ref:`int` owner_id **)** + +Returns number of shapes to which given owner is associated to. + +.. _class_CollisionObject2D_shape_owner_get_transform: + +- :ref:`Transform2D` **shape_owner_get_transform** **(** :ref:`int` owner_id **)** + +Will return :ref:`Transform2D` of an owner node. + +.. _class_CollisionObject2D_shape_owner_remove_shape: + +- void **shape_owner_remove_shape** **(** :ref:`int` owner_id, :ref:`int` shape_id **)** + +Removes related shape from the owner. .. _class_CollisionObject2D_is_pickable: @@ -120,40 +126,10 @@ Return the shape transform in the given index. Return whether this object is pickable. -.. _class_CollisionObject2D_is_shape_set_as_trigger: - -- :ref:`bool` **is_shape_set_as_trigger** **(** :ref:`int` shape_idx **)** const - -Return whether a shape is a trigger. A trigger shape detects collisions, but is otherwise unaffected by physics (i.e. colliding objects will not get blocked). - -.. _class_CollisionObject2D_remove_shape: - -- void **remove_shape** **(** :ref:`int` shape_idx **)** - -Remove the shape in the given index. - .. _class_CollisionObject2D_set_pickable: - void **set_pickable** **(** :ref:`bool` enabled **)** Set whether this object is pickable. A pickable object can detect the mouse pointer enter/leave it and, if the mouse is inside it, report input events. -.. _class_CollisionObject2D_set_shape: - -- void **set_shape** **(** :ref:`int` shape_idx, :ref:`Shape` shape **)** - -Change a shape in the collision body. - -.. _class_CollisionObject2D_set_shape_as_trigger: - -- void **set_shape_as_trigger** **(** :ref:`int` shape_idx, :ref:`bool` enable **)** - -Set whether a shape is a trigger. A trigger shape detects collisions, but is otherwise unaffected by physics (i.e. colliding objects will not get blocked). - -.. _class_CollisionObject2D_set_shape_transform: - -- void **set_shape_transform** **(** :ref:`int` shape_idx, :ref:`Transform2D` transform **)** - -Change the shape transform in the collision body. - diff --git a/classes/class_collisionpolygon.rst b/classes/class_collisionpolygon.rst index 6a244466f..def937f27 100644 --- a/classes/class_collisionpolygon.rst +++ b/classes/class_collisionpolygon.rst @@ -18,47 +18,30 @@ Brief Description Member Functions ---------------- -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_build_mode` **(** **)** const | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_object_first_shape` **(** **)** const | -+--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_object_last_shape` **(** **)** const | +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_depth` **(** **)** const | +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolVector2Array` | :ref:`get_polygon` **(** **)** const | +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_build_mode` **(** :ref:`int` build_mode **)** | +| :ref:`bool` | :ref:`is_disabled` **(** **)** const | +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_depth` **(** :ref:`float` depth **)** | +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_disabled` **(** :ref:`bool` disabled **)** | ++--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_polygon` **(** :ref:`PoolVector2Array` polygon **)** | +--------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- -- :ref:`int` **build_mode** - :ref:`float` **depth** +- :ref:`bool` **disabled** - :ref:`PoolVector2Array` **polygon** -- :ref:`Vector2` **shape_range** Member Function Description --------------------------- -.. _class_CollisionPolygon_get_build_mode: - -- :ref:`int` **get_build_mode** **(** **)** const - -.. _class_CollisionPolygon_get_collision_object_first_shape: - -- :ref:`int` **get_collision_object_first_shape** **(** **)** const - -.. _class_CollisionPolygon_get_collision_object_last_shape: - -- :ref:`int` **get_collision_object_last_shape** **(** **)** const - .. _class_CollisionPolygon_get_depth: - :ref:`float` **get_depth** **(** **)** const @@ -67,14 +50,18 @@ Member Function Description - :ref:`PoolVector2Array` **get_polygon** **(** **)** const -.. _class_CollisionPolygon_set_build_mode: +.. _class_CollisionPolygon_is_disabled: -- void **set_build_mode** **(** :ref:`int` build_mode **)** +- :ref:`bool` **is_disabled** **(** **)** const .. _class_CollisionPolygon_set_depth: - void **set_depth** **(** :ref:`float` depth **)** +.. _class_CollisionPolygon_set_disabled: + +- void **set_disabled** **(** :ref:`bool` disabled **)** + .. _class_CollisionPolygon_set_polygon: - void **set_polygon** **(** :ref:`PoolVector2Array` polygon **)** diff --git a/classes/class_collisionpolygon2d.rst b/classes/class_collisionpolygon2d.rst index a07230914..415a5bdf3 100644 --- a/classes/class_collisionpolygon2d.rst +++ b/classes/class_collisionpolygon2d.rst @@ -21,28 +21,28 @@ Member Functions +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_build_mode` **(** **)** const | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_object_first_shape` **(** **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_object_last_shape` **(** **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolVector2Array` | :ref:`get_polygon` **(** **)** const | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_trigger` **(** **)** const | +| :ref:`bool` | :ref:`is_disabled` **(** **)** const | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_one_way_collision_enabled` **(** **)** const | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_build_mode` **(** :ref:`int` build_mode **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_polygon` **(** :ref:`PoolVector2Array` polygon **)** | +| void | :ref:`set_disabled` **(** :ref:`bool` disabled **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_trigger` **(** :ref:`bool` trigger **)** | +| void | :ref:`set_one_way_collision` **(** :ref:`bool` enabled **)** | ++--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_polygon` **(** :ref:`PoolVector2Array` polygon **)** | +--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- - :ref:`int` **build_mode** +- :ref:`bool` **disabled** +- :ref:`bool` **one_way_collision** - :ref:`PoolVector2Array` **polygon** -- :ref:`Vector2` **shape_range** -- :ref:`bool` **trigger** Description ----------- @@ -58,33 +58,19 @@ Member Function Description Return whether the polygon is a :ref:`ConvexPolygonShape2D` (``build_mode==0``), or a :ref:`ConcavePolygonShape2D` (``build_mode==1``). -.. _class_CollisionPolygon2D_get_collision_object_first_shape: - -- :ref:`int` **get_collision_object_first_shape** **(** **)** const - -Return the index of the first shape generated by the editor. - -When ``build_mode`` is set to generate convex polygons, the shape shown in the editor may be decomposed into many convex polygons. In that case, a range of indexes is needed to directly access the :ref:`Shape2D`. - -When ``build_mode`` is set to generate concave polygons, there is only one :ref:`Shape2D` generated, so the start index and the end index are the same. - -.. _class_CollisionPolygon2D_get_collision_object_last_shape: - -- :ref:`int` **get_collision_object_last_shape** **(** **)** const - -Return the index of the last shape generated by the editor. - .. _class_CollisionPolygon2D_get_polygon: - :ref:`PoolVector2Array` **get_polygon** **(** **)** const Return the list of points that define the polygon. -.. _class_CollisionPolygon2D_is_trigger: +.. _class_CollisionPolygon2D_is_disabled: -- :ref:`bool` **is_trigger** **(** **)** const +- :ref:`bool` **is_disabled** **(** **)** const -Return whether this polygon is a trigger. +.. _class_CollisionPolygon2D_is_one_way_collision_enabled: + +- :ref:`bool` **is_one_way_collision_enabled** **(** **)** const .. _class_CollisionPolygon2D_set_build_mode: @@ -92,6 +78,14 @@ Return whether this polygon is a trigger. Set whether the polygon is to be a :ref:`ConvexPolygonShape2D` (``build_mode==0``), or a :ref:`ConcavePolygonShape2D` (``build_mode==1``). +.. _class_CollisionPolygon2D_set_disabled: + +- void **set_disabled** **(** :ref:`bool` disabled **)** + +.. _class_CollisionPolygon2D_set_one_way_collision: + +- void **set_one_way_collision** **(** :ref:`bool` enabled **)** + .. _class_CollisionPolygon2D_set_polygon: - void **set_polygon** **(** :ref:`PoolVector2Array` polygon **)** @@ -100,10 +94,4 @@ Set the array of points forming the polygon. When editing the point list via the editor, depending on :ref:`get_build_mode`, it has to be a list of points (for ``build_mode==0``), or a list of lines (for ``build_mode==1``). In the second case, the even elements of the array define the start point of the line, and the odd elements the end point. -.. _class_CollisionPolygon2D_set_trigger: - -- void **set_trigger** **(** :ref:`bool` trigger **)** - -Set whether this polygon is a trigger. A trigger polygon detects collisions, but is otherwise unaffected by physics (i.e. colliding objects will not get blocked). - diff --git a/classes/class_collisionshape.rst b/classes/class_collisionshape.rst index 7548cb07d..068f0c53e 100644 --- a/classes/class_collisionshape.rst +++ b/classes/class_collisionshape.rst @@ -18,43 +18,36 @@ Brief Description Member Functions ---------------- -+------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_object_shape_index` **(** **)** const | +------------------------------+-------------------------------------------------------------------------------------------------------------------+ | :ref:`Object` | :ref:`get_shape` **(** **)** const | +------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_trigger` **(** **)** const | +| :ref:`bool` | :ref:`is_disabled` **(** **)** const | +------------------------------+-------------------------------------------------------------------------------------------------------------------+ | void | :ref:`make_convex_from_brothers` **(** **)** | +------------------------------+-------------------------------------------------------------------------------------------------------------------+ | void | :ref:`resource_changed` **(** :ref:`Object` resource **)** | +------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shape` **(** :ref:`Object` shape **)** | +| void | :ref:`set_disabled` **(** :ref:`bool` enable **)** | +------------------------------+-------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_trigger` **(** :ref:`bool` enable **)** | +| void | :ref:`set_shape` **(** :ref:`Object` shape **)** | +------------------------------+-------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- -- :ref:`int` **_update_shape_index** +- :ref:`bool` **disabled** - :ref:`Shape` **shape** -- :ref:`bool` **trigger** Member Function Description --------------------------- -.. _class_CollisionShape_get_collision_object_shape_index: - -- :ref:`int` **get_collision_object_shape_index** **(** **)** const - .. _class_CollisionShape_get_shape: - :ref:`Object` **get_shape** **(** **)** const -.. _class_CollisionShape_is_trigger: +.. _class_CollisionShape_is_disabled: -- :ref:`bool` **is_trigger** **(** **)** const +- :ref:`bool` **is_disabled** **(** **)** const .. _class_CollisionShape_make_convex_from_brothers: @@ -64,12 +57,12 @@ Member Function Description - void **resource_changed** **(** :ref:`Object` resource **)** +.. _class_CollisionShape_set_disabled: + +- void **set_disabled** **(** :ref:`bool` enable **)** + .. _class_CollisionShape_set_shape: - void **set_shape** **(** :ref:`Object` shape **)** -.. _class_CollisionShape_set_trigger: - -- void **set_trigger** **(** :ref:`bool` enable **)** - diff --git a/classes/class_collisionshape2d.rst b/classes/class_collisionshape2d.rst index 42b409365..189b34435 100644 --- a/classes/class_collisionshape2d.rst +++ b/classes/class_collisionshape2d.rst @@ -18,24 +18,26 @@ Editor-only class for easy editing of shapes. Member Functions ---------------- -+------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_object_shape_index` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_shape` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_trigger` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shape` **(** :ref:`Object` shape **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_trigger` **(** :ref:`bool` enable **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------+ ++------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_shape` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_disabled` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_one_way_collision_enabled` **(** **)** const | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_disabled` **(** :ref:`bool` disabled **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_one_way_collision` **(** :ref:`bool` enabled **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shape` **(** :ref:`Object` shape **)** | ++------------------------------+--------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- -- :ref:`int` **_update_shape_index** +- :ref:`bool` **disabled** +- :ref:`bool` **one_way_collision** - :ref:`Shape2D` **shape** -- :ref:`bool` **trigger** Description ----------- @@ -45,23 +47,27 @@ Editor-only class. This is not present when running the game. It's used in the e Member Function Description --------------------------- -.. _class_CollisionShape2D_get_collision_object_shape_index: - -- :ref:`int` **get_collision_object_shape_index** **(** **)** const - -Return the index of this shape inside its container :ref:`CollisionObject2D`. This can be used to directly access the underlying :ref:`Shape2D`. - .. _class_CollisionShape2D_get_shape: - :ref:`Object` **get_shape** **(** **)** const Return this shape's :ref:`Shape2D`. -.. _class_CollisionShape2D_is_trigger: +.. _class_CollisionShape2D_is_disabled: -- :ref:`bool` **is_trigger** **(** **)** const +- :ref:`bool` **is_disabled** **(** **)** const -Return whether this shape is a trigger. +.. _class_CollisionShape2D_is_one_way_collision_enabled: + +- :ref:`bool` **is_one_way_collision_enabled** **(** **)** const + +.. _class_CollisionShape2D_set_disabled: + +- void **set_disabled** **(** :ref:`bool` disabled **)** + +.. _class_CollisionShape2D_set_one_way_collision: + +- void **set_one_way_collision** **(** :ref:`bool` enabled **)** .. _class_CollisionShape2D_set_shape: @@ -69,10 +75,4 @@ Return whether this shape is a trigger. Set this shape's :ref:`Shape2D`. This will not appear as a node, but can be directly edited as a property. -.. _class_CollisionShape2D_set_trigger: - -- void **set_trigger** **(** :ref:`bool` enable **)** - -Set whether this shape is a trigger. A trigger shape detects collisions, but is otherwise unaffected by physics (i.e. will not block movement of colliding objects). - diff --git a/classes/class_control.rst b/classes/class_control.rst index 2842dfcfb..a0b26447f 100644 --- a/classes/class_control.rst +++ b/classes/class_control.rst @@ -77,6 +77,8 @@ Member Functions +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`get_global_rect` **(** **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_h_grow_direction` **(** **)** const | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_h_size_flags` **(** **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture` | :ref:`get_icon` **(** :ref:`String` name, :ref:`String` type="" **)** const | @@ -91,6 +93,8 @@ Member Functions +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Control` | :ref:`get_parent_control` **(** **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_pivot_offset` **(** **)** const | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`get_position` **(** **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`get_rect` **(** **)** const | @@ -111,6 +115,8 @@ Member Functions +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_tooltip` **(** :ref:`Vector2` atpos=Vector2(0, 0) **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_v_grow_direction` **(** **)** const | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_v_size_flags` **(** **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`grab_click_focus` **(** **)** | @@ -173,12 +179,16 @@ Member Functions +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_global_position` **(** :ref:`Vector2` pos **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_h_grow_direction` **(** :ref:`int` direction **)** | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_h_size_flags` **(** :ref:`int` flags **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_margin` **(** :ref:`int` margin, :ref:`float` offset **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_mouse_filter` **(** :ref:`int` filter **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pivot_offset` **(** :ref:`Vector2` pivot_offset **)** | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_position` **(** :ref:`Vector2` pos **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_rotation` **(** :ref:`float` radians **)** | @@ -195,6 +205,8 @@ Member Functions +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_tooltip` **(** :ref:`String` tooltip **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_v_grow_direction` **(** :ref:`int` direction **)** | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_v_size_flags` **(** :ref:`int` flags **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`show_modal` **(** :ref:`bool` exclusive=false **)** | @@ -240,6 +252,8 @@ Member Variables - :ref:`NodePath` **focus_neighbour_left** - :ref:`NodePath` **focus_neighbour_right** - :ref:`NodePath` **focus_neighbour_top** +- :ref:`int` **grow_horizontal** +- :ref:`int` **grow_vertical** - :ref:`String` **hint_tooltip** - :ref:`int` **margin_bottom** - :ref:`int` **margin_left** @@ -248,6 +262,7 @@ Member Variables - :ref:`int` **mouse_filter** - :ref:`bool` **rect_clip_content** - :ref:`Vector2` **rect_min_size** +- :ref:`Vector2` **rect_pivot_offset** - :ref:`Vector2` **rect_position** - :ref:`float` **rect_rotation** - :ref:`Vector2` **rect_scale** @@ -293,9 +308,13 @@ Numeric Constants - **SIZE_EXPAND** = **2** - **SIZE_FILL** = **1** - **SIZE_EXPAND_FILL** = **3** +- **SIZE_SHRINK_CENTER** = **4** +- **SIZE_SHRINK_END** = **8** - **MOUSE_FILTER_STOP** = **0** - **MOUSE_FILTER_PASS** = **1** - **MOUSE_FILTER_IGNORE** = **2** +- **GROW_DIRECTION_BEGIN** = **0** +- **GROW_DIRECTION_END** = **1** Description ----------- @@ -363,7 +382,7 @@ Override a single icon (:ref:`Texture`) in the theme of this Cont - void **add_style_override** **(** :ref:`String` name, :ref:`StyleBox` stylebox **)** -Override a single stylebox (:ref:`Stylebox`) in the theme of this Control. If stylebox is empty, override is cleared. +Override a single stylebox (Stylebox) in the theme of this Control. If stylebox is empty, override is cleared. .. _class_Control_can_drop_data: @@ -457,7 +476,11 @@ Returns the Control position, relative to the top-left corner of the parent Cont - :ref:`Rect2` **get_global_rect** **(** **)** const -Return position and size of the Control, relative to the top-left corner of the *window* Control. This is a helper (see :ref:`get_global_pos`, :ref:`get_size`). +Return position and size of the Control, relative to the top-left corner of the *window* Control. This is a helper (see :ref:`get_global_position`, :ref:`get_size`). + +.. _class_Control_get_h_grow_direction: + +- :ref:`int` **get_h_grow_direction** **(** **)** const .. _class_Control_get_h_size_flags: @@ -495,6 +518,10 @@ Return when the control is ignoring mouse events (even touchpad events send mous - :ref:`Control` **get_parent_control** **(** **)** const +.. _class_Control_get_pivot_offset: + +- :ref:`Vector2` **get_pivot_offset** **(** **)** const + .. _class_Control_get_position: - :ref:`Vector2` **get_position** **(** **)** const @@ -505,7 +532,7 @@ Returns the Control position, relative to the top-left corner of the parent Cont - :ref:`Rect2` **get_rect** **(** **)** const -Return position and size of the Control, relative to the top-left corner of the parent Control. This is a helper (see :ref:`get_pos`, :ref:`get_size`). +Return position and size of the Control, relative to the top-left corner of the parent Control. This is a helper (see :ref:`get_position`, :ref:`get_size`). .. _class_Control_get_rotation: @@ -527,7 +554,7 @@ Return the rotation (in degrees) - :ref:`Vector2` **get_size** **(** **)** const -Returns the size of the Control, computed from all margins, however the size returned will **never be smaller than the minimum size reported by :ref:`get_minimum_size`**. This means that even if end position of the Control rectangle is smaller than the begin position, the Control will still display and interact correctly. (see description, :ref:`get_minimum_size`, :ref:`set_margin`, :ref:`set_anchor`). +Returns the size of the Control, computed from all margins, however the size returned will **never be smaller than the minimum size reported by** :ref:`get_minimum_size`. This means that even if end position of the Control rectangle is smaller than the begin position, the Control will still display and interact correctly. (see description, :ref:`get_minimum_size`, :ref:`set_margin`, :ref:`set_anchor`). .. _class_Control_get_stretch_ratio: @@ -551,6 +578,10 @@ Return a :ref:`Theme` override, if one exists (see :ref:`set_theme< Return the tooltip, which will appear when the cursor is resting over this control. +.. _class_Control_get_v_grow_direction: + +- :ref:`int` **get_v_grow_direction** **(** **)** const + .. _class_Control_get_v_size_flags: - :ref:`int` **get_v_size_flags** **(** **)** const @@ -703,6 +734,10 @@ Force a neighbour for moving the input focus to. When pressing TAB or directiona Move the Control to a new position, relative to the top-left corner of the *window* Control, and without changing current anchor mode. (see :ref:`set_margin`). +.. _class_Control_set_h_grow_direction: + +- void **set_h_grow_direction** **(** :ref:`int` direction **)** + .. _class_Control_set_h_size_flags: - void **set_h_size_flags** **(** :ref:`int` flags **)** @@ -721,6 +756,10 @@ Set a margin offset. Margin can be one of (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT Set when the control is ignoring mouse events (even touchpad events send mouse events). (see the MOUSE_FILTER\_\* constants) +.. _class_Control_set_pivot_offset: + +- void **set_pivot_offset** **(** :ref:`Vector2` pivot_offset **)** + .. _class_Control_set_position: - void **set_position** **(** :ref:`Vector2` pos **)** @@ -767,6 +806,10 @@ Override whole the :ref:`Theme` for this Control and all its childr Set a tooltip, which will appear when the cursor is resting over this control. +.. _class_Control_set_v_grow_direction: + +- void **set_v_grow_direction** **(** :ref:`int` direction **)** + .. _class_Control_set_v_size_flags: - void **set_v_size_flags** **(** :ref:`int` flags **)** diff --git a/classes/class_curve.rst b/classes/class_curve.rst new file mode 100644 index 000000000..926d91039 --- /dev/null +++ b/classes/class_curve.rst @@ -0,0 +1,183 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. + +.. _class_Curve: + +Curve +===== + +**Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`add_point` **(** :ref:`Vector2` pos, :ref:`float` left_tangent=0, :ref:`float` right_tangent=0, :ref:`int` left_mode=0, :ref:`int` right_mode=0 **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`bake` **(** **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clean_dupes` **(** **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_points` **(** **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_bake_resolution` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_max_value` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_min_value` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_point_left_mode` **(** :ref:`int` index **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_point_left_tangent` **(** :ref:`int` index **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_point_pos` **(** :ref:`int` index **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_point_right_mode` **(** :ref:`int` index **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_point_right_tangent` **(** :ref:`int` index **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`interpolate` **(** :ref:`float` offset **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`interpolate_baked` **(** :ref:`float` offset **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_point` **(** :ref:`int` index **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bake_resolution` **(** :ref:`int` resolution **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_max_value` **(** :ref:`float` max **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_min_value` **(** :ref:`float` min **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_left_mode` **(** :ref:`int` index, :ref:`int` mode **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_left_tangent` **(** :ref:`int` index, :ref:`float` tangent **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_offset` **(** :ref:`int` index, :ref:`float` offset **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_right_mode` **(** :ref:`int` index, :ref:`int` mode **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_right_tangent` **(** :ref:`int` index, :ref:`float` tangent **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_point_value` **(** :ref:`int` index, :ref:`float` y **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Signals +------- + +- **range_changed** **(** **)** + +Member Variables +---------------- + +- :ref:`int` **_data** +- :ref:`int` **bake_resolution** +- :ref:`float` **max_value** +- :ref:`float` **min_value** + +Member Function Description +--------------------------- + +.. _class_Curve_add_point: + +- :ref:`int` **add_point** **(** :ref:`Vector2` pos, :ref:`float` left_tangent=0, :ref:`float` right_tangent=0, :ref:`int` left_mode=0, :ref:`int` right_mode=0 **)** + +.. _class_Curve_bake: + +- void **bake** **(** **)** + +.. _class_Curve_clean_dupes: + +- void **clean_dupes** **(** **)** + +.. _class_Curve_clear_points: + +- void **clear_points** **(** **)** + +.. _class_Curve_get_bake_resolution: + +- :ref:`int` **get_bake_resolution** **(** **)** const + +.. _class_Curve_get_max_value: + +- :ref:`float` **get_max_value** **(** **)** const + +.. _class_Curve_get_min_value: + +- :ref:`float` **get_min_value** **(** **)** const + +.. _class_Curve_get_point_left_mode: + +- :ref:`int` **get_point_left_mode** **(** :ref:`int` index **)** const + +.. _class_Curve_get_point_left_tangent: + +- :ref:`float` **get_point_left_tangent** **(** :ref:`int` index **)** const + +.. _class_Curve_get_point_pos: + +- :ref:`Vector2` **get_point_pos** **(** :ref:`int` index **)** const + +.. _class_Curve_get_point_right_mode: + +- :ref:`int` **get_point_right_mode** **(** :ref:`int` index **)** const + +.. _class_Curve_get_point_right_tangent: + +- :ref:`float` **get_point_right_tangent** **(** :ref:`int` index **)** const + +.. _class_Curve_interpolate: + +- :ref:`float` **interpolate** **(** :ref:`float` offset **)** const + +.. _class_Curve_interpolate_baked: + +- :ref:`float` **interpolate_baked** **(** :ref:`float` offset **)** + +.. _class_Curve_remove_point: + +- void **remove_point** **(** :ref:`int` index **)** + +.. _class_Curve_set_bake_resolution: + +- void **set_bake_resolution** **(** :ref:`int` resolution **)** + +.. _class_Curve_set_max_value: + +- void **set_max_value** **(** :ref:`float` max **)** + +.. _class_Curve_set_min_value: + +- void **set_min_value** **(** :ref:`float` min **)** + +.. _class_Curve_set_point_left_mode: + +- void **set_point_left_mode** **(** :ref:`int` index, :ref:`int` mode **)** + +.. _class_Curve_set_point_left_tangent: + +- void **set_point_left_tangent** **(** :ref:`int` index, :ref:`float` tangent **)** + +.. _class_Curve_set_point_offset: + +- void **set_point_offset** **(** :ref:`int` index, :ref:`float` offset **)** + +.. _class_Curve_set_point_right_mode: + +- void **set_point_right_mode** **(** :ref:`int` index, :ref:`int` mode **)** + +.. _class_Curve_set_point_right_tangent: + +- void **set_point_right_tangent** **(** :ref:`int` index, :ref:`float` tangent **)** + +.. _class_Curve_set_point_value: + +- void **set_point_value** **(** :ref:`int` index, :ref:`float` y **)** + + diff --git a/classes/class_curve3d.rst b/classes/class_curve3d.rst index 032ac392f..dfbd0f4df 100644 --- a/classes/class_curve3d.rst +++ b/classes/class_curve3d.rst @@ -112,7 +112,7 @@ Returns the cache of points as a :ref:`PoolVector3Array` - :ref:`PoolRealArray` **get_baked_tilts** **(** **)** const -Returns the cache of tilts as a :ref:`RealArray`. +Returns the cache of tilts as a RealArray. .. _class_Curve3D_get_point_count: diff --git a/classes/class_curvetexture.rst b/classes/class_curvetexture.rst index 268b17daf..07ad7f7c4 100644 --- a/classes/class_curvetexture.rst +++ b/classes/class_curvetexture.rst @@ -18,56 +18,30 @@ Brief Description Member Functions ---------------- -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_max` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_min` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_points` **(** **)** const | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_max` **(** :ref:`float` max **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_min` **(** :ref:`float` min **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_points` **(** :ref:`PoolVector2Array` points **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_width` **(** :ref:`int` width **)** | -+--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+ ++----------------------------+----------------------------------------------------------------------------------------------+ +| :ref:`Curve` | :ref:`get_curve` **(** **)** const | ++----------------------------+----------------------------------------------------------------------------------------------+ +| void | :ref:`set_curve` **(** :ref:`Curve` curve **)** | ++----------------------------+----------------------------------------------------------------------------------------------+ +| void | :ref:`set_width` **(** :ref:`int` width **)** | ++----------------------------+----------------------------------------------------------------------------------------------+ Member Variables ---------------- -- :ref:`float` **max** -- :ref:`float` **min** -- :ref:`PoolVector2Array` **points** +- :ref:`Curve` **curve** - :ref:`int` **width** Member Function Description --------------------------- -.. _class_CurveTexture_get_max: +.. _class_CurveTexture_get_curve: -- :ref:`float` **get_max** **(** **)** const +- :ref:`Curve` **get_curve** **(** **)** const -.. _class_CurveTexture_get_min: +.. _class_CurveTexture_set_curve: -- :ref:`float` **get_min** **(** **)** const - -.. _class_CurveTexture_get_points: - -- :ref:`PoolVector2Array` **get_points** **(** **)** const - -.. _class_CurveTexture_set_max: - -- void **set_max** **(** :ref:`float` max **)** - -.. _class_CurveTexture_set_min: - -- void **set_min** **(** :ref:`float` min **)** - -.. _class_CurveTexture_set_points: - -- void **set_points** **(** :ref:`PoolVector2Array` points **)** +- void **set_curve** **(** :ref:`Curve` curve **)** .. _class_CurveTexture_set_width: diff --git a/classes/class_editorplugin.rst b/classes/class_editorplugin.rst index bb5b9a259..6c2193302 100644 --- a/classes/class_editorplugin.rst +++ b/classes/class_editorplugin.rst @@ -53,14 +53,20 @@ Member Functions +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`EditorSettings` | :ref:`get_editor_settings` **(** **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_edited_scene_root` **(** **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Control` | :ref:`get_editor_viewport` **(** **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_name` **(** **)** virtual | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_open_scenes` **(** **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`EditorFileSystem` | :ref:`get_resource_filesystem` **(** **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`EditorResourcePreview` | :ref:`get_resource_previewer` **(** **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ScriptEditor` | :ref:`get_script_editor` **(** **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`EditorSelection` | :ref:`get_selection` **(** **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`get_state` **(** **)** virtual | @@ -81,8 +87,12 @@ Member Functions +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`make_visible` **(** :ref:`bool` visible **)** virtual | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`open_scene_from_path` **(** :ref:`String` scene_filepath **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`queue_save_layout` **(** **)** const | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reload_scene_from_path` **(** :ref:`String` scene_filepath **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_control_from_bottom_panel` **(** :ref:`Control` control **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_control_from_docks` **(** :ref:`Control` control **)** | @@ -93,6 +103,8 @@ Member Functions +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`save_external_data` **(** **)** virtual | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_input_event_forwarding_always_enabled` **(** **)** | ++------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_state` **(** :ref:`Dictionary` state **)** virtual | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_window_layout` **(** :ref:`ConfigFile` layout **)** virtual | @@ -100,6 +112,19 @@ Member Functions | void | :ref:`update_canvas` **(** **)** | +------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +Signals +------- + +- **main_screen_changed** **(** :ref:`String` screen_name **)** +Emitted when user change main screen view (2D, 3D, Script, AssetLib). Works also with screens which are defined by plugins. + +- **scene_changed** **(** :ref:`Node` scene_root **)** +Emitted when user change scene. The argument is a root node of freshly opened scene. + +- **scene_closed** **(** :ref:`String` filepath **)** +Emitted when user close scene. The argument is file path to a closed scene. + + Numeric Constants ----------------- @@ -218,6 +243,10 @@ This function is called every time the 2D canvas editor draws (which overlays ov - :ref:`bool` **forward_spatial_gui_input** **(** :ref:`Camera` camera, :ref:`InputEvent` event **)** virtual +Implement this function if you are interested in 3D view screen input events. It will be called only if currently selected node is handled by your plugin. + +If you would like to always gets those input events then additionally use :ref:`set_input_forwarding_always_enabled`. + .. _class_EditorPlugin_get_base_control: - :ref:`Control` **get_base_control** **(** **)** @@ -236,6 +265,12 @@ This is for editors that edit script based objects. You can return a list of bre Get the general settings for the editor (the same window that appears in the Settings menu). +.. _class_EditorPlugin_get_edited_scene_root: + +- :ref:`Node` **get_edited_scene_root** **(** **)** + +Returns root node of currently edited scene. + .. _class_EditorPlugin_get_editor_viewport: - :ref:`Control` **get_editor_viewport** **(** **)** @@ -248,6 +283,12 @@ Get the main editor control. Use this as a parent for main screens. Get the name of the editor plugin. For main scren plugins this is what will appear in the selector (which by default is 2D, 3D, Script). +.. _class_EditorPlugin_get_open_scenes: + +- :ref:`Array` **get_open_scenes** **(** **)** + +Will return an Array of Strings which represent file paths to currently open scenes. + .. _class_EditorPlugin_get_resource_filesystem: - :ref:`EditorFileSystem` **get_resource_filesystem** **(** **)** @@ -260,6 +301,12 @@ Get the filesystem cache for all resources in the project. Get tool for generating resource previews. +.. _class_EditorPlugin_get_script_editor: + +- :ref:`ScriptEditor` **get_script_editor** **(** **)** + +Will return ScriptEditor object which contains informations about state of the scripts which are currently open by the editor. + .. _class_EditorPlugin_get_selection: - :ref:`EditorSelection` **get_selection** **(** **)** @@ -318,12 +365,24 @@ This function will be called when the editor is requested to become visible. It Remember that you have to manage the visibility of all your editor controls manually. +.. _class_EditorPlugin_open_scene_from_path: + +- void **open_scene_from_path** **(** :ref:`String` scene_filepath **)** + +Opens scene in editor. Do not use during plugin initialization. If you need, then use it together with :ref:`Object.call_deferred`. + .. _class_EditorPlugin_queue_save_layout: - void **queue_save_layout** **(** **)** const Queue save the project's editor layout. +.. _class_EditorPlugin_reload_scene_from_path: + +- void **reload_scene_from_path** **(** :ref:`String` scene_filepath **)** + +Reloads already loaded editor scene. + .. _class_EditorPlugin_remove_control_from_bottom_panel: - void **remove_control_from_bottom_panel** **(** :ref:`Control` control **)** @@ -352,6 +411,12 @@ Remove a custom type added by :ref:`EditorPlugin.add_custom_type`. It might be especially usable if your plugin will want to use raycast in the scene. + .. _class_EditorPlugin_set_state: - void **set_state** **(** :ref:`Dictionary` state **)** virtual @@ -369,3 +434,5 @@ Restore the plugin GUI layout saved by :ref:`EditorPlugin.get_window_layout`. + + diff --git a/classes/class_environment.rst b/classes/class_environment.rst index f60ea329c..b0996655b 100644 --- a/classes/class_environment.rst +++ b/classes/class_environment.rst @@ -81,7 +81,7 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_glow_hdr_bleed_scale` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_glow_hdr_bleed_treshold` **(** **)** const | +| :ref:`float` | :ref:`get_glow_hdr_bleed_threshold` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_glow_intensity` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -237,7 +237,7 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_glow_hdr_bleed_scale` **(** :ref:`float` scale **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_glow_hdr_bleed_treshold` **(** :ref:`float` treshold **)** | +| void | :ref:`set_glow_hdr_bleed_threshold` **(** :ref:`float` threshold **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_glow_intensity` **(** :ref:`float` intensity **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -245,7 +245,7 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_glow_strength` **(** :ref:`float` strength **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_sky` **(** :ref:`CubeMap` sky **)** | +| void | :ref:`set_sky` **(** :ref:`Sky` sky **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_sky_scale` **(** :ref:`float` scale **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -346,7 +346,7 @@ Member Variables - :ref:`float` **glow_bloom** - :ref:`bool` **glow_enabled** - :ref:`float` **glow_hdr_scale** -- :ref:`float` **glow_hdr_treshold** +- :ref:`float` **glow_hdr_threshold** - :ref:`float` **glow_intensity** - :ref:`bool` **glow_levels/1** - :ref:`bool` **glow_levels/2** @@ -523,9 +523,9 @@ Member Function Description - :ref:`float` **get_glow_hdr_bleed_scale** **(** **)** const -.. _class_Environment_get_glow_hdr_bleed_treshold: +.. _class_Environment_get_glow_hdr_bleed_threshold: -- :ref:`float` **get_glow_hdr_bleed_treshold** **(** **)** const +- :ref:`float` **get_glow_hdr_bleed_threshold** **(** **)** const .. _class_Environment_get_glow_intensity: @@ -835,9 +835,9 @@ Member Function Description - void **set_glow_hdr_bleed_scale** **(** :ref:`float` scale **)** -.. _class_Environment_set_glow_hdr_bleed_treshold: +.. _class_Environment_set_glow_hdr_bleed_threshold: -- void **set_glow_hdr_bleed_treshold** **(** :ref:`float` treshold **)** +- void **set_glow_hdr_bleed_threshold** **(** :ref:`float` threshold **)** .. _class_Environment_set_glow_intensity: @@ -853,7 +853,7 @@ Member Function Description .. _class_Environment_set_sky: -- void **set_sky** **(** :ref:`CubeMap` sky **)** +- void **set_sky** **(** :ref:`Sky` sky **)** .. _class_Environment_set_sky_scale: diff --git a/classes/class_file.rst b/classes/class_file.rst index 1bfbd3f72..5ad682e4f 100644 --- a/classes/class_file.rst +++ b/classes/class_file.rst @@ -69,6 +69,8 @@ Member Functions +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`open` **(** :ref:`String` path, :ref:`int` flags **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`open_compressed` **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`int` compression_mode=0 **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`open_encrypted` **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`PoolByteArray` key **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`open_encrypted_with_pass` **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`String` pass **)** | @@ -111,6 +113,10 @@ Numeric Constants - **WRITE** = **2** --- Open the file for writing. Create it if the file not exists and truncate if it exists. - **READ_WRITE** = **3** --- Open the file for reading and writing, without truncating the file. - **WRITE_READ** = **7** --- Open the file for reading and writing. Create it if the file not exists and truncate if it exists. +- **COMPRESSION_FASTLZ** = **0** --- Use the FastLZ compression method. +- **COMPRESSION_DEFLATE** = **1** --- Use the Deflate compression method. +- **COMPRESSION_ZSTD** = **2** --- Use the Zstd compression method. +- **COMPRESSION_GZIP** = **3** Description ----------- @@ -285,6 +291,12 @@ Return whether the file is currently opened. Open the file for writing or reading, depending on the flags. +.. _class_File_open_compressed: + +- :ref:`int` **open_compressed** **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`int` compression_mode=0 **)** + +Open a compressed file for reading or writing. The compression_mode can be set as one of the COMPRESSION\_\* constants. + .. _class_File_open_encrypted: - :ref:`int` **open_encrypted** **(** :ref:`String` path, :ref:`int` mode_flags, :ref:`PoolByteArray` key **)** diff --git a/classes/class_filedialog.rst b/classes/class_filedialog.rst index 820d1eefe..2f469d85b 100644 --- a/classes/class_filedialog.rst +++ b/classes/class_filedialog.rst @@ -165,7 +165,7 @@ Return true if the diaog allows show hidden files. - void **set_access** **(** :ref:`int` access **)** -Set the file access permission of the dialog(Must be one of :ref:`ACCESS_RESOURCES`, :ref:`ACCESS_USERDATA` or :ref:`ACCESS_FILESYSTEM`). +Set the file access permission of the dialog(Must be one of ACCESS_RESOURCES, ACCESS_USERDATA or ACCESS_FILESYSTEM). .. _class_FileDialog_set_current_dir: diff --git a/classes/class_gdfunctionstate.rst b/classes/class_gdfunctionstate.rst index 7a006aec2..fcfb77273 100644 --- a/classes/class_gdfunctionstate.rst +++ b/classes/class_gdfunctionstate.rst @@ -24,6 +24,11 @@ Member Functions | :ref:`Variant` | :ref:`resume` **(** :ref:`Variant` arg=NULL **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------+ +Signals +------- + +- **completed** **(** :ref:`Nil` result **)** + Description ----------- diff --git a/classes/class_geometryinstance.rst b/classes/class_geometryinstance.rst index 2467469ef..ef4e218e4 100644 --- a/classes/class_geometryinstance.rst +++ b/classes/class_geometryinstance.rst @@ -63,7 +63,7 @@ Member Variables - :ref:`int` **lod_max_hysteresis** - :ref:`int` **lod_min_distance** - :ref:`int` **lod_min_hysteresis** -- :ref:`Material` **material_override** +- ShaderMaterial,SpatialMaterial **material_override** - :ref:`bool` **use_in_baked_light** - :ref:`bool` **visible_in_all_rooms** diff --git a/classes/class_giprobe.rst b/classes/class_giprobe.rst index c1201e5e5..12d252cc1 100644 --- a/classes/class_giprobe.rst +++ b/classes/class_giprobe.rst @@ -31,6 +31,8 @@ Member Functions +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_extents` **(** **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_normal_bias` **(** **)** const | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Object` | :ref:`get_probe_data` **(** **)** const | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_propagation` **(** **)** const | @@ -53,6 +55,8 @@ Member Functions +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_interior` **(** :ref:`bool` enable **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_normal_bias` **(** :ref:`float` max **)** | ++--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_probe_data` **(** :ref:`Object` data **)** | +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_propagation` **(** :ref:`float` max **)** | @@ -70,6 +74,7 @@ Member Variables - :ref:`float` **energy** - :ref:`Vector3` **extents** - :ref:`bool` **interior** +- :ref:`float` **normal_bias** - :ref:`float` **propagation** - :ref:`int` **subdiv** @@ -108,6 +113,10 @@ Member Function Description - :ref:`Vector3` **get_extents** **(** **)** const +.. _class_GIProbe_get_normal_bias: + +- :ref:`float` **get_normal_bias** **(** **)** const + .. _class_GIProbe_get_probe_data: - :ref:`Object` **get_probe_data** **(** **)** const @@ -152,6 +161,10 @@ Member Function Description - void **set_interior** **(** :ref:`bool` enable **)** +.. _class_GIProbe_set_normal_bias: + +- void **set_normal_bias** **(** :ref:`float` max **)** + .. _class_GIProbe_set_probe_data: - void **set_probe_data** **(** :ref:`Object` data **)** diff --git a/classes/class_giprobedata.rst b/classes/class_giprobedata.rst index 56cb5380b..e7087094b 100644 --- a/classes/class_giprobedata.rst +++ b/classes/class_giprobedata.rst @@ -31,6 +31,8 @@ Member Functions +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_energy` **(** **)** const | +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_normal_bias` **(** **)** const | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_propagation` **(** **)** const | +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform` | :ref:`get_to_cell_xform` **(** **)** const | @@ -55,6 +57,8 @@ Member Functions +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_interior` **(** :ref:`bool` interior **)** | +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_normal_bias` **(** :ref:`float` bias **)** | ++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_propagation` **(** :ref:`float` propagation **)** | +------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_to_cell_xform` **(** :ref:`Transform` to_cell_xform **)** | @@ -71,6 +75,7 @@ Member Variables - :ref:`int` **dynamic_range** - :ref:`float` **energy** - :ref:`bool` **interior** +- :ref:`float` **normal_bias** - :ref:`float` **propagation** - :ref:`Transform` **to_cell_xform** @@ -101,6 +106,10 @@ Member Function Description - :ref:`float` **get_energy** **(** **)** const +.. _class_GIProbeData_get_normal_bias: + +- :ref:`float` **get_normal_bias** **(** **)** const + .. _class_GIProbeData_get_propagation: - :ref:`float` **get_propagation** **(** **)** const @@ -149,6 +158,10 @@ Member Function Description - void **set_interior** **(** :ref:`bool` interior **)** +.. _class_GIProbeData_set_normal_bias: + +- void **set_normal_bias** **(** :ref:`float` bias **)** + .. _class_GIProbeData_set_propagation: - void **set_propagation** **(** :ref:`float` propagation **)** diff --git a/classes/class_globalconfig.rst b/classes/class_globalconfig.rst deleted file mode 100644 index e25d3b39d..000000000 --- a/classes/class_globalconfig.rst +++ /dev/null @@ -1,150 +0,0 @@ -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. - -.. _class_GlobalConfig: - -GlobalConfig -============ - -**Inherits:** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - -Contains global variables accessible from everywhere. - -Member Functions ----------------- - -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_property_info` **(** :ref:`Dictionary` hint **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** :ref:`String` name **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_order` **(** :ref:`String` name **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_singleton` **(** :ref:`String` name **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`globalize_path` **(** :ref:`String` path **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has` **(** :ref:`String` name **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_singleton` **(** :ref:`String` name **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`load_resource_pack` **(** :ref:`String` pack **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`localize_path` **(** :ref:`String` path **)** const | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`property_can_revert` **(** :ref:`String` name **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`property_get_revert` **(** :ref:`String` name **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`save` **(** **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`save_custom` **(** :ref:`String` file **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_initial_value` **(** :ref:`String` name, :ref:`Variant` value **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_order` **(** :ref:`String` name, :ref:`int` pos **)** | -+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - -Description ------------ - -Contains global variables accessible from everywhere. Use the normal :ref:`Object` API, such as "Globals.get(variable)", "Globals.set(variable,value)" or "Globals.has(variable)" to access them. Variables stored in project.godot are also loaded into globals, making this object very useful for reading custom game configuration options. - -Member Function Description ---------------------------- - -.. _class_GlobalConfig_add_property_info: - -- 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:`@Global Scope`), and optionally hint::ref:`int`(see PROPERTY_HINT\_\* in :ref:`@Global Scope`), hint_string::ref:`String`. - -Example: - -:: - - Globals.set("category/property_name", 0) - - var property_info = { - "name": "category/property_name", - "type": TYPE_INT, - "hint": PROPERTY_HINT_ENUM, - "hint_string": "one,two,three" - } - - Globals.add_property_info(property_info) - -.. _class_GlobalConfig_clear: - -- void **clear** **(** :ref:`String` name **)** - -Clear the whole configuration (not recommended, may break things). - -.. _class_GlobalConfig_get_order: - -- :ref:`int` **get_order** **(** :ref:`String` name **)** const - -Return the order of a configuration value (influences when saved to the config file). - -.. _class_GlobalConfig_get_singleton: - -- :ref:`Object` **get_singleton** **(** :ref:`String` name **)** const - -.. _class_GlobalConfig_globalize_path: - -- :ref:`String` **globalize_path** **(** :ref:`String` path **)** const - -Convert a localized path (res://) to a full native OS path. - -.. _class_GlobalConfig_has: - -- :ref:`bool` **has** **(** :ref:`String` name **)** const - -Return true if a configuration value is present. - -.. _class_GlobalConfig_has_singleton: - -- :ref:`bool` **has_singleton** **(** :ref:`String` name **)** const - -.. _class_GlobalConfig_load_resource_pack: - -- :ref:`bool` **load_resource_pack** **(** :ref:`String` pack **)** - -.. _class_GlobalConfig_localize_path: - -- :ref:`String` **localize_path** **(** :ref:`String` path **)** const - -Convert a path to a localized path (res:// path). - -.. _class_GlobalConfig_property_can_revert: - -- :ref:`bool` **property_can_revert** **(** :ref:`String` name **)** - -.. _class_GlobalConfig_property_get_revert: - -- void **property_get_revert** **(** :ref:`String` name **)** - -.. _class_GlobalConfig_save: - -- :ref:`int` **save** **(** **)** - -.. _class_GlobalConfig_save_custom: - -- :ref:`int` **save_custom** **(** :ref:`String` file **)** - -.. _class_GlobalConfig_set_initial_value: - -- void **set_initial_value** **(** :ref:`String` name, :ref:`Variant` value **)** - -.. _class_GlobalConfig_set_order: - -- void **set_order** **(** :ref:`String` name, :ref:`int` pos **)** - -Set the order of a configuration value (influences when saved to the config file). - - diff --git a/classes/class_gradienttexture.rst b/classes/class_gradienttexture.rst index 2b090c258..10a232efc 100644 --- a/classes/class_gradienttexture.rst +++ b/classes/class_gradienttexture.rst @@ -18,91 +18,30 @@ Brief Description Member Functions ---------------- -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_point` **(** :ref:`float` offset, :ref:`Color` color **)** | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_color` **(** :ref:`int` point **)** const | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolColorArray` | :ref:`get_colors` **(** **)** const | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_offset` **(** :ref:`int` point **)** const | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolRealArray` | :ref:`get_offsets` **(** **)** const | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_point_count` **(** **)** const | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`interpolate` **(** :ref:`float` offset **)** | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_point` **(** :ref:`int` offset **)** | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_color` **(** :ref:`int` point, :ref:`Color` color **)** | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_colors` **(** :ref:`PoolColorArray` colors **)** | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_offset` **(** :ref:`int` point, :ref:`float` offset **)** | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_offsets` **(** :ref:`PoolRealArray` offsets **)** | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_width` **(** :ref:`int` width **)** | -+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------+----------------------------------------------------------------------------------------------------------------+ +| :ref:`Gradient` | :ref:`get_gradient` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_gradient` **(** :ref:`Gradient` gradient **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_width` **(** :ref:`int` width **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- -- :ref:`float` **colors** -- :ref:`float` **offsets** +- :ref:`Gradient` **gradient** - :ref:`int` **width** Member Function Description --------------------------- -.. _class_GradientTexture_add_point: +.. _class_GradientTexture_get_gradient: -- void **add_point** **(** :ref:`float` offset, :ref:`Color` color **)** +- :ref:`Gradient` **get_gradient** **(** **)** const -.. _class_GradientTexture_get_color: +.. _class_GradientTexture_set_gradient: -- :ref:`Color` **get_color** **(** :ref:`int` point **)** const - -.. _class_GradientTexture_get_colors: - -- :ref:`PoolColorArray` **get_colors** **(** **)** const - -.. _class_GradientTexture_get_offset: - -- :ref:`float` **get_offset** **(** :ref:`int` point **)** const - -.. _class_GradientTexture_get_offsets: - -- :ref:`PoolRealArray` **get_offsets** **(** **)** const - -.. _class_GradientTexture_get_point_count: - -- :ref:`int` **get_point_count** **(** **)** const - -.. _class_GradientTexture_interpolate: - -- :ref:`Color` **interpolate** **(** :ref:`float` offset **)** - -.. _class_GradientTexture_remove_point: - -- void **remove_point** **(** :ref:`int` offset **)** - -.. _class_GradientTexture_set_color: - -- void **set_color** **(** :ref:`int` point, :ref:`Color` color **)** - -.. _class_GradientTexture_set_colors: - -- void **set_colors** **(** :ref:`PoolColorArray` colors **)** - -.. _class_GradientTexture_set_offset: - -- void **set_offset** **(** :ref:`int` point, :ref:`float` offset **)** - -.. _class_GradientTexture_set_offsets: - -- void **set_offsets** **(** :ref:`PoolRealArray` offsets **)** +- void **set_gradient** **(** :ref:`Gradient` gradient **)** .. _class_GradientTexture_set_width: diff --git a/classes/class_graphedit.rst b/classes/class_graphedit.rst index 8d54bcdc5..e83ef4866 100644 --- a/classes/class_graphedit.rst +++ b/classes/class_graphedit.rst @@ -164,6 +164,6 @@ Enable the disconnection of existing connections in the visual GraphEdit by left - void **set_zoom** **(** :ref:`float` p_zoom **)** -Set the zoom value of the GraphEdit. Zoom value is between :ref:`0.01; 1.728`. +Set the zoom value of the GraphEdit. Zoom value is between 0.01; 1.728. diff --git a/classes/class_httpclient.rst b/classes/class_httpclient.rst index a6e55819f..3eb246775 100644 --- a/classes/class_httpclient.rst +++ b/classes/class_httpclient.rst @@ -256,7 +256,7 @@ 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 = :ref:`"Content-Type: application/x-www-form-urlencoded", "Content-Length: " + str(queryString.length())` + 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) .. _class_HTTPClient_request_raw: diff --git a/classes/class_image.rst b/classes/class_image.rst index 2674cc94b..c60a1fefb 100644 --- a/classes/class_image.rst +++ b/classes/class_image.rst @@ -18,9 +18,15 @@ Image datatype. Member Functions ---------------- ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`blend_rect` **(** :ref:`Image` src, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`blend_rect_mask` **(** :ref:`Image` src, :ref:`Image` mask, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`blit_rect` **(** :ref:`Image` src, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`blit_rect_mask` **(** :ref:`Image` src, :ref:`Image` mask, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_mipmaps` **(** **)** | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`compress` **(** :ref:`int` mode, :ref:`int` arg1, :ref:`float` arg2 **)** | @@ -41,6 +47,8 @@ Member Functions +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`expand_x2_hq2x` **(** **)** | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`fill` **(** :ref:`Color` color **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`fix_alpha_edges` **(** **)** | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`flip_x` **(** **)** | @@ -81,14 +89,14 @@ Member Functions +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`premultiply_alpha` **(** **)** | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`put_pixel` **(** :ref:`int` x, :ref:`int` y, :ref:`Color` color **)** | -+--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`resize` **(** :ref:`int` width, :ref:`int` height, :ref:`int` interpolation=1 **)** | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize_to_po2` **(** :ref:`bool` square="false" **)** | +| void | :ref:`resize_to_po2` **(** :ref:`bool` square=false **)** | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`save_png` **(** :ref:`String` path **)** const | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pixel` **(** :ref:`int` x, :ref:`int` y, :ref:`Color` color **)** | ++--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`shrink_x2` **(** **)** | +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`srgb_to_linear` **(** **)** | @@ -165,12 +173,30 @@ Native image datatype. Contains image data, which can be converted to a texture, Member Function Description --------------------------- +.. _class_Image_blend_rect: + +- void **blend_rect** **(** :ref:`Image` src, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** + +Alpha-blends a "src_rect" :ref:`Rect2` from "src" :ref:`Image` to this :ref:`Image` on coordinates "dest". + +.. _class_Image_blend_rect_mask: + +- void **blend_rect_mask** **(** :ref:`Image` src, :ref:`Image` mask, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** + +Alpha-blends a "src_rect" :ref:`Rect2` from "src" :ref:`Image` to this :ref:`Image` using a "mask" :ref:`Image` on coordinates "dest". Alpha channels are required for both "src" and "mask", dest pixels and src pixels will blend if the corresponding mask pixel's alpha value is not 0. "src" :ref:`Image` and "mask" :ref:`Image` \*must\* have the same size (width and height) but they can have different formats + .. _class_Image_blit_rect: - void **blit_rect** **(** :ref:`Image` src, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** Copy a "src_rect" :ref:`Rect2` from "src" :ref:`Image` to this :ref:`Image` on coordinates "dest". +.. _class_Image_blit_rect_mask: + +- void **blit_rect_mask** **(** :ref:`Image` src, :ref:`Image` mask, :ref:`Rect2` src_rect, :ref:`Vector2` dst **)** + +Blits a "src_rect" :ref:`Rect2` from "src" :ref:`Image` to this :ref:`Image` using a "mask" :ref:`Image` on coordinates "dest". Alpha channel is required for "mask", will copy src pixel onto dest if the corresponding mask pixel's alpha value is not 0. "src" :ref:`Image` and "mask" :ref:`Image` \*must\* have the same size (width and height) but they can have different formats + .. _class_Image_clear_mipmaps: - void **clear_mipmaps** **(** **)** @@ -213,6 +239,12 @@ Create an empty image of a specific size and format. - void **expand_x2_hq2x** **(** **)** +.. _class_Image_fill: + +- void **fill** **(** :ref:`Color` color **)** + +Fills an :ref:`Image` with a specified :ref:`Color` + .. _class_Image_fix_alpha_edges: - void **fix_alpha_edges** **(** **)** @@ -307,17 +339,13 @@ Load an :ref:`Image`. - void **premultiply_alpha** **(** **)** -.. _class_Image_put_pixel: - -- void **put_pixel** **(** :ref:`int` x, :ref:`int` y, :ref:`Color` color **)** - .. _class_Image_resize: - void **resize** **(** :ref:`int` width, :ref:`int` height, :ref:`int` interpolation=1 **)** .. _class_Image_resize_to_po2: -- void **resize_to_po2** **(** :ref:`bool` square="false" **)** +- void **resize_to_po2** **(** :ref:`bool` square=false **)** .. _class_Image_save_png: @@ -325,6 +353,10 @@ Load an :ref:`Image`. Save this :ref:`Image` as a png. +.. _class_Image_set_pixel: + +- void **set_pixel** **(** :ref:`int` x, :ref:`int` y, :ref:`Color` color **)** + .. _class_Image_shrink_x2: - void **shrink_x2** **(** **)** diff --git a/classes/class_imagetexture.rst b/classes/class_imagetexture.rst index d4bb32dff..77cd55d65 100644 --- a/classes/class_imagetexture.rst +++ b/classes/class_imagetexture.rst @@ -101,7 +101,7 @@ Return the storage type. One of :ref:`ImageTexture`.STORAGE\ - void **load** **(** :ref:`String` path **)** -Load an :ref:`ImageTexure`. +Load an ImageTexure. .. _class_ImageTexture_set_data: diff --git a/classes/class_inputevent.rst b/classes/class_inputevent.rst index 342fb957a..83be8ad0e 100644 --- a/classes/class_inputevent.rst +++ b/classes/class_inputevent.rst @@ -45,9 +45,16 @@ Member Functions +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_id` **(** :ref:`int` id **)** | +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`shortcut_match` **(** :ref:`InputEvent` event **)** const | ++--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`InputEvent` | :ref:`xformed_by` **(** :ref:`Transform2D` xform, :ref:`Vector2` local_ofs=Vector2(0, 0) **)** const | +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +Member Variables +---------------- + +- :ref:`int` **device** + Member Function Description --------------------------- @@ -109,6 +116,10 @@ Return if this input event is pressed. Not relevant for the event types MOUSE_MO - void **set_id** **(** :ref:`int` id **)** +.. _class_InputEvent_shortcut_match: + +- :ref:`bool` **shortcut_match** **(** :ref:`InputEvent` event **)** const + .. _class_InputEvent_xformed_by: - :ref:`InputEvent` **xformed_by** **(** :ref:`Transform2D` xform, :ref:`Vector2` local_ofs=Vector2(0, 0) **)** const diff --git a/classes/class_inputmap.rst b/classes/class_inputmap.rst index de0353b85..122504f84 100644 --- a/classes/class_inputmap.rst +++ b/classes/class_inputmap.rst @@ -101,6 +101,6 @@ Whether this InputMap has a registered action with the given name. - void **load_from_globals** **(** **)** -Clear the :ref:`InputMap` and load it anew from :ref:`Globals`. +Clear the :ref:`InputMap` and load it anew from :ref:`ProjectSettings`. diff --git a/classes/class_itemlist.rst b/classes/class_itemlist.rst index 20b007f37..7994527e5 100644 --- a/classes/class_itemlist.rst +++ b/classes/class_itemlist.rst @@ -47,7 +47,7 @@ Member Functions +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`get_item_icon_region` **(** :ref:`int` idx **)** const | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`get_item_metadata` **(** :ref:`int` idx **)** const | +| :ref:`Variant` | :ref:`get_item_metadata` **(** :ref:`int` idx **)** const | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_item_text` **(** :ref:`int` idx **)** const | +------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -138,6 +138,19 @@ Fired when specified item has been selected. Fired when a multiple selection is altered on a list allowing mutliple selection. +Member Variables +---------------- + +- :ref:`bool` **allow_rmb_select** +- :ref:`int` **fixed_column_width** +- :ref:`int` **icon_mode** +- :ref:`float` **icon_scale** +- :ref:`Array` **items** +- :ref:`int` **max_columns** +- :ref:`int` **max_text_lines** +- :ref:`bool` **same_column_width** +- :ref:`int` **select_mode** + Numeric Constants ----------------- @@ -236,7 +249,7 @@ Return count of items currently in the item list. .. _class_ItemList_get_item_metadata: -- void **get_item_metadata** **(** :ref:`int` idx **)** const +- :ref:`Variant` **get_item_metadata** **(** :ref:`int` idx **)** const .. _class_ItemList_get_item_text: diff --git a/classes/class_kinematicbody.rst b/classes/class_kinematicbody.rst index f9c576710..36f2b8685 100644 --- a/classes/class_kinematicbody.rst +++ b/classes/class_kinematicbody.rst @@ -18,68 +18,54 @@ Kinematic body 3D node. Member Functions ---------------- -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_collide_with_character_bodies` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_collide_with_kinematic_bodies` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_collide_with_rigid_bodies` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_collide_with_static_bodies` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`can_teleport_to` **(** :ref:`Vector3` position **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_collider` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collider_shape` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_collider_velocity` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_collision_margin` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_collision_normal` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_collision_pos` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_move_and_slide_colliders` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`get_travel` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_colliding` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_move_and_slide_on_ceiling` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_move_and_slide_on_floor` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_move_and_slide_on_wall` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`move` **(** :ref:`Vector3` rel_vec **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`move_and_slide` **(** :ref:`Vector3` linear_velocity, :ref:`Vector3` floor_normal=Vector3(0, 0, 0), :ref:`Vector3` ceil_normal=Vector3(0, 0, 0), :ref:`float` slope_stop_min_velocity=5, :ref:`int` max_bounces=4, :ref:`float` floor_max_angle=0.785398, :ref:`float` ceil_max_angle=0.785398 **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`move_to` **(** :ref:`Vector3` position **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`revert_motion` **(** **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collide_with_character_bodies` **(** :ref:`bool` enable **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collide_with_kinematic_bodies` **(** :ref:`bool` enable **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collide_with_rigid_bodies` **(** :ref:`bool` enable **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collide_with_static_bodies` **(** :ref:`bool` enable **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_margin` **(** :ref:`float` pixels **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_collision_collider` **(** :ref:`int` collision **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_collider_id` **(** :ref:`int` collision **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`get_collision_collider_metadata` **(** :ref:`int` collision **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_collision_collider_shape` **(** :ref:`int` collision **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_collider_shape_index` **(** :ref:`int` collision **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_collision_collider_velocity` **(** :ref:`int` collision **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_count` **(** **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_collision_local_shape` **(** :ref:`int` collision **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_collision_normal` **(** :ref:`int` collision **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_collision_position` **(** :ref:`int` collision **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_collision_remainder` **(** :ref:`int` collision **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_collision_travel` **(** :ref:`int` collision **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_floor_velocity` **(** **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_safe_margin` **(** **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_on_ceiling` **(** **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_on_floor` **(** **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_on_wall` **(** **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`move` **(** :ref:`Vector3` rel_vec **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`move_and_slide` **(** :ref:`Vector3` linear_velocity, :ref:`Vector3` floor_normal=Vector3(0, 0, 0), :ref:`float` slope_stop_min_velocity=0.05, :ref:`int` max_bounces=4, :ref:`float` floor_max_angle=0.785398 **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_safe_margin` **(** :ref:`float` pixels **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`test_move` **(** :ref:`Transform` from, :ref:`Vector3` rel_vec **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- -- :ref:`bool` **collide_with/character** -- :ref:`bool` **collide_with/kinematic** -- :ref:`bool` **collide_with/rigid** -- :ref:`bool` **collide_with/static** -- :ref:`float` **collision/margin** +- :ref:`float` **collision/safe_margin** Description ----------- @@ -93,146 +79,108 @@ Kinematic Characters: KinematicBody also has an api for moving objects (the :ref Member Function Description --------------------------- -.. _class_KinematicBody_can_collide_with_character_bodies: +.. _class_KinematicBody_get_collision_collider: -- :ref:`bool` **can_collide_with_character_bodies** **(** **)** const +- :ref:`Object` **get_collision_collider** **(** :ref:`int` collision **)** const -Return if this body can collide with character bodies. +.. _class_KinematicBody_get_collision_collider_id: -.. _class_KinematicBody_can_collide_with_kinematic_bodies: +- :ref:`int` **get_collision_collider_id** **(** :ref:`int` collision **)** const -- :ref:`bool` **can_collide_with_kinematic_bodies** **(** **)** const +.. _class_KinematicBody_get_collision_collider_metadata: -Return if this body can collide with kinematic bodies. +- void **get_collision_collider_metadata** **(** :ref:`int` collision **)** const -.. _class_KinematicBody_can_collide_with_rigid_bodies: +.. _class_KinematicBody_get_collision_collider_shape: -- :ref:`bool` **can_collide_with_rigid_bodies** **(** **)** const +- :ref:`Object` **get_collision_collider_shape** **(** :ref:`int` collision **)** const -Return if this body can collide with rigid bodies. +.. _class_KinematicBody_get_collision_collider_shape_index: -.. _class_KinematicBody_can_collide_with_static_bodies: +- :ref:`int` **get_collision_collider_shape_index** **(** :ref:`int` collision **)** const -- :ref:`bool` **can_collide_with_static_bodies** **(** **)** const +.. _class_KinematicBody_get_collision_collider_velocity: -Return if this body can collide with static bodies. +- :ref:`Vector3` **get_collision_collider_velocity** **(** :ref:`int` collision **)** const -.. _class_KinematicBody_can_teleport_to: +.. _class_KinematicBody_get_collision_count: -- :ref:`bool` **can_teleport_to** **(** :ref:`Vector3` position **)** +- :ref:`int` **get_collision_count** **(** **)** const -Returns whether the KinematicBody can be teleported to the destination given as an argument, checking all collision shapes of the body against potential colliders at the destination. +.. _class_KinematicBody_get_collision_local_shape: -.. _class_KinematicBody_get_collider: - -- :ref:`Variant` **get_collider** **(** **)** const - -Return the body that collided with this one. - -.. _class_KinematicBody_get_collider_shape: - -- :ref:`int` **get_collider_shape** **(** **)** const - -Return the shape index from the body that collided with this one. If there is no collision, this method will return 0, so collisions must be checked first with :ref:`is_colliding`. - -.. _class_KinematicBody_get_collider_velocity: - -- :ref:`Vector3` **get_collider_velocity** **(** **)** const - -Return the velocity of the body that collided with this one. - -.. _class_KinematicBody_get_collision_margin: - -- :ref:`float` **get_collision_margin** **(** **)** const - -Return the collision margin for this object. +- :ref:`Object` **get_collision_local_shape** **(** :ref:`int` collision **)** const .. _class_KinematicBody_get_collision_normal: -- :ref:`Vector3` **get_collision_normal** **(** **)** const +- :ref:`Vector3` **get_collision_normal** **(** :ref:`int` collision **)** const -Return the normal of the surface the body collided with. This is useful to implement sliding along a surface. +.. _class_KinematicBody_get_collision_position: -.. _class_KinematicBody_get_collision_pos: +- :ref:`Vector3` **get_collision_position** **(** :ref:`int` collision **)** const -- :ref:`Vector3` **get_collision_pos** **(** **)** const +.. _class_KinematicBody_get_collision_remainder: -Return the point in space where the body is touching another. If there is no collision, this method will return (0,0,0), so collisions must be checked first with :ref:`is_colliding`. +- :ref:`Vector3` **get_collision_remainder** **(** :ref:`int` collision **)** const -.. _class_KinematicBody_get_move_and_slide_colliders: +.. _class_KinematicBody_get_collision_travel: -- :ref:`Array` **get_move_and_slide_colliders** **(** **)** const +- :ref:`Vector3` **get_collision_travel** **(** :ref:`int` collision **)** const -.. _class_KinematicBody_get_travel: +.. _class_KinematicBody_get_floor_velocity: -- :ref:`Vector3` **get_travel** **(** **)** const +- :ref:`Vector3` **get_floor_velocity** **(** **)** const -.. _class_KinematicBody_is_colliding: +.. _class_KinematicBody_get_safe_margin: -- :ref:`bool` **is_colliding** **(** **)** const +- :ref:`float` **get_safe_margin** **(** **)** const -Return whether the body is colliding with another. +.. _class_KinematicBody_is_on_ceiling: -.. _class_KinematicBody_is_move_and_slide_on_ceiling: +- :ref:`bool` **is_on_ceiling** **(** **)** const -- :ref:`bool` **is_move_and_slide_on_ceiling** **(** **)** const +.. _class_KinematicBody_is_on_floor: -.. _class_KinematicBody_is_move_and_slide_on_floor: +- :ref:`bool` **is_on_floor** **(** **)** const -- :ref:`bool` **is_move_and_slide_on_floor** **(** **)** const +.. _class_KinematicBody_is_on_wall: -.. _class_KinematicBody_is_move_and_slide_on_wall: - -- :ref:`bool` **is_move_and_slide_on_wall** **(** **)** const +- :ref:`bool` **is_on_wall** **(** **)** const .. _class_KinematicBody_move: -- :ref:`Vector3` **move** **(** :ref:`Vector3` rel_vec **)** +- :ref:`Dictionary` **move** **(** :ref:`Vector3` rel_vec **)** -Move the body in the given direction, stopping if there is an obstacle. The returned vector is how much movement was remaining before being stopped. +Move the body in the given direction, stopping if there is an obstacle. If as a result of a movement there will be any collision then informations about this collision will be in returned dictionary. Dictionary will contains those keys: + +- "position" - collision position + +- "normal" - collision normal + +- "local_shape" - id of this kinematic body shape that took part in a collision + +- "travel" - traveled movement before being stopped + +- "remainder" - remaining movement before being stopped + +- "collider_id" - id of the collider, it can be used when dealing with :ref:`PhysicsServer` + +- "collider" - colliding body + +- "collider_shape_index" - index of the colliding shape, inside collider body "collider_metadata" + +If the body did not intersect anything, then an empty dictionary (dir.empty()==true) is returned instead. Please note that this method is less user friendly than :ref:`move_and_slide`. If you don't want to program each edge case manually, then it's recommended to use :ref:`move_and_slide` instead. .. _class_KinematicBody_move_and_slide: -- :ref:`Vector3` **move_and_slide** **(** :ref:`Vector3` linear_velocity, :ref:`Vector3` floor_normal=Vector3(0, 0, 0), :ref:`Vector3` ceil_normal=Vector3(0, 0, 0), :ref:`float` slope_stop_min_velocity=5, :ref:`int` max_bounces=4, :ref:`float` floor_max_angle=0.785398, :ref:`float` ceil_max_angle=0.785398 **)** +- :ref:`Vector3` **move_and_slide** **(** :ref:`Vector3` linear_velocity, :ref:`Vector3` floor_normal=Vector3(0, 0, 0), :ref:`float` slope_stop_min_velocity=0.05, :ref:`int` max_bounces=4, :ref:`float` floor_max_angle=0.785398 **)** -.. _class_KinematicBody_move_to: +.. _class_KinematicBody_set_safe_margin: -- :ref:`Vector3` **move_to** **(** :ref:`Vector3` position **)** +- void **set_safe_margin** **(** :ref:`float` pixels **)** -Move the body to the given position. This is not a teleport, and the body will stop if there is an obstacle. The returned vector is how much movement was remaining before being stopped. +.. _class_KinematicBody_test_move: -.. _class_KinematicBody_revert_motion: - -- void **revert_motion** **(** **)** - -.. _class_KinematicBody_set_collide_with_character_bodies: - -- void **set_collide_with_character_bodies** **(** :ref:`bool` enable **)** - -Set if this body should collide with character bodies. - -.. _class_KinematicBody_set_collide_with_kinematic_bodies: - -- void **set_collide_with_kinematic_bodies** **(** :ref:`bool` enable **)** - -Set if this body should collide with kinematic bodies. - -.. _class_KinematicBody_set_collide_with_rigid_bodies: - -- void **set_collide_with_rigid_bodies** **(** :ref:`bool` enable **)** - -Set if this body should collide with rigid bodies. - -.. _class_KinematicBody_set_collide_with_static_bodies: - -- void **set_collide_with_static_bodies** **(** :ref:`bool` enable **)** - -Set if this body should collide with static bodies. - -.. _class_KinematicBody_set_collision_margin: - -- void **set_collision_margin** **(** :ref:`float` pixels **)** - -Set the collision margin for this object. A collision margin is an amount that all shapes will grow when computing collisions, to account for numerical imprecision. +- :ref:`bool` **test_move** **(** :ref:`Transform` from, :ref:`Vector3` rel_vec **)** diff --git a/classes/class_kinematicbody2d.rst b/classes/class_kinematicbody2d.rst index 3af3bad87..2f5ebbe98 100644 --- a/classes/class_kinematicbody2d.rst +++ b/classes/class_kinematicbody2d.rst @@ -18,50 +18,54 @@ Kinematic body 2D node. Member Functions ---------------- -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_collider` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_collider_metadata` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collider_shape` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_collider_velocity` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_collision_margin` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_collision_normal` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_collision_pos` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_move_and_slide_colliders` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_travel` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_colliding` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_move_and_slide_on_ceiling` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_move_and_slide_on_floor` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_move_and_slide_on_wall` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`move` **(** :ref:`Vector2` rel_vec **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`move_and_slide` **(** :ref:`Vector2` linear_velocity, :ref:`Vector2` floor_normal=Vector2(0, 0), :ref:`float` slope_stop_min_velocity=5, :ref:`int` max_bounces=4, :ref:`float` floor_max_angle=0.785398 **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`move_to` **(** :ref:`Vector2` position **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`revert_motion` **(** **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_margin` **(** :ref:`float` pixels **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`test_move` **(** :ref:`Transform2D` from, :ref:`Vector2` rel_vec **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_collision_collider` **(** :ref:`int` collision **)** const | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_collider_id` **(** :ref:`int` collision **)** const | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`get_collision_collider_metadata` **(** :ref:`int` collision **)** const | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_collision_collider_shape` **(** :ref:`int` collision **)** const | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_collider_shape_index` **(** :ref:`int` collision **)** const | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_collision_collider_velocity` **(** :ref:`int` collision **)** const | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_count` **(** **)** const | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_collision_local_shape` **(** :ref:`int` collision **)** const | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_collision_normal` **(** :ref:`int` collision **)** const | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_collision_position` **(** :ref:`int` collision **)** const | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_collision_remainder` **(** :ref:`int` collision **)** const | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_collision_travel` **(** :ref:`int` collision **)** const | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_floor_velocity` **(** **)** const | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_safe_margin` **(** **)** const | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_on_ceiling` **(** **)** const | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_on_floor` **(** **)** const | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_on_wall` **(** **)** const | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`move` **(** :ref:`Vector2` rel_vec **)** | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`move_and_slide` **(** :ref:`Vector2` linear_velocity, :ref:`Vector2` floor_normal=Vector2(0, 0), :ref:`float` slope_stop_min_velocity=5, :ref:`int` max_bounces=4, :ref:`float` floor_max_angle=0.785398 **)** | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_safe_margin` **(** :ref:`float` pixels **)** | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`test_move` **(** :ref:`Transform2D` from, :ref:`Vector2` rel_vec **)** | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- -- :ref:`float` **collision/margin** +- :ref:`float` **collision/safe_margin** Description ----------- @@ -75,105 +79,107 @@ Kinematic Characters: KinematicBody2D also has an api for moving objects (the :r Member Function Description --------------------------- -.. _class_KinematicBody2D_get_collider: +.. _class_KinematicBody2D_get_collision_collider: -- :ref:`Variant` **get_collider** **(** **)** const +- :ref:`Object` **get_collision_collider** **(** :ref:`int` collision **)** const -Return the body that collided with this one. +.. _class_KinematicBody2D_get_collision_collider_id: -.. _class_KinematicBody2D_get_collider_metadata: +- :ref:`int` **get_collision_collider_id** **(** :ref:`int` collision **)** const -- :ref:`Variant` **get_collider_metadata** **(** **)** const +.. _class_KinematicBody2D_get_collision_collider_metadata: -Return the metadata of the shape that collided with this body. If there is no collision, it will return 0, so collisions must be checked first with :ref:`is_colliding`. Additionally, this metadata can not be set with :ref:`Object.set_meta`, it must be set with :ref:`Physics2DServer.body_set_shape_metadata`. +- void **get_collision_collider_metadata** **(** :ref:`int` collision **)** const -.. _class_KinematicBody2D_get_collider_shape: +.. _class_KinematicBody2D_get_collision_collider_shape: -- :ref:`int` **get_collider_shape** **(** **)** const +- :ref:`Object` **get_collision_collider_shape** **(** :ref:`int` collision **)** const -Return the shape index from the body that collided with this one. If there is no collision, this method will return 0, so collisions must be checked first with :ref:`is_colliding`. +.. _class_KinematicBody2D_get_collision_collider_shape_index: -.. _class_KinematicBody2D_get_collider_velocity: +- :ref:`int` **get_collision_collider_shape_index** **(** :ref:`int` collision **)** const -- :ref:`Vector2` **get_collider_velocity** **(** **)** const +.. _class_KinematicBody2D_get_collision_collider_velocity: + +- :ref:`Vector2` **get_collision_collider_velocity** **(** :ref:`int` collision **)** const Return the velocity of the body that collided with this one. -.. _class_KinematicBody2D_get_collision_margin: +.. _class_KinematicBody2D_get_collision_count: -- :ref:`float` **get_collision_margin** **(** **)** const +- :ref:`int` **get_collision_count** **(** **)** const -Return the collision margin for this object. +.. _class_KinematicBody2D_get_collision_local_shape: + +- :ref:`Object` **get_collision_local_shape** **(** :ref:`int` collision **)** const .. _class_KinematicBody2D_get_collision_normal: -- :ref:`Vector2` **get_collision_normal** **(** **)** const +- :ref:`Vector2` **get_collision_normal** **(** :ref:`int` collision **)** const -Return the normal of the surface the body collided with. This is useful to implement sliding along a surface. +.. _class_KinematicBody2D_get_collision_position: -.. _class_KinematicBody2D_get_collision_pos: +- :ref:`Vector2` **get_collision_position** **(** :ref:`int` collision **)** const -- :ref:`Vector2` **get_collision_pos** **(** **)** const +.. _class_KinematicBody2D_get_collision_remainder: -Return the point in space where the body is touching another. If there is no collision, this method will return (0,0), so collisions must be checked first with :ref:`is_colliding`. +- :ref:`Vector2` **get_collision_remainder** **(** :ref:`int` collision **)** const -.. _class_KinematicBody2D_get_move_and_slide_colliders: +.. _class_KinematicBody2D_get_collision_travel: -- :ref:`Array` **get_move_and_slide_colliders** **(** **)** const +- :ref:`Vector2` **get_collision_travel** **(** :ref:`int` collision **)** const -.. _class_KinematicBody2D_get_travel: +.. _class_KinematicBody2D_get_floor_velocity: -- :ref:`Vector2` **get_travel** **(** **)** const +- :ref:`Vector2` **get_floor_velocity** **(** **)** const -Return the last movement done by the body. +.. _class_KinematicBody2D_get_safe_margin: -.. _class_KinematicBody2D_is_colliding: +- :ref:`float` **get_safe_margin** **(** **)** const -- :ref:`bool` **is_colliding** **(** **)** const +.. _class_KinematicBody2D_is_on_ceiling: -Return whether the body is colliding with another. +- :ref:`bool` **is_on_ceiling** **(** **)** const -.. _class_KinematicBody2D_is_move_and_slide_on_ceiling: +.. _class_KinematicBody2D_is_on_floor: -- :ref:`bool` **is_move_and_slide_on_ceiling** **(** **)** const +- :ref:`bool` **is_on_floor** **(** **)** const -.. _class_KinematicBody2D_is_move_and_slide_on_floor: +.. _class_KinematicBody2D_is_on_wall: -- :ref:`bool` **is_move_and_slide_on_floor** **(** **)** const - -.. _class_KinematicBody2D_is_move_and_slide_on_wall: - -- :ref:`bool` **is_move_and_slide_on_wall** **(** **)** const +- :ref:`bool` **is_on_wall** **(** **)** const .. _class_KinematicBody2D_move: -- :ref:`Vector2` **move** **(** :ref:`Vector2` rel_vec **)** +- :ref:`Dictionary` **move** **(** :ref:`Vector2` rel_vec **)** -Move the body in the given direction, stopping if there is an obstacle. The returned vector is how much movement was remaining before being stopped. +Move the body in the given direction, stopping if there is an obstacle. If as a result of a movement there will be any collision then informations about this collision will be in returned dictionary. Dictionary will contains those keys: + +- "position" - collision position + +- "normal" - collision normal + +- "local_shape" - id of this kinematic body shape that took part in a collision + +- "travel" - traveled movement before being stopped + +- "remainder" - remaining movement before being stopped + +- "collider_id" - id of the collider, it can be used when dealing with :ref:`Physics2DServer` + +- "collider" - colliding body + +- "collider_shape_index" - index of the colliding shape, inside collider body "collider_metadata" + +If the body did not intersect anything, then an empty dictionary (dir.empty()==true) is returned instead. Please note that this method is less user friendly than :ref:`move_and_slide`. If you don't want to program each edge case manually, then it's recommended to use :ref:`move_and_slide` instead. .. _class_KinematicBody2D_move_and_slide: - :ref:`Vector2` **move_and_slide** **(** :ref:`Vector2` linear_velocity, :ref:`Vector2` floor_normal=Vector2(0, 0), :ref:`float` slope_stop_min_velocity=5, :ref:`int` max_bounces=4, :ref:`float` floor_max_angle=0.785398 **)** -.. _class_KinematicBody2D_move_to: +.. _class_KinematicBody2D_set_safe_margin: -- :ref:`Vector2` **move_to** **(** :ref:`Vector2` position **)** - -Move the body to the given position. This is not a teleport, and the body will stop if there is an obstacle. The returned vector is how much movement was remaining before being stopped. - -``floor_max_angle`` is in radians (default is pi/4), and filters which obstacles should be considered as floors/cellings instead of walls. - -.. _class_KinematicBody2D_revert_motion: - -- void **revert_motion** **(** **)** - -Undo the last movement done by the body. - -.. _class_KinematicBody2D_set_collision_margin: - -- void **set_collision_margin** **(** :ref:`float` pixels **)** - -Set the collision margin for this object. A collision margin is an amount (in pixels) that all shapes will grow when computing collisions, to account for numerical imprecision. +- void **set_safe_margin** **(** :ref:`float` pixels **)** .. _class_KinematicBody2D_test_move: diff --git a/classes/class_material.rst b/classes/class_material.rst index 20c3f9fe9..aeba6b657 100644 --- a/classes/class_material.rst +++ b/classes/class_material.rst @@ -8,7 +8,7 @@ Material **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`ParticlesMaterial`, :ref:`ShaderMaterial`, :ref:`SpatialMaterial` +**Inherited By:** :ref:`ParticlesMaterial`, :ref:`ShaderMaterial`, :ref:`SpatialMaterial`, :ref:`CanvasItemMaterial` **Category:** Core @@ -17,8 +17,34 @@ Brief Description Abstract base :ref:`Resource` for coloring and shading geometry. +Member Functions +---------------- + ++----------------------------------+------------------------------------------------------------------------------------------------------------+ +| :ref:`Material` | :ref:`get_next_pass` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_next_pass` **(** :ref:`Material` next_pass **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`Material` **next_pass** + Description ----------- Material is a base :ref:`Resource` used for coloring and shading geometry. All materials inherit from it and almost all :ref:`VisualInstance` derived nodes carry a Material. A few flags and parameters are shared between all material types and are configured here. +Member Function Description +--------------------------- + +.. _class_Material_get_next_pass: + +- :ref:`Material` **get_next_pass** **(** **)** const + +.. _class_Material_set_next_pass: + +- void **set_next_pass** **(** :ref:`Material` next_pass **)** + + diff --git a/classes/class_mesh.rst b/classes/class_mesh.rst index 7b69cffae..c17dac1be 100644 --- a/classes/class_mesh.rst +++ b/classes/class_mesh.rst @@ -32,6 +32,17 @@ Member Functions | :ref:`PoolVector3Array` | :ref:`get_faces` **(** **)** const | +--------------------------------------------------+-------------------------------------------------------------------------------------------------------+ +Numeric Constants +----------------- + +- **PRIMITIVE_POINTS** = **0** --- Render array as points (one vertex equals one point). +- **PRIMITIVE_LINES** = **1** --- Render array as lines (every two vertices a line is created). +- **PRIMITIVE_LINE_STRIP** = **2** --- Render array as line strip. +- **PRIMITIVE_LINE_LOOP** = **3** --- Render array as line loop (like line strip, but closed). +- **PRIMITIVE_TRIANGLES** = **4** --- Render array as triangles (every three vertices a triangle is created). +- **PRIMITIVE_TRIANGLE_STRIP** = **5** --- Render array as triangle strips. +- **PRIMITIVE_TRIANGLE_FAN** = **6** --- Render array as triangle fans. + Description ----------- diff --git a/classes/class_meshdatatool.rst b/classes/class_meshdatatool.rst index 590b6811f..cbaf464a4 100644 --- a/classes/class_meshdatatool.rst +++ b/classes/class_meshdatatool.rst @@ -29,7 +29,7 @@ Member Functions +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolIntArray` | :ref:`get_edge_faces` **(** :ref:`int` idx **)** const | +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`get_edge_meta` **(** :ref:`int` idx **)** const | +| :ref:`Variant` | :ref:`get_edge_meta` **(** :ref:`int` idx **)** const | +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_edge_vertex` **(** :ref:`int` idx, :ref:`int` vertex **)** const | +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -37,7 +37,7 @@ Member Functions +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_face_edge` **(** :ref:`int` idx, :ref:`int` edge **)** const | +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`get_face_meta` **(** :ref:`int` idx **)** const | +| :ref:`Variant` | :ref:`get_face_meta` **(** :ref:`int` idx **)** const | +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_face_normal` **(** :ref:`int` idx **)** const | +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -59,7 +59,7 @@ Member Functions +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolIntArray` | :ref:`get_vertex_faces` **(** :ref:`int` idx **)** const | +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`get_vertex_meta` **(** :ref:`int` idx **)** const | +| :ref:`Variant` | :ref:`get_vertex_meta` **(** :ref:`int` idx **)** const | +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_vertex_normal` **(** :ref:`int` idx **)** const | +--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -121,7 +121,7 @@ Member Function Description .. _class_MeshDataTool_get_edge_meta: -- void **get_edge_meta** **(** :ref:`int` idx **)** const +- :ref:`Variant` **get_edge_meta** **(** :ref:`int` idx **)** const .. _class_MeshDataTool_get_edge_vertex: @@ -137,7 +137,7 @@ Member Function Description .. _class_MeshDataTool_get_face_meta: -- void **get_face_meta** **(** :ref:`int` idx **)** const +- :ref:`Variant` **get_face_meta** **(** :ref:`int` idx **)** const .. _class_MeshDataTool_get_face_normal: @@ -181,7 +181,7 @@ Member Function Description .. _class_MeshDataTool_get_vertex_meta: -- void **get_vertex_meta** **(** :ref:`int` idx **)** const +- :ref:`Variant` **get_vertex_meta** **(** :ref:`int` idx **)** const .. _class_MeshDataTool_get_vertex_normal: diff --git a/classes/class_meshinstance.rst b/classes/class_meshinstance.rst index 9de14ba9e..4d4f17a7f 100644 --- a/classes/class_meshinstance.rst +++ b/classes/class_meshinstance.rst @@ -18,19 +18,25 @@ Node that instances meshes into a scenario. Member Functions ---------------- -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_convex_collision` **(** **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_trimesh_collision` **(** **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Mesh` | :ref:`get_mesh` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_skeleton_path` **(** **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_mesh` **(** :ref:`Mesh` mesh **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_skeleton_path` **(** :ref:`NodePath` skeleton_path **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_convex_collision` **(** **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_debug_tangents` **(** **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_trimesh_collision` **(** **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Mesh` | :ref:`get_mesh` **(** **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_skeleton_path` **(** **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Material` | :ref:`get_surface_material` **(** :ref:`int` surface **)** const | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_mesh` **(** :ref:`Mesh` mesh **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_skeleton_path` **(** :ref:`NodePath` skeleton_path **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_surface_material` **(** :ref:`int` surface, :ref:`Material` material **)** | ++----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -50,6 +56,10 @@ Member Function Description - void **create_convex_collision** **(** **)** +.. _class_MeshInstance_create_debug_tangents: + +- void **create_debug_tangents** **(** **)** + .. _class_MeshInstance_create_trimesh_collision: - void **create_trimesh_collision** **(** **)** @@ -66,6 +76,10 @@ Return the current :ref:`Mesh` resource for the instance. - :ref:`NodePath` **get_skeleton_path** **(** **)** +.. _class_MeshInstance_get_surface_material: + +- :ref:`Material` **get_surface_material** **(** :ref:`int` surface **)** const + .. _class_MeshInstance_set_mesh: - void **set_mesh** **(** :ref:`Mesh` mesh **)** @@ -76,4 +90,8 @@ Set the :ref:`Mesh` resource for the instance. - void **set_skeleton_path** **(** :ref:`NodePath` skeleton_path **)** +.. _class_MeshInstance_set_surface_material: + +- void **set_surface_material** **(** :ref:`int` surface, :ref:`Material` material **)** + diff --git a/classes/class_multimesh.rst b/classes/class_multimesh.rst index 5095884ed..f86468657 100644 --- a/classes/class_multimesh.rst +++ b/classes/class_multimesh.rst @@ -74,7 +74,7 @@ For this case a MultiMesh becomes very useful, as it can draw thousands of insta As a drawback, if the instances are too far away of each other, performance may be reduced as every single instance will always rendered (they are spatially indexed as one, for the whole object). -Since instances may have any behavior, the Rect3 used for visibility must be provided by the user, or generated with :ref:`generate_aabb`. +Since instances may have any behavior, the Rect3 used for visibility must be provided by the user. Member Function Description --------------------------- diff --git a/classes/class_mutex.rst b/classes/class_mutex.rst index 910a4e06c..a5b9e9edf 100644 --- a/classes/class_mutex.rst +++ b/classes/class_mutex.rst @@ -44,7 +44,7 @@ Lock this :ref:`Mutex`, blocks until it is unlocked by the current - Error **try_lock** **(** **)** -Try locking this :ref:`Mutex`, does not block. Returns :ref:`OK` on success else :ref:`ERR_BUSY`. +Try locking this :ref:`Mutex`, does not block. Returns OK on success else ERR_BUSY. .. _class_Mutex_unlock: diff --git a/classes/class_ninepatchrect.rst b/classes/class_ninepatchrect.rst index db80dc2a2..db987df62 100644 --- a/classes/class_ninepatchrect.rst +++ b/classes/class_ninepatchrect.rst @@ -21,20 +21,28 @@ Member Functions +------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_draw_center` **(** **)** const | +------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_h_axis_stretch_mode` **(** **)** const | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_patch_margin` **(** :ref:`int` margin **)** const | +------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`get_region_rect` **(** **)** const | +------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Object` | :ref:`get_texture` **(** **)** const | +------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_v_axis_stretch_mode` **(** **)** const | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_draw_center` **(** :ref:`bool` draw_center **)** | +------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_h_axis_stretch_mode` **(** :ref:`int` mode **)** | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_patch_margin` **(** :ref:`int` margin, :ref:`int` value **)** | +------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_region_rect` **(** :ref:`Rect2` rect **)** | +------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_texture` **(** :ref:`Object` texture **)** | +------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_v_axis_stretch_mode` **(** :ref:`int` mode **)** | ++------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -44,6 +52,8 @@ Signals Member Variables ---------------- +- :ref:`int` **axis_stretch_horizontal** +- :ref:`int` **axis_stretch_vertical** - :ref:`bool` **draw_center** - :ref:`int` **patch_margin_bottom** - :ref:`int` **patch_margin_left** @@ -52,6 +62,13 @@ Member Variables - :ref:`Rect2` **region_rect** - :ref:`Texture` **texture** +Numeric Constants +----------------- + +- **AXIS_STRETCH_MODE_STRETCH** = **0** +- **AXIS_STRETCH_MODE_TILE** = **1** +- **AXIS_STRETCH_MODE_TILE_FIT** = **2** + Member Function Description --------------------------- @@ -59,6 +76,10 @@ Member Function Description - :ref:`bool` **get_draw_center** **(** **)** const +.. _class_NinePatchRect_get_h_axis_stretch_mode: + +- :ref:`int` **get_h_axis_stretch_mode** **(** **)** const + .. _class_NinePatchRect_get_patch_margin: - :ref:`int` **get_patch_margin** **(** :ref:`int` margin **)** const @@ -71,10 +92,18 @@ Member Function Description - :ref:`Object` **get_texture** **(** **)** const +.. _class_NinePatchRect_get_v_axis_stretch_mode: + +- :ref:`int` **get_v_axis_stretch_mode** **(** **)** const + .. _class_NinePatchRect_set_draw_center: - void **set_draw_center** **(** :ref:`bool` draw_center **)** +.. _class_NinePatchRect_set_h_axis_stretch_mode: + +- void **set_h_axis_stretch_mode** **(** :ref:`int` mode **)** + .. _class_NinePatchRect_set_patch_margin: - void **set_patch_margin** **(** :ref:`int` margin, :ref:`int` value **)** @@ -87,4 +116,8 @@ Member Function Description - void **set_texture** **(** :ref:`Object` texture **)** +.. _class_NinePatchRect_set_v_axis_stretch_mode: + +- void **set_v_axis_stretch_mode** **(** :ref:`int` mode **)** + diff --git a/classes/class_node.rst b/classes/class_node.rst index 08bcc0305..44ee80b59 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -8,7 +8,7 @@ Node **Inherits:** :ref:`Object` -**Inherited By:** :ref:`Viewport`, :ref:`Timer`, :ref:`CanvasLayer`, :ref:`Tween`, :ref:`Spatial`, :ref:`AnimationPlayer`, :ref:`EditorFileSystem`, :ref:`EditorPlugin`, :ref:`ResourcePreloader`, :ref:`AnimationTreePlayer`, :ref:`InstancePlaceholder`, :ref:`HTTPRequest`, :ref:`EditorResourcePreview`, :ref:`CanvasItem`, :ref:`AudioPlayer` +**Inherited By:** :ref:`Viewport`, :ref:`Timer`, :ref:`AudioStreamPlayer`, :ref:`CanvasLayer`, :ref:`Tween`, :ref:`Spatial`, :ref:`AnimationPlayer`, :ref:`EditorFileSystem`, :ref:`EditorPlugin`, :ref:`ResourcePreloader`, :ref:`AnimationTreePlayer`, :ref:`WorldEnvironment`, :ref:`InstancePlaceholder`, :ref:`HTTPRequest`, :ref:`EditorResourcePreview`, :ref:`CanvasItem` **Category:** Core @@ -63,7 +63,7 @@ Member Functions +------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_name` **(** **)** const | +------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_network_mode` **(** **)** const | +| :ref:`int` | :ref:`get_network_master` **(** **)** const | +------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Node` | :ref:`get_node` **(** :ref:`NodePath` path **)** const | +------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -171,7 +171,7 @@ Member Functions +------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_name` **(** :ref:`String` name **)** | +------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_network_mode` **(** :ref:`int` mode **)** | +| void | :ref:`set_network_master` **(** :ref:`int` id, :ref:`bool` recursive=true **)** | +------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_owner` **(** :ref:`Node` owner **)** | +------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -226,9 +226,6 @@ Numeric Constants - **NOTIFICATION_TRANSLATION_CHANGED** = **24** - **NOTIFICATION_INTERNAL_PROCESS** = **25** - **NOTIFICATION_INTERNAL_FIXED_PROCESS** = **26** -- **NETWORK_MODE_INHERIT** = **0** -- **NETWORK_MODE_MASTER** = **1** -- **NETWORK_MODE_SLAVE** = **2** - **RPC_MODE_DISABLED** = **0** - **RPC_MODE_REMOTE** = **1** - **RPC_MODE_SYNC** = **2** @@ -406,9 +403,9 @@ Get the node index, i.e. its position among the siblings of its parent. Return the name of the node. This name is unique among the siblings (other child nodes from the same parent). -.. _class_Node_get_network_mode: +.. _class_Node_get_network_master: -- :ref:`int` **get_network_mode** **(** **)** const +- :ref:`int` **get_network_master** **(** **)** const .. _class_Node_get_node: @@ -712,11 +709,9 @@ Enables or disables node fixed framerate processing. When a node is being proces Set the name of the :ref:`Node`. Name must be unique within parent, and setting an already existing name will cause for the node to be automatically renamed. -.. _class_Node_set_network_mode: +.. _class_Node_set_network_master: -- void **set_network_mode** **(** :ref:`int` mode **)** - -Change the networking mode of the :ref:`Node`, where *mode* is one of the constants NETWORK_MODE\_\*. Master nodes will only call gdscript methods defined as *master func* if a RPC call is received (slave nodes will only call *slave func*; both will call *remote func* if the call is not local, and *sync func* in any case). Inherit mode looks at the parent node to determine the value (root node depends on the :ref:`SceneTree` having a networking peer set with :ref:`SceneTree.set_network_peer`) +- void **set_network_master** **(** :ref:`int` id, :ref:`bool` recursive=true **)** .. _class_Node_set_owner: diff --git a/classes/class_node2d.rst b/classes/class_node2d.rst index 759c2b594..c6febcf3b 100644 --- a/classes/class_node2d.rst +++ b/classes/class_node2d.rst @@ -8,7 +8,7 @@ Node2D **Inherits:** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`RemoteTransform2D`, :ref:`Joint2D`, :ref:`ParticleAttractor2D`, :ref:`ParallaxLayer`, :ref:`Line2D`, :ref:`VisibilityNotifier2D`, :ref:`Navigation2D`, :ref:`CollisionPolygon2D`, :ref:`TouchScreenButton`, :ref:`Particles2D`, :ref:`AnimatedSprite`, :ref:`Light2D`, :ref:`Path2D`, :ref:`Sprite`, :ref:`RayCast2D`, :ref:`CollisionShape2D`, :ref:`NavigationPolygonInstance`, :ref:`PathFollow2D`, :ref:`Polygon2D`, :ref:`Position2D`, :ref:`LightOccluder2D`, :ref:`CollisionObject2D`, :ref:`BackBufferCopy`, :ref:`CanvasModulate`, :ref:`YSort`, :ref:`TileMap`, :ref:`Camera2D` +**Inherited By:** :ref:`RemoteTransform2D`, :ref:`Joint2D`, :ref:`ParallaxLayer`, :ref:`Line2D`, :ref:`VisibilityNotifier2D`, :ref:`Navigation2D`, :ref:`CollisionPolygon2D`, :ref:`TouchScreenButton`, :ref:`Particles2D`, :ref:`AnimatedSprite`, :ref:`Light2D`, :ref:`Path2D`, :ref:`AudioStreamPlayer2D`, :ref:`Sprite`, :ref:`RayCast2D`, :ref:`CollisionShape2D`, :ref:`NavigationPolygonInstance`, :ref:`PathFollow2D`, :ref:`Polygon2D`, :ref:`Position2D`, :ref:`LightOccluder2D`, :ref:`CollisionObject2D`, :ref:`BackBufferCopy`, :ref:`CanvasModulate`, :ref:`YSort`, :ref:`TileMap`, :ref:`Camera2D` **Category:** Core diff --git a/classes/class_object.rst b/classes/class_object.rst index 52bec384f..c8efa237f 100644 --- a/classes/class_object.rst +++ b/classes/class_object.rst @@ -6,7 +6,7 @@ Object ====== -**Inherited By:** :ref:`Reference`, :ref:`Physics2DServer`, :ref:`PhysicsDirectBodyState`, :ref:`Input`, :ref:`Node`, :ref:`Geometry`, :ref:`TreeItem`, :ref:`PhysicsDirectSpaceState`, :ref:`Engine`, :ref:`Physics2DDirectSpaceState`, :ref:`MainLoop`, :ref:`InputMap`, :ref:`UndoRedo`, :ref:`PhysicsServer`, :ref:`ResourceSaver`, :ref:`Performance`, :ref:`ResourceLoader`, :ref:`AudioServer`, :ref:`VisualServer`, :ref:`IP`, :ref:`ClassDB`, :ref:`OS`, :ref:`GlobalConfig`, :ref:`EditorSelection`, :ref:`Physics2DDirectBodyState`, :ref:`TranslationServer`, :ref:`EditorFileSystemDirectory` +**Inherited By:** :ref:`Reference`, :ref:`Physics2DServer`, :ref:`Input`, :ref:`Node`, :ref:`Geometry`, :ref:`TreeItem`, :ref:`PhysicsDirectSpaceState`, :ref:`Engine`, :ref:`Physics2DDirectSpaceState`, :ref:`MainLoop`, :ref:`InputMap`, :ref:`UndoRedo`, :ref:`PhysicsServer`, :ref:`ProjectSettings`, :ref:`ResourceSaver`, :ref:`Performance`, :ref:`ResourceLoader`, :ref:`AudioServer`, :ref:`VisualServer`, :ref:`IP`, :ref:`ClassDB`, :ref:`OS`, :ref:`PhysicsDirectBodyState`, :ref:`EditorSelection`, :ref:`Physics2DDirectBodyState`, :ref:`TranslationServer`, :ref:`EditorFileSystemDirectory` **Category:** Core @@ -53,9 +53,11 @@ Member Functions +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_class` **(** **)** const | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_incoming_connections` **(** **)** const | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_instance_ID` **(** **)** const | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`get_meta` **(** :ref:`String` name **)** const | +| :ref:`Variant` | :ref:`get_meta` **(** :ref:`String` name **)** const | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PoolStringArray` | :ref:`get_meta_list` **(** **)** const | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -146,7 +148,7 @@ Return a property, return null if the property does not exist. - :ref:`Array` **_get_property_list** **(** **)** virtual -Return the property list, array of dictionaries, dictionaries must contain: name:String, type:int (see TYPE\_\* enum in globals) and optionally: hint:int (see PROPERTY_HINT\_\* in globals), hint_string:String, usage:int (see PROPERTY_USAGE\_\* in globals). +Return the property list, array of dictionaries, dictionaries must contain: name:String, type:int (see TYPE\_\* enum in :ref:`@Global Scope`) and optionally: hint:int (see PROPERTY_HINT\_\* in :ref:`@Global Scope`), hint_string:String, usage:int (see PROPERTY_USAGE\_\* in :ref:`@Global Scope`). .. _class_Object__init: @@ -220,6 +222,20 @@ Get a property from the object. Return the class of the object as a string. +.. _class_Object_get_incoming_connections: + +- :ref:`Array` **get_incoming_connections** **(** **)** const + +Returns an :ref:`Array` of dictionaries with informations about signals that are connected to this object. + +Inside each :ref:`Dictionary` there are 3 fields: + +- "source" is a reference to signal emitter. + +- "signal_name" is name of connected signal. + +- "method_name" is a name of method to which signal is connected. + .. _class_Object_get_instance_ID: - :ref:`int` **get_instance_ID** **(** **)** const @@ -228,7 +244,7 @@ Return the instance ID. All objects have a unique instance ID. .. _class_Object_get_meta: -- void **get_meta** **(** :ref:`String` name **)** const +- :ref:`Variant` **get_meta** **(** :ref:`String` name **)** const Return a metadata from the object. @@ -246,7 +262,7 @@ Return the list of metadata in the object. - :ref:`Array` **get_property_list** **(** **)** const -Return the list of properties as an array of dictionaries, dictionaries contain: name:String, type:int (see TYPE\_\* enum in globals) and optionally: hint:int (see PROPERTY_HINT\_\* in globals), hint_string:String, usage:int (see PROPERTY_USAGE\_\* in globals). +Return the list of properties as an array of dictionaries, dictionaries contain: name:String, type:int (see TYPE\_\* enum in :ref:`@Global Scope`) and optionally: hint:int (see PROPERTY_HINT\_\* in :ref:`@Global Scope`), hint_string:String, usage:int (see PROPERTY_USAGE\_\* in :ref:`@Global Scope`). .. _class_Object_get_script: diff --git a/classes/class_optionbutton.rst b/classes/class_optionbutton.rst index 8c996ffac..ebf0e301a 100644 --- a/classes/class_optionbutton.rst +++ b/classes/class_optionbutton.rst @@ -33,7 +33,7 @@ Member Functions +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture` | :ref:`get_item_icon` **(** :ref:`int` idx **)** const | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`get_item_metadata` **(** :ref:`int` idx **)** const | +| :ref:`Variant` | :ref:`get_item_metadata` **(** :ref:`int` idx **)** const | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_item_text` **(** :ref:`int` idx **)** const | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -41,7 +41,7 @@ Member Functions +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_selected_ID` **(** **)** const | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`get_selected_metadata` **(** **)** const | +| :ref:`Variant` | :ref:`get_selected_metadata` **(** **)** const | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_item_disabled` **(** :ref:`int` idx **)** const | +--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -125,7 +125,7 @@ Return the icon of the item at index "idx". .. _class_OptionButton_get_item_metadata: -- void **get_item_metadata** **(** :ref:`int` idx **)** const +- :ref:`Variant` **get_item_metadata** **(** :ref:`int` idx **)** const .. _class_OptionButton_get_item_text: @@ -145,7 +145,7 @@ Return the current item index .. _class_OptionButton_get_selected_metadata: -- void **get_selected_metadata** **(** **)** const +- :ref:`Variant` **get_selected_metadata** **(** **)** const .. _class_OptionButton_is_item_disabled: diff --git a/classes/class_os.rst b/classes/class_os.rst index 331b57ca9..d791bffc9 100644 --- a/classes/class_os.rst +++ b/classes/class_os.rst @@ -179,6 +179,8 @@ Member Functions +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_icon` **(** :ref:`Object` icon **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_ime_position` **(** :ref:`Vector2` arg0 **)** | ++------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_keep_screen_on` **(** :ref:`bool` enabled **)** | +------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_low_processor_usage_mode` **(** :ref:`bool` enable **)** | @@ -349,7 +351,7 @@ Returns the current screen index (0 padded). - :ref:`String` **get_data_dir** **(** **)** const -Return the absolute directory path of user data path(:ref:`user://`). +Return the absolute directory path of user data path(user://). .. _class_OS_get_date: @@ -713,6 +715,10 @@ Set clipboard to the OS. - void **set_icon** **(** :ref:`Object` icon **)** +.. _class_OS_set_ime_position: + +- void **set_ime_position** **(** :ref:`Vector2` arg0 **)** + .. _class_OS_set_keep_screen_on: - void **set_keep_screen_on** **(** :ref:`bool` enabled **)** diff --git a/classes/class_packetpeerudp.rst b/classes/class_packetpeerudp.rst index 896c8647d..bfbaca2b2 100644 --- a/classes/class_packetpeerudp.rst +++ b/classes/class_packetpeerudp.rst @@ -37,7 +37,7 @@ Member Functions Description ----------- -UDP packet peer. Can be used to send raw UDP packets as well as :ref:`Variant`s. +UDP packet peer. Can be used to send raw UDP packets as well as :ref:`Variant`\ s. Member Function Description --------------------------- diff --git a/classes/class_panelcontainer.rst b/classes/class_panelcontainer.rst index a61b43094..df8abd859 100644 --- a/classes/class_panelcontainer.rst +++ b/classes/class_panelcontainer.rst @@ -8,6 +8,8 @@ PanelContainer **Inherits:** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` +**Inherited By:** :ref:`ScriptEditor` + **Category:** Core Brief Description diff --git a/classes/class_particleattractor2d.rst b/classes/class_particleattractor2d.rst deleted file mode 100644 index 552ddd8b7..000000000 --- a/classes/class_particleattractor2d.rst +++ /dev/null @@ -1,108 +0,0 @@ -.. Generated automatically by doc/tools/makerst.py in Godot's source tree. -.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. - -.. _class_ParticleAttractor2D: - -ParticleAttractor2D -=================== - -**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` - -**Category:** Core - -Brief Description ------------------ - - - -Member Functions ----------------- - -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_absorption` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_disable_radius` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_gravity` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_particles_path` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_radius` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_enabled` **(** **)** const | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_absorption` **(** :ref:`float` absorption **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_disable_radius` **(** :ref:`float` radius **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_enabled` **(** :ref:`bool` enabled **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_gravity` **(** :ref:`float` gravity **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_particles_path` **(** :ref:`NodePath` path **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_radius` **(** :ref:`float` radius **)** | -+----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - -Member Variables ----------------- - -- :ref:`float` **absorption** -- :ref:`float` **disable_radius** -- :ref:`bool` **enabled** -- :ref:`float` **gravity** -- :ref:`NodePath` **particles_path** -- :ref:`float` **radius** - -Member Function Description ---------------------------- - -.. _class_ParticleAttractor2D_get_absorption: - -- :ref:`float` **get_absorption** **(** **)** const - -.. _class_ParticleAttractor2D_get_disable_radius: - -- :ref:`float` **get_disable_radius** **(** **)** const - -.. _class_ParticleAttractor2D_get_gravity: - -- :ref:`float` **get_gravity** **(** **)** const - -.. _class_ParticleAttractor2D_get_particles_path: - -- :ref:`NodePath` **get_particles_path** **(** **)** const - -.. _class_ParticleAttractor2D_get_radius: - -- :ref:`float` **get_radius** **(** **)** const - -.. _class_ParticleAttractor2D_is_enabled: - -- :ref:`bool` **is_enabled** **(** **)** const - -.. _class_ParticleAttractor2D_set_absorption: - -- void **set_absorption** **(** :ref:`float` absorption **)** - -.. _class_ParticleAttractor2D_set_disable_radius: - -- void **set_disable_radius** **(** :ref:`float` radius **)** - -.. _class_ParticleAttractor2D_set_enabled: - -- void **set_enabled** **(** :ref:`bool` enabled **)** - -.. _class_ParticleAttractor2D_set_gravity: - -- void **set_gravity** **(** :ref:`float` gravity **)** - -.. _class_ParticleAttractor2D_set_particles_path: - -- void **set_particles_path** **(** :ref:`NodePath` path **)** - -.. _class_ParticleAttractor2D_set_radius: - -- void **set_radius** **(** :ref:`float` radius **)** - - diff --git a/classes/class_particles.rst b/classes/class_particles.rst index ad22bfba0..0a9cdba11 100644 --- a/classes/class_particles.rst +++ b/classes/class_particles.rst @@ -37,6 +37,8 @@ Member Functions +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_lifetime` **(** **)** const | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_one_shot` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_pre_process_time` **(** **)** const | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Material` | :ref:`get_process_material` **(** **)** const | @@ -51,6 +53,8 @@ Member Functions +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_emitting` **(** **)** const | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`restart` **(** **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_amount` **(** :ref:`int` amount **)** | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_draw_order` **(** :ref:`int` order **)** | @@ -69,6 +73,8 @@ Member Functions +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_lifetime` **(** :ref:`float` secs **)** | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_one_shot` **(** :ref:`bool` enable **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_pre_process_time` **(** :ref:`float` secs **)** | +----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_process_material` **(** :ref:`Material` material **)** | @@ -98,8 +104,9 @@ Member Variables - :ref:`bool` **fract_delta** - :ref:`float` **lifetime** - :ref:`bool` **local_coords** +- :ref:`bool` **one_shot** - :ref:`float` **preprocess** -- ParticlesMaterial,ShaderMaterial **process_material** +- ShaderMaterial,ParticlesMaterial **process_material** - :ref:`float` **randomness** - :ref:`float` **speed_scale** - :ref:`Rect3` **visibility_aabb** @@ -151,6 +158,10 @@ Member Function Description - :ref:`float` **get_lifetime** **(** **)** const +.. _class_Particles_get_one_shot: + +- :ref:`bool` **get_one_shot** **(** **)** const + .. _class_Particles_get_pre_process_time: - :ref:`float` **get_pre_process_time** **(** **)** const @@ -179,6 +190,10 @@ Member Function Description - :ref:`bool` **is_emitting** **(** **)** const +.. _class_Particles_restart: + +- void **restart** **(** **)** + .. _class_Particles_set_amount: - void **set_amount** **(** :ref:`int` amount **)** @@ -215,6 +230,10 @@ Member Function Description - void **set_lifetime** **(** :ref:`float` secs **)** +.. _class_Particles_set_one_shot: + +- void **set_one_shot** **(** :ref:`bool` enable **)** + .. _class_Particles_set_pre_process_time: - void **set_pre_process_time** **(** :ref:`float` secs **)** diff --git a/classes/class_particles2d.rst b/classes/class_particles2d.rst index 999b74bff..77595f3f2 100644 --- a/classes/class_particles2d.rst +++ b/classes/class_particles2d.rst @@ -18,202 +18,111 @@ Brief Description Member Functions ---------------- -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_amount` **(** **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_color` **(** **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`get_color_phase_color` **(** :ref:`int` phase **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_color_phase_pos` **(** :ref:`int` phase **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_color_phases` **(** **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_emission_half_extents` **(** **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolVector2Array` | :ref:`get_emission_points` **(** **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_emissor_offset` **(** **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_emit_timeout` **(** **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_explosiveness` **(** **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Gradient` | :ref:`get_gradient` **(** **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_h_frames` **(** **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_initial_velocity` **(** **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_lifetime` **(** **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_param` **(** :ref:`int` param **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_pre_process_time` **(** **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_process_mode` **(** **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_randomness` **(** :ref:`int` param **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_texture` **(** **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_time_scale` **(** **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_v_frames` **(** **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_emitting` **(** **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_flipped_h` **(** **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_flipped_v` **(** **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_using_local_space` **(** **)** const | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`pre_process` **(** :ref:`float` time **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reset` **(** **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_amount` **(** :ref:`int` amount **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_color` **(** :ref:`Color` color **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_color_phase_color` **(** :ref:`int` phase, :ref:`Color` color **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_color_phase_pos` **(** :ref:`int` phase, :ref:`float` pos **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_color_phases` **(** :ref:`int` phases **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_emission_half_extents` **(** :ref:`Vector2` extents **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_emission_points` **(** :ref:`PoolVector2Array` points **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_emissor_offset` **(** :ref:`Vector2` offset **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_emit_timeout` **(** :ref:`float` value **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_emitting` **(** :ref:`bool` active **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_explosiveness` **(** :ref:`float` amount **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_flip_h` **(** :ref:`bool` enable **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_flip_v` **(** :ref:`bool` enable **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Gradient` | :ref:`set_gradient` **(** :ref:`Object` gradient **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_h_frames` **(** :ref:`int` enable **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_initial_velocity` **(** :ref:`Vector2` velocity **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_lifetime` **(** :ref:`float` lifetime **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_param` **(** :ref:`int` param, :ref:`float` value **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_pre_process_time` **(** :ref:`float` time **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_process_mode` **(** :ref:`int` mode **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_randomness` **(** :ref:`int` param, :ref:`float` value **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`set_texture` **(** :ref:`Object` texture **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_time_scale` **(** :ref:`float` time_scale **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_local_space` **(** :ref:`bool` enable **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_v_frames` **(** :ref:`int` enable **)** | -+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - -Signals -------- - -- **emission_finished** **(** **)** ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`capture_rect` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_amount` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_draw_order` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_explosiveness_ratio` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_fixed_fps` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_fractional_delta` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_h_frames` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_lifetime` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_normal_map` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_one_shot` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_pre_process_time` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Material` | :ref:`get_process_material` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_randomness_ratio` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_speed_scale` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_texture` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_use_local_coordinates` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_v_frames` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_visibility_rect` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_emitting` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`restart` **(** **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_amount` **(** :ref:`int` amount **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_draw_order` **(** :ref:`int` order **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_emitting` **(** :ref:`bool` emitting **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_explosiveness_ratio` **(** :ref:`float` ratio **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fixed_fps` **(** :ref:`int` fps **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_fractional_delta` **(** :ref:`bool` enable **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_h_frames` **(** :ref:`int` frames **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_lifetime` **(** :ref:`float` secs **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_normal_map` **(** :ref:`Texture` texture **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_one_shot` **(** :ref:`bool` secs **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_pre_process_time` **(** :ref:`float` secs **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_process_material` **(** :ref:`Material` material **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_randomness_ratio` **(** :ref:`float` ratio **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_speed_scale` **(** :ref:`float` scale **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_texture` **(** :ref:`Texture` texture **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_local_coordinates` **(** :ref:`bool` enable **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_v_frames` **(** :ref:`int` frames **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_visibility_rect` **(** :ref:`Rect2` aabb **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- -- :ref:`Color` **color/color** -- :ref:`Gradient` **color/color_ramp** -- :ref:`int` **color_phases/count** -- :ref:`int` **config/amount** -- :ref:`float` **config/emit_timeout** -- :ref:`bool` **config/emitting** -- :ref:`float` **config/explosiveness** -- :ref:`bool` **config/flip_h** -- :ref:`bool` **config/flip_v** -- :ref:`int` **config/h_frames** -- :ref:`Vector2` **config/half_extents** -- :ref:`float` **config/lifetime** -- :ref:`bool` **config/local_space** -- :ref:`Vector2` **config/offset** -- :ref:`float` **config/preprocess** -- :ref:`int` **config/process_mode** -- :ref:`Texture` **config/texture** -- :ref:`float` **config/time_scale** -- :ref:`int` **config/v_frames** -- :ref:`PoolVector2Array` **emission_points** -- :ref:`float` **params/anim_initial_pos** -- :ref:`float` **params/anim_speed_scale** -- :ref:`float` **params/damping** -- :ref:`float` **params/direction** -- :ref:`float` **params/final_size** -- :ref:`float` **params/gravity_direction** -- :ref:`float` **params/gravity_strength** -- :ref:`float` **params/hue_variation** -- :ref:`float` **params/initial_angle** -- :ref:`float` **params/initial_size** -- :ref:`float` **params/linear_velocity** -- :ref:`float` **params/orbit_velocity** -- :ref:`float` **params/radial_accel** -- :ref:`float` **params/spin_velocity** -- :ref:`float` **params/spread** -- :ref:`float` **params/tangential_accel** -- :ref:`Color` **phase_0/color** -- :ref:`float` **phase_0/pos** -- :ref:`Color` **phase_1/color** -- :ref:`float` **phase_1/pos** -- :ref:`Color` **phase_2/color** -- :ref:`float` **phase_2/pos** -- :ref:`Color` **phase_3/color** -- :ref:`float` **phase_3/pos** -- :ref:`float` **randomness/anim_initial_pos** -- :ref:`float` **randomness/anim_speed_scale** -- :ref:`float` **randomness/damping** -- :ref:`float` **randomness/direction** -- :ref:`float` **randomness/final_size** -- :ref:`float` **randomness/gravity_direction** -- :ref:`float` **randomness/gravity_strength** -- :ref:`float` **randomness/hue_variation** -- :ref:`float` **randomness/initial_angle** -- :ref:`float` **randomness/initial_size** -- :ref:`float` **randomness/linear_velocity** -- :ref:`float` **randomness/orbit_velocity** -- :ref:`float` **randomness/radial_accel** -- :ref:`float` **randomness/spin_velocity** -- :ref:`float` **randomness/spread** -- :ref:`float` **randomness/tangential_accel** +- :ref:`int` **amount** +- :ref:`int` **draw_order** +- :ref:`bool` **emitting** +- :ref:`float` **explosiveness** +- :ref:`int` **fixed_fps** +- :ref:`bool` **fract_delta** +- :ref:`int` **h_frames** +- :ref:`float` **lifetime** +- :ref:`bool` **local_coords** +- :ref:`Texture` **normal_map** +- :ref:`bool` **one_shot** +- :ref:`float` **preprocess** +- ShaderMaterial,ParticlesMaterial **process_material** +- :ref:`float` **randomness** +- :ref:`float` **speed_scale** +- :ref:`Texture` **texture** +- :ref:`int` **v_frames** +- :ref:`Rect3` **visibility_rect** Numeric Constants ----------------- -- **PARAM_DIRECTION** = **0** --- Direction in degrees at which the particles will be launched, Notice that when the direction is set to 0 the particles will be launched to the negative -- **PARAM_SPREAD** = **1** -- **PARAM_LINEAR_VELOCITY** = **2** --- Velocity at which the particles will be launched. -- **PARAM_SPIN_VELOCITY** = **3** --- The speed at which particles will spin around its own center. -- **PARAM_ORBIT_VELOCITY** = **4** --- Velocity at which the particles will orbit around the emitter center -- **PARAM_GRAVITY_DIRECTION** = **5** --- Direction in degrees at which the particles will be attracted -- **PARAM_GRAVITY_STRENGTH** = **6** --- Strength of the gravitation attraction for each particle -- **PARAM_RADIAL_ACCEL** = **7** -- **PARAM_TANGENTIAL_ACCEL** = **8** -- **PARAM_DAMPING** = **9** --- Amount of damping for each particle -- **PARAM_INITIAL_ANGLE** = **10** --- Initial angle in radians at which each particle will be spawned -- **PARAM_INITIAL_SIZE** = **11** --- Initial size of each particle -- **PARAM_FINAL_SIZE** = **12** --- Final size of each particle, the particle size will interpolate to this value during its lifetime. -- **PARAM_HUE_VARIATION** = **13** -- **PARAM_ANIM_SPEED_SCALE** = **14** -- **PARAM_ANIM_INITIAL_POS** = **15** -- **PARAM_MAX** = **16** -- **MAX_COLOR_PHASES** = **4** +- **DRAW_ORDER_INDEX** = **0** +- **DRAW_ORDER_LIFETIME** = **1** Description ----------- @@ -223,95 +132,65 @@ Particles2D is a particle system 2D :ref:`Node` that is used to simu Member Function Description --------------------------- +.. _class_Particles2D_capture_rect: + +- :ref:`Rect2` **capture_rect** **(** **)** const + .. _class_Particles2D_get_amount: - :ref:`int` **get_amount** **(** **)** const Returns the amount of particles spawned at each emission -.. _class_Particles2D_get_color: +.. _class_Particles2D_get_draw_order: -- :ref:`Color` **get_color** **(** **)** const +- :ref:`int` **get_draw_order** **(** **)** const -Returns the tint color for each particle. +.. _class_Particles2D_get_explosiveness_ratio: -.. _class_Particles2D_get_color_phase_color: +- :ref:`float` **get_explosiveness_ratio** **(** **)** const -- :ref:`Color` **get_color_phase_color** **(** :ref:`int` phase **)** const +.. _class_Particles2D_get_fixed_fps: -.. _class_Particles2D_get_color_phase_pos: +- :ref:`int` **get_fixed_fps** **(** **)** const -- :ref:`float` **get_color_phase_pos** **(** :ref:`int` phase **)** const +.. _class_Particles2D_get_fractional_delta: -.. _class_Particles2D_get_color_phases: - -- :ref:`int` **get_color_phases** **(** **)** const - -.. _class_Particles2D_get_emission_half_extents: - -- :ref:`Vector2` **get_emission_half_extents** **(** **)** const - -Returns the half extents of the emission box. - -.. _class_Particles2D_get_emission_points: - -- :ref:`PoolVector2Array` **get_emission_points** **(** **)** const - -.. _class_Particles2D_get_emissor_offset: - -- :ref:`Vector2` **get_emissor_offset** **(** **)** const - -Returns the particle spawn origin position relative to the emitter. - -.. _class_Particles2D_get_emit_timeout: - -- :ref:`float` **get_emit_timeout** **(** **)** const - -Returns the amount of seconds during which the emitter will spawn particles - -.. _class_Particles2D_get_explosiveness: - -- :ref:`float` **get_explosiveness** **(** **)** const - -.. _class_Particles2D_get_gradient: - -- :ref:`Gradient` **get_gradient** **(** **)** const - -Returns the :ref:`Gradient` used to tint each particle. +- :ref:`bool` **get_fractional_delta** **(** **)** const .. _class_Particles2D_get_h_frames: - :ref:`int` **get_h_frames** **(** **)** const -.. _class_Particles2D_get_initial_velocity: - -- :ref:`Vector2` **get_initial_velocity** **(** **)** const - .. _class_Particles2D_get_lifetime: - :ref:`float` **get_lifetime** **(** **)** const Gets the amount of seconds that each particle will be visible. -.. _class_Particles2D_get_param: +.. _class_Particles2D_get_normal_map: -- :ref:`float` **get_param** **(** :ref:`int` param **)** const +- :ref:`Texture` **get_normal_map** **(** **)** const -Returns the value of the specified emitter parameter +.. _class_Particles2D_get_one_shot: + +- :ref:`bool` **get_one_shot** **(** **)** const .. _class_Particles2D_get_pre_process_time: - :ref:`float` **get_pre_process_time** **(** **)** const -.. _class_Particles2D_get_process_mode: +.. _class_Particles2D_get_process_material: -- :ref:`int` **get_process_mode** **(** **)** const +- :ref:`Material` **get_process_material** **(** **)** const -.. _class_Particles2D_get_randomness: +.. _class_Particles2D_get_randomness_ratio: -- :ref:`float` **get_randomness** **(** :ref:`int` param **)** const +- :ref:`float` **get_randomness_ratio** **(** **)** const -Returns the randomness value of the specified emitter parameter +.. _class_Particles2D_get_speed_scale: + +- :ref:`float` **get_speed_scale** **(** **)** const .. _class_Particles2D_get_texture: @@ -319,41 +198,27 @@ Returns the randomness value of the specified emitter parameter Returns the texture for emitted particles -.. _class_Particles2D_get_time_scale: +.. _class_Particles2D_get_use_local_coordinates: -- :ref:`float` **get_time_scale** **(** **)** const - -Returns the emitter time scale +- :ref:`bool` **get_use_local_coordinates** **(** **)** const .. _class_Particles2D_get_v_frames: - :ref:`int` **get_v_frames** **(** **)** const +.. _class_Particles2D_get_visibility_rect: + +- :ref:`Rect2` **get_visibility_rect** **(** **)** const + .. _class_Particles2D_is_emitting: - :ref:`bool` **is_emitting** **(** **)** const Returns whether this emitter is currently emitting or not -.. _class_Particles2D_is_flipped_h: +.. _class_Particles2D_restart: -- :ref:`bool` **is_flipped_h** **(** **)** const - -.. _class_Particles2D_is_flipped_v: - -- :ref:`bool` **is_flipped_v** **(** **)** const - -.. _class_Particles2D_is_using_local_space: - -- :ref:`bool` **is_using_local_space** **(** **)** const - -.. _class_Particles2D_pre_process: - -- void **pre_process** **(** :ref:`float` time **)** - -.. _class_Particles2D_reset: - -- void **reset** **(** **)** +- void **restart** **(** **)** .. _class_Particles2D_set_amount: @@ -361,122 +226,76 @@ Returns whether this emitter is currently emitting or not Sets the amount of particles spawned at each emission -.. _class_Particles2D_set_color: +.. _class_Particles2D_set_draw_order: -- void **set_color** **(** :ref:`Color` color **)** - -Set the tint color for each particle. - -.. _class_Particles2D_set_color_phase_color: - -- void **set_color_phase_color** **(** :ref:`int` phase, :ref:`Color` color **)** - -.. _class_Particles2D_set_color_phase_pos: - -- void **set_color_phase_pos** **(** :ref:`int` phase, :ref:`float` pos **)** - -.. _class_Particles2D_set_color_phases: - -- void **set_color_phases** **(** :ref:`int` phases **)** - -.. _class_Particles2D_set_emission_half_extents: - -- void **set_emission_half_extents** **(** :ref:`Vector2` extents **)** - -Sets the half extents of the emission box, particles will be spawned at random inside this box. - -.. _class_Particles2D_set_emission_points: - -- void **set_emission_points** **(** :ref:`PoolVector2Array` points **)** - -.. _class_Particles2D_set_emissor_offset: - -- void **set_emissor_offset** **(** :ref:`Vector2` offset **)** - -Sets the particle spawn origin position relative to the emitter center. for example if this value is set to (50, 50), the particle will spawn 50 units to the right and 50 units to the bottom of the emitter center. - -.. _class_Particles2D_set_emit_timeout: - -- void **set_emit_timeout** **(** :ref:`float` value **)** - -Sets the amount of seconds during which the emitter will spawn particles, after the specified seconds the emitter state will be set to non emitting, so calling :ref:`is_emitting` will return false. If the timeout is 0 the emitter will spawn forever. +- void **set_draw_order** **(** :ref:`int` order **)** .. _class_Particles2D_set_emitting: -- void **set_emitting** **(** :ref:`bool` active **)** +- void **set_emitting** **(** :ref:`bool` emitting **)** If this is set to true then the particle emitter will emit particles, if its false it will not. -.. _class_Particles2D_set_explosiveness: +.. _class_Particles2D_set_explosiveness_ratio: -- void **set_explosiveness** **(** :ref:`float` amount **)** +- void **set_explosiveness_ratio** **(** :ref:`float` ratio **)** -.. _class_Particles2D_set_flip_h: +.. _class_Particles2D_set_fixed_fps: -- void **set_flip_h** **(** :ref:`bool` enable **)** +- void **set_fixed_fps** **(** :ref:`int` fps **)** -.. _class_Particles2D_set_flip_v: +.. _class_Particles2D_set_fractional_delta: -- void **set_flip_v** **(** :ref:`bool` enable **)** - -.. _class_Particles2D_set_gradient: - -- :ref:`Gradient` **set_gradient** **(** :ref:`Object` gradient **)** - -Sets the :ref:`Gradient` used to tint each particle. Particle will be tinted according to their lifetimes. +- void **set_fractional_delta** **(** :ref:`bool` enable **)** .. _class_Particles2D_set_h_frames: -- void **set_h_frames** **(** :ref:`int` enable **)** - -.. _class_Particles2D_set_initial_velocity: - -- void **set_initial_velocity** **(** :ref:`Vector2` velocity **)** +- void **set_h_frames** **(** :ref:`int` frames **)** .. _class_Particles2D_set_lifetime: -- void **set_lifetime** **(** :ref:`float` lifetime **)** +- void **set_lifetime** **(** :ref:`float` secs **)** Sets the amount of seconds that each particle will be visible. -.. _class_Particles2D_set_param: +.. _class_Particles2D_set_normal_map: -- void **set_param** **(** :ref:`int` param, :ref:`float` value **)** +- void **set_normal_map** **(** :ref:`Texture` texture **)** -Sets the value of the specified emitter parameter (see the constants secction for the list of parameters) +.. _class_Particles2D_set_one_shot: + +- void **set_one_shot** **(** :ref:`bool` secs **)** .. _class_Particles2D_set_pre_process_time: -- void **set_pre_process_time** **(** :ref:`float` time **)** +- void **set_pre_process_time** **(** :ref:`float` secs **)** -.. _class_Particles2D_set_process_mode: +.. _class_Particles2D_set_process_material: -- void **set_process_mode** **(** :ref:`int` mode **)** +- void **set_process_material** **(** :ref:`Material` material **)** -.. _class_Particles2D_set_randomness: +.. _class_Particles2D_set_randomness_ratio: -- void **set_randomness** **(** :ref:`int` param, :ref:`float` value **)** +- void **set_randomness_ratio** **(** :ref:`float` ratio **)** -Sets the randomness value of the specified emitter parameter (see the constants secction for the list of parameters), 0 means no randomness, so every particle will have the parameters specified, 1 means that the parameter will be chosen at random, the closer the randomness value gets to 0 the more conservative the variation of the parameter will be. +.. _class_Particles2D_set_speed_scale: + +- void **set_speed_scale** **(** :ref:`float` scale **)** .. _class_Particles2D_set_texture: -- :ref:`Texture` **set_texture** **(** :ref:`Object` texture **)** +- void **set_texture** **(** :ref:`Texture` texture **)** -Sets the texture for each particle +.. _class_Particles2D_set_use_local_coordinates: -.. _class_Particles2D_set_time_scale: - -- void **set_time_scale** **(** :ref:`float` time_scale **)** - -Sets the increment or decrement for the particle lifetime. for example: if the time scale is set to 2, the particles will die and move twice as fast. - -.. _class_Particles2D_set_use_local_space: - -- void **set_use_local_space** **(** :ref:`bool` enable **)** +- void **set_use_local_coordinates** **(** :ref:`bool` enable **)** .. _class_Particles2D_set_v_frames: -- void **set_v_frames** **(** :ref:`int` enable **)** +- void **set_v_frames** **(** :ref:`int` frames **)** + +.. _class_Particles2D_set_visibility_rect: + +- void **set_visibility_rect** **(** :ref:`Rect2` aabb **)** diff --git a/classes/class_particlesmaterial.rst b/classes/class_particlesmaterial.rst index a6b10d768..dad26bc82 100644 --- a/classes/class_particlesmaterial.rst +++ b/classes/class_particlesmaterial.rst @@ -25,6 +25,8 @@ Member Functions +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3` | :ref:`get_emission_box_extents` **(** **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_emission_color_texture` **(** **)** const | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture` | :ref:`get_emission_normal_texture` **(** **)** const | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_emission_point_count` **(** **)** const | @@ -61,6 +63,8 @@ Member Functions +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_emission_box_extents` **(** :ref:`Vector3` extents **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_emission_color_texture` **(** :ref:`Texture` texture **)** | ++------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_emission_normal_texture` **(** :ref:`Texture` texture **)** | +------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_emission_point_count` **(** :ref:`int` point_count **)** | @@ -101,6 +105,7 @@ Member Variables - :ref:`float` **angular_velocity** - :ref:`CurveTexture` **angular_velocity_curve** - :ref:`float` **angular_velocity_random** +- :ref:`bool` **anim_loop** - :ref:`float` **anim_offset** - :ref:`CurveTexture` **anim_offset_curve** - :ref:`float` **anim_offset_random** @@ -113,12 +118,14 @@ Member Variables - :ref:`CurveTexture` **damping_curve** - :ref:`float` **damping_random** - :ref:`Vector3` **emission_box_extents** +- :ref:`Texture` **emission_color_texture** - :ref:`Texture` **emission_normal_texture** - :ref:`int` **emission_point_count** - :ref:`Texture` **emission_point_texture** - :ref:`int` **emission_shape** - :ref:`float` **emission_sphere_radius** - :ref:`bool` **flag_align_y** +- :ref:`bool` **flag_disable_z** - :ref:`bool` **flag_rotate_y** - :ref:`float` **flatness** - :ref:`Vector3` **gravity** @@ -165,7 +172,7 @@ Numeric Constants - **PARAM_MAX** = **12** - **FLAG_ALIGN_Y_TO_VELOCITY** = **0** - **FLAG_ROTATE_Y** = **1** -- **FLAG_MAX** = **2** +- **FLAG_MAX** = **4** - **EMISSION_SHAPE_POINT** = **0** - **EMISSION_SHAPE_SPHERE** = **1** - **EMISSION_SHAPE_BOX** = **2** @@ -187,6 +194,10 @@ Member Function Description - :ref:`Vector3` **get_emission_box_extents** **(** **)** const +.. _class_ParticlesMaterial_get_emission_color_texture: + +- :ref:`Texture` **get_emission_color_texture** **(** **)** const + .. _class_ParticlesMaterial_get_emission_normal_texture: - :ref:`Texture` **get_emission_normal_texture** **(** **)** const @@ -259,6 +270,10 @@ Member Function Description - void **set_emission_box_extents** **(** :ref:`Vector3` extents **)** +.. _class_ParticlesMaterial_set_emission_color_texture: + +- void **set_emission_color_texture** **(** :ref:`Texture` texture **)** + .. _class_ParticlesMaterial_set_emission_normal_texture: - void **set_emission_normal_texture** **(** :ref:`Texture` texture **)** diff --git a/classes/class_physics2ddirectspacestate.rst b/classes/class_physics2ddirectspacestate.rst index b3165177b..a64a5181a 100644 --- a/classes/class_physics2ddirectspacestate.rst +++ b/classes/class_physics2ddirectspacestate.rst @@ -104,7 +104,7 @@ collider: Object the point is inside of. rid: :ref:`RID` of the object the point is in. -Additionally, the method can take an array of objects or :ref:`RID`s that are to be excluded from collisions, a bitmask representing the physics layers to check in, and another bitmask for the types of objects to check (see TYPE_MASK\_\* constants). +Additionally, the method can take an array of objects or :ref:`RID`\ s that are to be excluded from collisions, a bitmask representing the physics layers to check in, and another bitmask for the types of objects to check (see TYPE_MASK\_\* constants). .. _class_Physics2DDirectSpaceState_intersect_ray: @@ -128,7 +128,7 @@ rid: :ref:`RID` of the object against which the ray was stopped. If the ray did not intersect anything, then an empty dictionary (dir.empty()==true) is returned instead. -Additionally, the method can take an array of objects or :ref:`RID`s that are to be excluded from collisions, a bitmask representing the physics layers to check in, and another bitmask for the types of objects to check (see TYPE_MASK\_\* constants). +Additionally, the method can take an array of objects or :ref:`RID`\ s that are to be excluded from collisions, a bitmask representing the physics layers to check in, and another bitmask for the types of objects to check (see TYPE_MASK\_\* constants). .. _class_Physics2DDirectSpaceState_intersect_shape: diff --git a/classes/class_physics2dserver.rst b/classes/class_physics2dserver.rst index c5429dfce..703662e2a 100644 --- a/classes/class_physics2dserver.rst +++ b/classes/class_physics2dserver.rst @@ -57,6 +57,8 @@ Member Functions +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`area_set_shape` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`RID` shape **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`area_set_shape_disabled` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`bool` disable **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`area_set_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`Transform2D` transform **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`area_set_space` **(** :ref:`RID` area, :ref:`RID` space **)** | @@ -91,10 +93,6 @@ Member Functions +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`body_get_object_instance_ID` **(** :ref:`RID` body **)** const | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`body_get_one_way_collision_direction` **(** :ref:`RID` body **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`body_get_one_way_collision_max_depth` **(** :ref:`RID` body **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`body_get_param` **(** :ref:`RID` body, :ref:`int` param **)** const | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`body_get_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | @@ -111,8 +109,6 @@ Member Functions +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`body_is_omitting_force_integration` **(** :ref:`RID` body **)** const | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`body_is_shape_set_as_trigger` **(** :ref:`RID` body, :ref:`int` shape_idx **)** const | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_remove_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_remove_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** | @@ -133,15 +129,13 @@ Member Functions +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_set_omit_force_integration` **(** :ref:`RID` body, :ref:`bool` enable **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_one_way_collision_direction` **(** :ref:`RID` body, :ref:`Vector2` normal **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_one_way_collision_max_depth` **(** :ref:`RID` body, :ref:`float` depth **)** | -+--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_set_param` **(** :ref:`RID` body, :ref:`int` param, :ref:`float` value **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_set_shape` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`RID` shape **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`body_set_shape_as_trigger` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` enable **)** | +| void | :ref:`body_set_shape_as_one_way_collision` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` enable **)** | ++--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`body_set_shape_disabled` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` disable **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`body_set_shape_metadata` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Variant` metadata **)** | +--------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -202,8 +196,8 @@ Numeric Constants - **SPACE_PARAM_CONTACT_RECYCLE_RADIUS** = **0** --- Constant to set/get the maximum distance a pair of bodies has to move before their collision status has to be recalculated. - **SPACE_PARAM_CONTACT_MAX_SEPARATION** = **1** --- Constant to set/get the maximum distance a shape can be from another before they are considered separated. - **SPACE_PARAM_BODY_MAX_ALLOWED_PENETRATION** = **2** --- Constant to set/get the maximum distance a shape can penetrate another shape before it is considered a collision. -- **SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_TRESHOLD** = **3** --- Constant to set/get the linear velocity threshold. Bodies slower than this will be marked as potentially inactive. -- **SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_TRESHOLD** = **4** --- Constant to set/get the angular velocity threshold. Bodies slower than this will be marked as potentially inactive. +- **SPACE_PARAM_BODY_LINEAR_VELOCITY_SLEEP_THRESHOLD** = **3** +- **SPACE_PARAM_BODY_ANGULAR_VELOCITY_SLEEP_THRESHOLD** = **4** - **SPACE_PARAM_BODY_TIME_TO_SLEEP** = **5** --- Constant to set/get the maximum time of activity. A body marked as potentially inactive for both linear and angular velocity will be put to sleep after this time. - **SPACE_PARAM_CONSTRAINT_DEFAULT_BIAS** = **6** --- Constant to set/get the default solver bias for all physics constraints. A solver bias is a factor controlling how much two objects "rebound", after violating a constraint, to avoid leaving them in that state because of numerical imprecision. - **SHAPE_LINE** = **0** --- This is the constant for creating line shapes. A line shape is an infinite line with an origin point, and a normal. Thus, it can be used for front/behind checks. @@ -385,6 +379,10 @@ Set the value for an area parameter. A list of available parameters is on the AR Substitute a given area shape by another. The old shape is selected by its index, the new one by its :ref:`RID`. +.. _class_Physics2DServer_area_set_shape_disabled: + +- void **area_set_shape_disabled** **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`bool` disable **)** + .. _class_Physics2DServer_area_set_shape_transform: - void **area_set_shape_transform** **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`Transform2D` transform **)** @@ -487,18 +485,6 @@ Return the body mode. Get the instance ID of the object the area is assigned to. -.. _class_Physics2DServer_body_get_one_way_collision_direction: - -- :ref:`Vector2` **body_get_one_way_collision_direction** **(** :ref:`RID` body **)** const - -Return the direction used for one-way collision detection. - -.. _class_Physics2DServer_body_get_one_way_collision_max_depth: - -- :ref:`float` **body_get_one_way_collision_max_depth** **(** :ref:`RID` body **)** const - -Return how far a body can go through the given one, when it allows one-way collisions. - .. _class_Physics2DServer_body_get_param: - :ref:`float` **body_get_param** **(** :ref:`RID` body, :ref:`int` param **)** const @@ -547,12 +533,6 @@ Return a body state. Return whether a body uses a callback function to calculate its own physics (see :ref:`body_set_force_integration_callback`). -.. _class_Physics2DServer_body_is_shape_set_as_trigger: - -- :ref:`bool` **body_is_shape_set_as_trigger** **(** :ref:`RID` body, :ref:`int` shape_idx **)** const - -Return whether a body's shape is marked as a trigger. - .. _class_Physics2DServer_body_remove_collision_exception: - void **body_remove_collision_exception** **(** :ref:`RID` body, :ref:`RID` excepted_body **)** @@ -615,18 +595,6 @@ Set the body mode, from one of the constants BODY_MODE\*. Set whether a body uses a callback function to calculate its own physics (see :ref:`body_set_force_integration_callback`). -.. _class_Physics2DServer_body_set_one_way_collision_direction: - -- void **body_set_one_way_collision_direction** **(** :ref:`RID` body, :ref:`Vector2` normal **)** - -Set a direction in which bodies can go through the given one. If this value is different from (0,0), any movement within 90 degrees of this vector is considered a valid movement. Set this direction to (0,0) to disable one-way collisions. - -.. _class_Physics2DServer_body_set_one_way_collision_max_depth: - -- void **body_set_one_way_collision_max_depth** **(** :ref:`RID` body, :ref:`float` depth **)** - -Set how far a body can go through the given one, if it allows one-way collisions (see :ref:`body_set_one_way_collision_direction`). - .. _class_Physics2DServer_body_set_param: - void **body_set_param** **(** :ref:`RID` body, :ref:`int` param, :ref:`float` value **)** @@ -639,11 +607,13 @@ Set a body parameter (see BODY_PARAM\* constants). Substitute a given body shape by another. The old shape is selected by its index, the new one by its :ref:`RID`. -.. _class_Physics2DServer_body_set_shape_as_trigger: +.. _class_Physics2DServer_body_set_shape_as_one_way_collision: -- void **body_set_shape_as_trigger** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` enable **)** +- void **body_set_shape_as_one_way_collision** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` enable **)** -Mark a body's shape as a trigger. A trigger shape cannot affect other bodies, but detects other shapes entering and exiting it. +.. _class_Physics2DServer_body_set_shape_disabled: + +- void **body_set_shape_disabled** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` disable **)** .. _class_Physics2DServer_body_set_shape_metadata: diff --git a/classes/class_physics2dshapequeryparameters.rst b/classes/class_physics2dshapequeryparameters.rst index a19106719..f604b2b9a 100644 --- a/classes/class_physics2dshapequeryparameters.rst +++ b/classes/class_physics2dshapequeryparameters.rst @@ -68,7 +68,7 @@ Return the physics layer the shape belongs to. - :ref:`Array` **get_exclude** **(** **)** const -Return the list of objects, or object :ref:`RID`s, that will be excluded from collisions. +Return the list of objects, or object :ref:`RID`\ s, that will be excluded from collisions. .. _class_Physics2DShapeQueryParameters_get_margin: @@ -110,7 +110,7 @@ Set the physics layer the shape belongs to. - void **set_exclude** **(** :ref:`Array` exclude **)** -Set the list of objects, or object :ref:`RID`s, that will be excluded from collisions. +Set the list of objects, or object :ref:`RID`\ s, that will be excluded from collisions. .. _class_Physics2DShapeQueryParameters_set_margin: diff --git a/classes/class_physicsbody2d.rst b/classes/class_physicsbody2d.rst index 85d37f5b4..f278ff513 100644 --- a/classes/class_physicsbody2d.rst +++ b/classes/class_physicsbody2d.rst @@ -20,35 +20,27 @@ Base class for all objects affected by physics. Member Functions ---------------- -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_collision_exception_with` **(** :ref:`PhysicsBody2D` body **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_layer` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_collision_mask` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_one_way_collision_direction` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_one_way_collision_max_depth` **(** **)** const | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_collision_exception_with` **(** :ref:`PhysicsBody2D` body **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_layer` **(** :ref:`int` layer **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_mask` **(** :ref:`int` mask **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_one_way_collision_direction` **(** :ref:`Vector2` dir **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_one_way_collision_max_depth` **(** :ref:`float` depth **)** | -+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_collision_exception_with` **(** :ref:`PhysicsBody2D` body **)** | ++--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_layer` **(** **)** const | ++--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_layer_bit` **(** :ref:`int` bit **)** const | ++--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_collision_mask` **(** **)** const | ++--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_collision_mask_bit` **(** :ref:`int` bit **)** const | ++--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_collision_exception_with` **(** :ref:`PhysicsBody2D` body **)** | ++--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer` **(** :ref:`int` layer **)** | ++--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_layer_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_mask` **(** :ref:`int` mask **)** | ++--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_collision_mask_bit` **(** :ref:`int` bit, :ref:`bool` value **)** | ++--------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -56,8 +48,6 @@ Member Variables - :ref:`int` **collision_layer** - :ref:`int` **collision_mask** - :ref:`int` **layers** -- :ref:`Vector2` **one_way_collision/direction** -- :ref:`float` **one_way_collision/max_depth** Description ----------- @@ -97,18 +87,6 @@ Return the physics layers this area can scan for collisions. Return an individual bit on the collision mask. -.. _class_PhysicsBody2D_get_one_way_collision_direction: - -- :ref:`Vector2` **get_one_way_collision_direction** **(** **)** const - -Return the direction used for one-way collision detection. - -.. _class_PhysicsBody2D_get_one_way_collision_max_depth: - -- :ref:`float` **get_one_way_collision_max_depth** **(** **)** const - -Return how far a body can go through this one, when it allows one-way collisions. - .. _class_PhysicsBody2D_remove_collision_exception_with: - void **remove_collision_exception_with** **(** :ref:`PhysicsBody2D` body **)** @@ -143,16 +121,4 @@ Set the physics layers this area can scan for collisions. Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier. -.. _class_PhysicsBody2D_set_one_way_collision_direction: - -- void **set_one_way_collision_direction** **(** :ref:`Vector2` dir **)** - -Set a direction in which bodies can go through this one. If this value is different from (0,0), any movement within 90 degrees of this vector is considered a valid movement. Set this direction to (0,0) to disable one-way collisions. - -.. _class_PhysicsBody2D_set_one_way_collision_max_depth: - -- void **set_one_way_collision_max_depth** **(** :ref:`float` depth **)** - -Set how far a body can go through this one, when it allows one-way collisions (see :ref:`set_one_way_collision_direction`). - diff --git a/classes/class_poolbytearray.rst b/classes/class_poolbytearray.rst index a3fed5eab..1aed4a460 100644 --- a/classes/class_poolbytearray.rst +++ b/classes/class_poolbytearray.rst @@ -16,33 +16,37 @@ Raw byte array. Member Functions ---------------- -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`PoolByteArray` **(** :ref:`Array` from **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append` **(** :ref:`int` byte **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`append_array` **(** :ref:`PoolByteArray` array **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_string_from_ascii` **(** **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_string_from_utf8` **(** **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`int` byte **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`invert` **(** **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_back` **(** :ref:`int` byte **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove` **(** :ref:`int` idx **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize` **(** :ref:`int` idx **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set` **(** :ref:`int` idx, :ref:`int` byte **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`size` **(** **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ -| :ref:`PoolByteArray` | :ref:`subarray` **(** :ref:`int` from, :ref:`int` to **)** | -+--------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`PoolByteArray` **(** :ref:`Array` from **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append` **(** :ref:`int` byte **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`append_array` **(** :ref:`PoolByteArray` array **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`compress` **(** :ref:`int` compression_mode=0 **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`decompress` **(** :ref:`int` buffer_size, :ref:`int` compression_mode=0 **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_string_from_ascii` **(** **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_string_from_utf8` **(** **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`insert` **(** :ref:`int` idx, :ref:`int` byte **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`invert` **(** **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_back` **(** :ref:`int` byte **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove` **(** :ref:`int` idx **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`resize` **(** :ref:`int` idx **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set` **(** :ref:`int` idx, :ref:`int` byte **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`size` **(** **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolByteArray` | :ref:`subarray` **(** :ref:`int` from, :ref:`int` to **)** | ++--------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -68,6 +72,18 @@ Create from a generic array. Append an :ref:`PoolByteArray` at the end of this array. +.. _class_PoolByteArray_compress: + +- :ref:`PoolByteArray` **compress** **(** :ref:`int` compression_mode=0 **)** + +Returns a new :ref:`PoolByteArray` with the data compressed. The compression mode can be set using one of the COMPRESS\_\* constants of :ref:`File`. + +.. _class_PoolByteArray_decompress: + +- :ref:`PoolByteArray` **decompress** **(** :ref:`int` buffer_size, :ref:`int` compression_mode=0 **)** + +Returns a new :ref:`PoolByteArray` with the data decompressed. The buffer_size should be set as the size of the uncompressed data. The compression mode can be set using one of the COMPRESS\_\* constants of :ref:`File`. + .. _class_PoolByteArray_get_string_from_ascii: - :ref:`String` **get_string_from_ascii** **(** **)** @@ -126,6 +142,6 @@ Return the size of the array. - :ref:`PoolByteArray` **subarray** **(** :ref:`int` from, :ref:`int` to **)** -Returns the slice of the :ref:`PoolByteArray` between indices (inclusive) as a new :ref:`RawArray`. Any negative index is considered to be from the end of the array. +Returns the slice of the :ref:`PoolByteArray` between indices (inclusive) as a new :ref:`PoolByteArray`. Any negative index is considered to be from the end of the array. diff --git a/classes/class_poolrealarray.rst b/classes/class_poolrealarray.rst index 809896d5b..9fc18cc75 100644 --- a/classes/class_poolrealarray.rst +++ b/classes/class_poolrealarray.rst @@ -62,7 +62,7 @@ Append an element at the end of the array (alias of :ref:`push_back` array **)** -Append an :ref:`RealArray` at the end of this array. +Append an RealArray at the end of this array. .. _class_PoolRealArray_insert: @@ -92,7 +92,7 @@ Remove an element from the array by index. - void **resize** **(** :ref:`int` idx **)** -Set the size of the :ref:`RealArray`. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. +Set the size of the RealArray. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. .. _class_PoolRealArray_set: diff --git a/classes/class_poolstringarray.rst b/classes/class_poolstringarray.rst index 0ef0ce42f..30bfe115b 100644 --- a/classes/class_poolstringarray.rst +++ b/classes/class_poolstringarray.rst @@ -64,7 +64,7 @@ Append an element at the end of the array (alias of :ref:`push_back` array **)** -Append an :ref:`StringArray` at the end of this array. +Append an StringArray at the end of this array. .. _class_PoolStringArray_insert: @@ -98,7 +98,7 @@ Remove an element from the array by index. - void **resize** **(** :ref:`int` idx **)** -Set the size of the :ref:`StringArray`. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. +Set the size of the StringArray. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array. .. _class_PoolStringArray_set: diff --git a/classes/class_popupmenu.rst b/classes/class_popupmenu.rst index f06d6d7f3..bbe71d8f2 100644 --- a/classes/class_popupmenu.rst +++ b/classes/class_popupmenu.rst @@ -51,7 +51,7 @@ Member Functions +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_item_index` **(** :ref:`int` id **)** const | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`get_item_metadata` **(** :ref:`int` idx **)** const | +| :ref:`Variant` | :ref:`get_item_metadata` **(** :ref:`int` idx **)** const | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`ShortCut` | :ref:`get_item_shortcut` **(** :ref:`int` idx **)** const | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -61,6 +61,8 @@ Member Functions +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_item_tooltip` **(** :ref:`int` idx **)** const | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_hide_on_checkable_item_selection` **(** **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_hide_on_item_selection` **(** **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_item_checkable` **(** :ref:`int` idx **)** const | @@ -73,6 +75,8 @@ Member Functions +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_item` **(** :ref:`int` idx **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_hide_on_checkable_item_selection` **(** :ref:`bool` enable **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_hide_on_item_selection` **(** :ref:`bool` enable **)** | +----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_ID` **(** :ref:`int` idx, :ref:`int` id **)** | @@ -115,6 +119,7 @@ This event is emitted when an item of some index is pressed or its accelerator i Member Variables ---------------- +- :ref:`bool` **hide_on_checkable_item_selection** - :ref:`bool` **hide_on_item_selection** - :ref:`Array` **items** @@ -216,7 +221,7 @@ Find and return the index of the item containing a given id. .. _class_PopupMenu_get_item_metadata: -- void **get_item_metadata** **(** :ref:`int` idx **)** const +- :ref:`Variant` **get_item_metadata** **(** :ref:`int` idx **)** const Return the metadata of an item, which might be of any type. You can set it with :ref:`set_item_metadata`, which provides a simple way of assigning context data to items. @@ -240,6 +245,12 @@ Return the text of the item at index "idx". - :ref:`String` **get_item_tooltip** **(** :ref:`int` idx **)** const +.. _class_PopupMenu_is_hide_on_checkable_item_selection: + +- :ref:`bool` **is_hide_on_checkable_item_selection** **(** **)** + +Returns a boolean that indicates whether or not the PopupMenu will hide on checkable item selection. + .. _class_PopupMenu_is_hide_on_item_selection: - :ref:`bool` **is_hide_on_item_selection** **(** **)** @@ -276,6 +287,12 @@ Return whether the item is a seperator. If it is, it would be displayed as a lin Removes the item at index "idx" from the menu. Note that the indexes of items after the removed item are going to be shifted by one. +.. _class_PopupMenu_set_hide_on_checkable_item_selection: + +- void **set_hide_on_checkable_item_selection** **(** :ref:`bool` enable **)** + +Sets whether or not the PopupMenu will hide on checkable item selection. + .. _class_PopupMenu_set_hide_on_item_selection: - void **set_hide_on_item_selection** **(** :ref:`bool` enable **)** diff --git a/classes/class_projectsettings.rst b/classes/class_projectsettings.rst new file mode 100644 index 000000000..12624a59e --- /dev/null +++ b/classes/class_projectsettings.rst @@ -0,0 +1,150 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. + +.. _class_ProjectSettings: + +ProjectSettings +=============== + +**Inherits:** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + +Contains global variables accessible from everywhere. + +Member Functions +---------------- + ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_property_info` **(** :ref:`Dictionary` hint **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** :ref:`String` name **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_order` **(** :ref:`String` name **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`get_singleton` **(** :ref:`String` name **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`globalize_path` **(** :ref:`String` path **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has` **(** :ref:`String` name **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_singleton` **(** :ref:`String` name **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`load_resource_pack` **(** :ref:`String` pack **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`localize_path` **(** :ref:`String` path **)** const | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`property_can_revert` **(** :ref:`String` name **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`property_get_revert` **(** :ref:`String` name **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`save` **(** **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`save_custom` **(** :ref:`String` file **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_initial_value` **(** :ref:`String` name, :ref:`Variant` value **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_order` **(** :ref:`String` name, :ref:`int` pos **)** | ++--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Description +----------- + +Contains global variables accessible from everywhere. Use the normal :ref:`Object` API, such as "ProjectSettings.get(variable)", "ProjectSettings.set(variable,value)" or "ProjectSettings.has(variable)" to access them. Variables stored in project.godot are also loaded into ProjectSettings, making this object very useful for reading custom game configuration options. + +Member Function Description +--------------------------- + +.. _class_ProjectSettings_add_property_info: + +- 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:`@Global Scope`), and optionally hint::ref:`int`(see PROPERTY_HINT\_\* in :ref:`@Global Scope`), hint_string::ref:`String`. + +Example: + +:: + + ProjectSettings.set("category/property_name", 0) + + var property_info = { + "name": "category/property_name", + "type": TYPE_INT, + "hint": PROPERTY_HINT_ENUM, + "hint_string": "one,two,three" + } + + ProjectSettings.add_property_info(property_info) + +.. _class_ProjectSettings_clear: + +- void **clear** **(** :ref:`String` name **)** + +Clear the whole configuration (not recommended, may break things). + +.. _class_ProjectSettings_get_order: + +- :ref:`int` **get_order** **(** :ref:`String` name **)** const + +Return the order of a configuration value (influences when saved to the config file). + +.. _class_ProjectSettings_get_singleton: + +- :ref:`Object` **get_singleton** **(** :ref:`String` name **)** const + +.. _class_ProjectSettings_globalize_path: + +- :ref:`String` **globalize_path** **(** :ref:`String` path **)** const + +Convert a localized path (res://) to a full native OS path. + +.. _class_ProjectSettings_has: + +- :ref:`bool` **has** **(** :ref:`String` name **)** const + +Return true if a configuration value is present. + +.. _class_ProjectSettings_has_singleton: + +- :ref:`bool` **has_singleton** **(** :ref:`String` name **)** const + +.. _class_ProjectSettings_load_resource_pack: + +- :ref:`bool` **load_resource_pack** **(** :ref:`String` pack **)** + +.. _class_ProjectSettings_localize_path: + +- :ref:`String` **localize_path** **(** :ref:`String` path **)** const + +Convert a path to a localized path (res:// path). + +.. _class_ProjectSettings_property_can_revert: + +- :ref:`bool` **property_can_revert** **(** :ref:`String` name **)** + +.. _class_ProjectSettings_property_get_revert: + +- :ref:`Variant` **property_get_revert** **(** :ref:`String` name **)** + +.. _class_ProjectSettings_save: + +- :ref:`int` **save** **(** **)** + +.. _class_ProjectSettings_save_custom: + +- :ref:`int` **save_custom** **(** :ref:`String` file **)** + +.. _class_ProjectSettings_set_initial_value: + +- void **set_initial_value** **(** :ref:`String` name, :ref:`Variant` value **)** + +.. _class_ProjectSettings_set_order: + +- void **set_order** **(** :ref:`String` name, :ref:`int` pos **)** + +Set the order of a configuration value (influences when saved to the config file). + + diff --git a/classes/class_rect2.rst b/classes/class_rect2.rst index bf539abe7..e5c667a6d 100644 --- a/classes/class_rect2.rst +++ b/classes/class_rect2.rst @@ -48,7 +48,7 @@ Member Variables ---------------- - :ref:`Vector2` **end** - Ending corner. -- :ref:`Vector2` **position** +- :ref:`Vector2` **position** - Position (starting corner). - :ref:`Vector2` **size** - Size from position to end. Description diff --git a/classes/class_rect3.rst b/classes/class_rect3.rst index ae78946a1..aaf38c553 100644 --- a/classes/class_rect3.rst +++ b/classes/class_rect3.rst @@ -64,7 +64,7 @@ Member Variables ---------------- - :ref:`Vector3` **end** - Ending corner. -- :ref:`Vector3` **pos** - Position (starting corner). +- :ref:`Vector3` **position** - :ref:`Vector3` **size** - Size from position to end. Description @@ -175,7 +175,7 @@ Return true if the :ref:`Rect3` contains a point. - :ref:`Rect3` **intersection** **(** :ref:`Rect3` with **)** -Return the intersection between two :ref:`Rect3`. An empty AABB (size 0,0,0) is returned on failure. +Return the intersection between two :ref:`Rect3`. An empty Rect3 (size 0,0,0) is returned on failure. .. _class_Rect3_intersects: diff --git a/classes/class_reference.rst b/classes/class_reference.rst index 1fa2225ab..035d7f617 100644 --- a/classes/class_reference.rst +++ b/classes/class_reference.rst @@ -8,7 +8,7 @@ Reference **Inherits:** :ref:`Object` -**Inherited By:** :ref:`RegExMatch`, :ref:`SurfaceTool`, :ref:`SpatialGizmo`, :ref:`TriangleMesh`, :ref:`PhysicsShapeQueryResult`, :ref:`Physics2DTestMotionResult`, :ref:`FuncRef`, :ref:`Marshalls`, :ref:`File`, :ref:`TCP_Server`, :ref:`Physics2DShapeQueryResult`, :ref:`ConfigFile`, :ref:`StreamPeer`, :ref:`HTTPClient`, :ref:`AudioStreamPlayback`, :ref:`VisualScriptFunctionState`, :ref:`GDFunctionState`, :ref:`EditorResourcePreviewGenerator`, :ref:`Physics2DShapeQueryParameters`, :ref:`EditorScript`, :ref:`Mutex`, :ref:`PacketPeer`, :ref:`Semaphore`, :ref:`XMLParser`, :ref:`EditorImportPlugin`, :ref:`Directory`, :ref:`AStar`, :ref:`SceneState`, :ref:`GDNativeClass`, :ref:`PCKPacker`, :ref:`MeshDataTool`, :ref:`WeakRef`, :ref:`ResourceImporter`, :ref:`Resource`, :ref:`SceneTreeTimer`, :ref:`Thread`, :ref:`PackedDataContainerRef`, :ref:`ResourceInteractiveLoader`, :ref:`PhysicsShapeQueryParameters` +**Inherited By:** :ref:`RegExMatch`, :ref:`SurfaceTool`, :ref:`SpatialGizmo`, :ref:`TriangleMesh`, :ref:`PhysicsShapeQueryResult`, :ref:`Physics2DTestMotionResult`, :ref:`FuncRef`, :ref:`Marshalls`, :ref:`File`, :ref:`TCP_Server`, :ref:`Physics2DShapeQueryResult`, :ref:`ConfigFile`, :ref:`StreamPeer`, :ref:`HTTPClient`, :ref:`AudioStreamPlayback`, :ref:`VisualScriptFunctionState`, :ref:`GDFunctionState`, :ref:`SpatialVelocityTracker`, :ref:`EditorResourcePreviewGenerator`, :ref:`Physics2DShapeQueryParameters`, :ref:`EditorScript`, :ref:`Mutex`, :ref:`PacketPeer`, :ref:`Semaphore`, :ref:`XMLParser`, :ref:`EditorImportPlugin`, :ref:`Directory`, :ref:`AStar`, :ref:`SceneState`, :ref:`GDNativeClass`, :ref:`PCKPacker`, :ref:`MeshDataTool`, :ref:`WeakRef`, :ref:`ResourceImporter`, :ref:`Resource`, :ref:`SceneTreeTimer`, :ref:`Thread`, :ref:`PackedDataContainerRef`, :ref:`ResourceInteractiveLoader`, :ref:`PhysicsShapeQueryParameters` **Category:** Core diff --git a/classes/class_regex.rst b/classes/class_regex.rst index ce214162a..c8f0699c8 100644 --- a/classes/class_regex.rst +++ b/classes/class_regex.rst @@ -18,23 +18,23 @@ Simple regular expression matcher. Member Functions ---------------- -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`compile` **(** :ref:`String` pattern **)** | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_group_count` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_names` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_pattern` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_valid` **(** **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`search` **(** :ref:`String` text, :ref:`int` start=0, :ref:`int` end=-1 **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`sub` **(** :ref:`String` text, :ref:`String` replacement, :ref:`bool` all=false, :ref:`int` start=0, :ref:`int` end=-1 **)** const | -+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`compile` **(** :ref:`String` pattern **)** | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_group_count` **(** **)** const | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_names` **(** **)** const | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_pattern` **(** **)** const | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid` **(** **)** const | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RegExMatch` | :ref:`search` **(** :ref:`String` text, :ref:`int` start=0, :ref:`int` end=-1 **)** const | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`sub` **(** :ref:`String` text, :ref:`String` replacement, :ref:`bool` all=false, :ref:`int` start=0, :ref:`int` end=-1 **)** const | ++--------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- @@ -56,9 +56,9 @@ would be read by RegEx as ``\d+`` Similarly: -``exp.compile("\"(?:\\\\.|:ref:`^\"`)\*\"")`` +``exp.compile("\"(?:\\\\.|[^\"])\*\"")`` -would be read as ``"(?:\\.|:ref:`^"`)\*"`` +would be read as ``"(?:\\.|[^"])\*"`` Currently supported features: @@ -70,7 +70,7 @@ Currently supported features: \* Shorthand character classes ``\w \W \s \S \d \D`` -\* User-defined character classes such as ``:ref:`A-Za-z``` +\* User-defined character classes such as ``[A-Za-z]`` \* Simple quantifiers ``?``, ``\*`` and ``+`` @@ -84,7 +84,7 @@ Currently supported features: \* Backreferences ``\1``, ``\g{1}``, and ``\g`` -\* POSIX character classes ``:ref:`[:alnum:`]`` +\* POSIX character classes ``[[:alnum:]]`` \* Lookahead ``(?=)``, ``(?!)`` and lookbehind ``(?<=)``, ``(?` **search** **(** :ref:`String` text, :ref:`int` start=0, :ref:`int` end=-1 **)** const +- :ref:`RegExMatch` **search** **(** :ref:`String` text, :ref:`int` start=0, :ref:`int` end=-1 **)** const Searches the text for the compiled pattern. Returns a :ref:`RegExMatch` container of the first matching reult if found, otherwise null. The region to search within can be specified without modifying where the start and end anchor would be. diff --git a/classes/class_remotetransform.rst b/classes/class_remotetransform.rst index 59e66215e..09b7e0745 100644 --- a/classes/class_remotetransform.rst +++ b/classes/class_remotetransform.rst @@ -18,16 +18,36 @@ Brief Description Member Functions ---------------- -+----------------------------------+------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_remote_node` **(** **)** const | -+----------------------------------+------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_remote_node` **(** :ref:`NodePath` path **)** | -+----------------------------------+------------------------------------------------------------------------------------------------------------------+ ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_remote_node` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_update_position` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_update_rotation` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_update_scale` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_use_global_coordinates` **(** **)** const | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_remote_node` **(** :ref:`NodePath` path **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_update_position` **(** :ref:`bool` update_remote_position **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_update_rotation` **(** :ref:`bool` update_remote_rotation **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_update_scale` **(** :ref:`bool` update_remote_scale **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_global_coordinates` **(** :ref:`bool` use_global_coordinates **)** | ++----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- - :ref:`NodePath` **remote_path** +- :ref:`bool` **update_position** +- :ref:`bool` **update_rotation** +- :ref:`bool` **update_scale** +- :ref:`bool` **use_global_coordinates** Member Function Description --------------------------- @@ -36,8 +56,40 @@ Member Function Description - :ref:`NodePath` **get_remote_node** **(** **)** const +.. _class_RemoteTransform_get_update_position: + +- :ref:`bool` **get_update_position** **(** **)** const + +.. _class_RemoteTransform_get_update_rotation: + +- :ref:`bool` **get_update_rotation** **(** **)** const + +.. _class_RemoteTransform_get_update_scale: + +- :ref:`bool` **get_update_scale** **(** **)** const + +.. _class_RemoteTransform_get_use_global_coordinates: + +- :ref:`bool` **get_use_global_coordinates** **(** **)** const + .. _class_RemoteTransform_set_remote_node: - void **set_remote_node** **(** :ref:`NodePath` path **)** +.. _class_RemoteTransform_set_update_position: + +- void **set_update_position** **(** :ref:`bool` update_remote_position **)** + +.. _class_RemoteTransform_set_update_rotation: + +- void **set_update_rotation** **(** :ref:`bool` update_remote_rotation **)** + +.. _class_RemoteTransform_set_update_scale: + +- void **set_update_scale** **(** :ref:`bool` update_remote_scale **)** + +.. _class_RemoteTransform_set_use_global_coordinates: + +- void **set_use_global_coordinates** **(** :ref:`bool` use_global_coordinates **)** + diff --git a/classes/class_remotetransform2d.rst b/classes/class_remotetransform2d.rst index a9db83c34..13732f105 100644 --- a/classes/class_remotetransform2d.rst +++ b/classes/class_remotetransform2d.rst @@ -18,16 +18,36 @@ Brief Description Member Functions ---------------- -+----------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| :ref:`NodePath` | :ref:`get_remote_node` **(** **)** const | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_remote_node` **(** :ref:`NodePath` path **)** | -+----------------------------------+--------------------------------------------------------------------------------------------------------------------+ ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NodePath` | :ref:`get_remote_node` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_update_position` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_update_rotation` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_update_scale` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_use_global_coordinates` **(** **)** const | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_remote_node` **(** :ref:`NodePath` path **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_update_position` **(** :ref:`bool` update_remote_position **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_update_rotation` **(** :ref:`bool` update_remote_rotation **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_update_scale` **(** :ref:`bool` update_remote_scale **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_global_coordinates` **(** :ref:`bool` use_global_coordinates **)** | ++----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- - :ref:`NodePath` **remote_path** +- :ref:`bool` **update_position** +- :ref:`bool` **update_rotation** +- :ref:`bool` **update_scale** +- :ref:`bool` **use_global_coordinates** Member Function Description --------------------------- @@ -36,8 +56,40 @@ Member Function Description - :ref:`NodePath` **get_remote_node** **(** **)** const +.. _class_RemoteTransform2D_get_update_position: + +- :ref:`bool` **get_update_position** **(** **)** const + +.. _class_RemoteTransform2D_get_update_rotation: + +- :ref:`bool` **get_update_rotation** **(** **)** const + +.. _class_RemoteTransform2D_get_update_scale: + +- :ref:`bool` **get_update_scale** **(** **)** const + +.. _class_RemoteTransform2D_get_use_global_coordinates: + +- :ref:`bool` **get_use_global_coordinates** **(** **)** const + .. _class_RemoteTransform2D_set_remote_node: - void **set_remote_node** **(** :ref:`NodePath` path **)** +.. _class_RemoteTransform2D_set_update_position: + +- void **set_update_position** **(** :ref:`bool` update_remote_position **)** + +.. _class_RemoteTransform2D_set_update_rotation: + +- void **set_update_rotation** **(** :ref:`bool` update_remote_rotation **)** + +.. _class_RemoteTransform2D_set_update_scale: + +- void **set_update_scale** **(** :ref:`bool` update_remote_scale **)** + +.. _class_RemoteTransform2D_set_use_global_coordinates: + +- void **set_use_global_coordinates** **(** :ref:`bool` use_global_coordinates **)** + diff --git a/classes/class_resource.rst b/classes/class_resource.rst index 8b1e1b124..424b0b798 100644 --- a/classes/class_resource.rst +++ b/classes/class_resource.rst @@ -8,7 +8,7 @@ Resource **Inherits:** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`Theme`, :ref:`AudioStream`, :ref:`Sky`, :ref:`CubeMap`, :ref:`DynamicFontData`, :ref:`SpriteFrames`, :ref:`Translation`, :ref:`Curve2D`, :ref:`Shape`, :ref:`Shape2D`, :ref:`StyleBox`, :ref:`GDNativeLibrary`, :ref:`Material`, :ref:`VideoStream`, :ref:`RoomBounds`, :ref:`Texture`, :ref:`PackedScene`, :ref:`OccluderPolygon2D`, :ref:`Mesh`, :ref:`ButtonGroup`, :ref:`TileSet`, :ref:`ShortCut`, :ref:`BitMap`, :ref:`Animation`, :ref:`Script`, :ref:`PolygonPathFinder`, :ref:`Shader`, :ref:`AudioBusLayout`, :ref:`World`, :ref:`RegEx`, :ref:`AudioEffect`, :ref:`VisualScriptNode`, :ref:`World2D`, :ref:`GIProbeData`, :ref:`Font`, :ref:`MeshLibrary`, :ref:`Curve3D`, :ref:`NavigationPolygon`, :ref:`InputEvent`, :ref:`EditorSettings`, :ref:`Image`, :ref:`Gradient`, :ref:`Environment`, :ref:`MultiMesh`, :ref:`PackedDataContainer`, :ref:`NavigationMesh` +**Inherited By:** :ref:`Theme`, :ref:`AudioStream`, :ref:`Sky`, :ref:`CubeMap`, :ref:`DynamicFontData`, :ref:`SpriteFrames`, :ref:`Translation`, :ref:`Curve2D`, :ref:`Shape`, :ref:`Shape2D`, :ref:`Curve`, :ref:`StyleBox`, :ref:`GDNativeLibrary`, :ref:`Material`, :ref:`VideoStream`, :ref:`RoomBounds`, :ref:`Texture`, :ref:`PackedScene`, :ref:`OccluderPolygon2D`, :ref:`Mesh`, :ref:`ButtonGroup`, :ref:`TileSet`, :ref:`ShortCut`, :ref:`BitMap`, :ref:`Animation`, :ref:`Script`, :ref:`PolygonPathFinder`, :ref:`Shader`, :ref:`AudioBusLayout`, :ref:`World`, :ref:`RegEx`, :ref:`AudioEffect`, :ref:`VisualScriptNode`, :ref:`World2D`, :ref:`GIProbeData`, :ref:`Font`, :ref:`MeshLibrary`, :ref:`Curve3D`, :ref:`NavigationPolygon`, :ref:`InputEvent`, :ref:`EditorSettings`, :ref:`Image`, :ref:`Gradient`, :ref:`Environment`, :ref:`MultiMesh`, :ref:`PackedDataContainer`, :ref:`NavigationMesh` **Category:** Core diff --git a/classes/class_richtextlabel.rst b/classes/class_richtextlabel.rst index 28cfdf08c..367e9f83b 100644 --- a/classes/class_richtextlabel.rst +++ b/classes/class_richtextlabel.rst @@ -18,83 +18,89 @@ Label that displays rich text. Member Functions ---------------- -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_image` **(** :ref:`Texture` image **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_text` **(** :ref:`String` text **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`append_bbcode` **(** :ref:`String` bbcode **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_bbcode` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_tab_size` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_text` **(** **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_total_character_count` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`get_v_scroll` **(** **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_visible_characters` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_meta_underlined` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_scroll_active` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_scroll_following` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_selection_enabled` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_using_bbcode` **(** **)** const | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`newline` **(** **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`parse_bbcode` **(** :ref:`String` bbcode **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`pop` **(** **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_align` **(** :ref:`int` align **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_cell` **(** **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_color` **(** :ref:`Color` color **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_font` **(** :ref:`Object` font **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_indent` **(** :ref:`int` level **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_list` **(** :ref:`int` type **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_meta` **(** :ref:`Variant` data **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_table` **(** :ref:`int` columns **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`push_underline` **(** **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`remove_line` **(** :ref:`int` arg0 **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`scroll_to_line` **(** :ref:`int` line **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bbcode` **(** :ref:`String` text **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_meta_underline` **(** :ref:`bool` enable **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_scroll_active` **(** :ref:`bool` active **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_scroll_follow` **(** :ref:`bool` follow **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_selection_enabled` **(** :ref:`bool` enabled **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_tab_size` **(** :ref:`int` spaces **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_table_column_expand` **(** :ref:`int` column, :ref:`bool` expand, :ref:`int` ratio **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_use_bbcode` **(** :ref:`bool` enable **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_visible_characters` **(** :ref:`int` amount **)** | -+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_image` **(** :ref:`Texture` image **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_text` **(** :ref:`String` text **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`append_bbcode` **(** :ref:`String` bbcode **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_bbcode` **(** **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_percent_visible` **(** **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_tab_size` **(** **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_text` **(** **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_total_character_count` **(** **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`VScrollBar` | :ref:`get_v_scroll` **(** **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_visible_characters` **(** **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_meta_underlined` **(** **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_scroll_active` **(** **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_scroll_following` **(** **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_selection_enabled` **(** **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_using_bbcode` **(** **)** const | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`newline` **(** **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`parse_bbcode` **(** :ref:`String` bbcode **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`pop` **(** **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_align` **(** :ref:`int` align **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_cell` **(** **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_color` **(** :ref:`Color` color **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_font` **(** :ref:`Font` font **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_indent` **(** :ref:`int` level **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_list` **(** :ref:`int` type **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_meta` **(** :ref:`Variant` data **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_table` **(** :ref:`int` columns **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`push_underline` **(** **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`remove_line` **(** :ref:`int` arg0 **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`scroll_to_line` **(** :ref:`int` line **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bbcode` **(** :ref:`String` text **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_meta_underline` **(** :ref:`bool` enable **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_percent_visible` **(** :ref:`float` percent_visible **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_scroll_active` **(** :ref:`bool` active **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_scroll_follow` **(** :ref:`bool` follow **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_selection_enabled` **(** :ref:`bool` enabled **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_tab_size` **(** :ref:`int` spaces **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_table_column_expand` **(** :ref:`int` column, :ref:`bool` expand, :ref:`int` ratio **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_text` **(** :ref:`String` text **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_use_bbcode` **(** :ref:`bool` enable **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_visible_characters` **(** :ref:`int` amount **)** | ++--------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -106,6 +112,7 @@ Member Variables - :ref:`bool` **bbcode_enabled** - :ref:`String` **bbcode_text** +- :ref:`float` **percent_visible** - :ref:`int` **visible_characters** Numeric Constants @@ -158,6 +165,10 @@ Member Function Description - :ref:`String` **get_bbcode** **(** **)** const +.. _class_RichTextLabel_get_percent_visible: + +- :ref:`float` **get_percent_visible** **(** **)** const + .. _class_RichTextLabel_get_tab_size: - :ref:`int` **get_tab_size** **(** **)** const @@ -174,7 +185,7 @@ Returns the raw text, stripping out the formatting information. .. _class_RichTextLabel_get_v_scroll: -- :ref:`Object` **get_v_scroll** **(** **)** +- :ref:`VScrollBar` **get_v_scroll** **(** **)** .. _class_RichTextLabel_get_visible_characters: @@ -228,7 +239,7 @@ Return true if selecting the text inside this richtext is allowed. .. _class_RichTextLabel_push_font: -- void **push_font** **(** :ref:`Object` font **)** +- void **push_font** **(** :ref:`Font` font **)** .. _class_RichTextLabel_push_indent: @@ -266,6 +277,10 @@ Return true if selecting the text inside this richtext is allowed. - void **set_meta_underline** **(** :ref:`bool` enable **)** +.. _class_RichTextLabel_set_percent_visible: + +- void **set_percent_visible** **(** :ref:`float` percent_visible **)** + .. _class_RichTextLabel_set_scroll_active: - void **set_scroll_active** **(** :ref:`bool` active **)** @@ -288,6 +303,10 @@ Set to true if selecting the text inside this richtext is allowed. - void **set_table_column_expand** **(** :ref:`int` column, :ref:`bool` expand, :ref:`int` ratio **)** +.. _class_RichTextLabel_set_text: + +- void **set_text** **(** :ref:`String` text **)** + .. _class_RichTextLabel_set_use_bbcode: - void **set_use_bbcode** **(** :ref:`bool` enable **)** diff --git a/classes/class_scenestate.rst b/classes/class_scenestate.rst index 12100a28a..e047f5370 100644 --- a/classes/class_scenestate.rst +++ b/classes/class_scenestate.rst @@ -51,7 +51,7 @@ Member Functions +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_node_property_name` **(** :ref:`int` idx, :ref:`int` prop_idx **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`get_node_property_value` **(** :ref:`int` idx, :ref:`int` prop_idx **)** const | +| :ref:`Variant` | :ref:`get_node_property_value` **(** :ref:`int` idx, :ref:`int` prop_idx **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_node_type` **(** :ref:`int` idx **)** const | +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -134,7 +134,7 @@ Member Function Description .. _class_SceneState_get_node_property_value: -- void **get_node_property_value** **(** :ref:`int` idx, :ref:`int` prop_idx **)** const +- :ref:`Variant` **get_node_property_value** **(** :ref:`int` idx, :ref:`int` prop_idx **)** const .. _class_SceneState_get_node_type: diff --git a/classes/class_scenetree.rst b/classes/class_scenetree.rst index 69cbc7572..cdc92ee68 100644 --- a/classes/class_scenetree.rst +++ b/classes/class_scenetree.rst @@ -35,6 +35,8 @@ Member Functions +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_frame` **(** **)** const | +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PoolIntArray` | :ref:`get_network_connected_peers` **(** **)** const | ++----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_network_unique_id` **(** **)** const | +----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_node_count` **(** **)** const | @@ -164,6 +166,10 @@ Member Function Description - :ref:`int` **get_frame** **(** **)** const +.. _class_SceneTree_get_network_connected_peers: + +- :ref:`PoolIntArray` **get_network_connected_peers** **(** **)** const + .. _class_SceneTree_get_network_unique_id: - :ref:`int` **get_network_unique_id** **(** **)** const diff --git a/classes/class_scripteditor.rst b/classes/class_scripteditor.rst new file mode 100644 index 000000000..a366fc637 --- /dev/null +++ b/classes/class_scripteditor.rst @@ -0,0 +1,52 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. + +.. _class_ScriptEditor: + +ScriptEditor +============ + +**Inherits:** :ref:`PanelContainer` **<** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------------+-------------------------------------------------------------------------------+ +| :ref:`Script` | :ref:`get_current_script` **(** **)** | ++------------------------------+-------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_open_scripts` **(** **)** | ++------------------------------+-------------------------------------------------------------------------------+ + +Signals +------- + +- **editor_script_changed** **(** :ref:`Script` script **)** +Emitted when user changed active script. Argument is a freshly activated :ref:`Script`. + +- **script_close** **(** :ref:`Script` script **)** +Emitted when editor is about to close the active script. Argument is a :ref:`Script` that is going to be closed. + + +Member Function Description +--------------------------- + +.. _class_ScriptEditor_get_current_script: + +- :ref:`Script` **get_current_script** **(** **)** + +Returns a :ref:`Script` that is currently active in editor. + +.. _class_ScriptEditor_get_open_scripts: + +- :ref:`Array` **get_open_scripts** **(** **)** + +Returns an array with all :ref:`Script` objects which are currently open in editor. + + diff --git a/classes/class_scrollcontainer.rst b/classes/class_scrollcontainer.rst index 93d7b3d20..9cf95653e 100644 --- a/classes/class_scrollcontainer.rst +++ b/classes/class_scrollcontainer.rst @@ -45,7 +45,7 @@ Member Variables Description ----------- -A ScrollContainer node with a :ref:`Control` child and scrollbar child (:ref:`HScrollbar`, :ref:`VScrollBar`, or both) will only draw the Control within the ScrollContainer area. Scrollbars will automatically be drawn at the right (for vertical) or bottom (for horizontal) and will enable dragging to move the viewable Control (and its children) within the ScrollContainer. Scrollbars will also automatically resize the grabber based on the minimum_size of the Control relative to the ScrollContainer. Works great with a :ref:`Panel` control. You can set EXPAND on children size flags, so they will upscale to ScrollContainer size if ScrollContainer size is bigger (scroll is invisible for chosen dimension). +A ScrollContainer node with a :ref:`Control` child and scrollbar child (HScrollbar, :ref:`VScrollBar`, or both) will only draw the Control within the ScrollContainer area. Scrollbars will automatically be drawn at the right (for vertical) or bottom (for horizontal) and will enable dragging to move the viewable Control (and its children) within the ScrollContainer. Scrollbars will also automatically resize the grabber based on the minimum_size of the Control relative to the ScrollContainer. Works great with a :ref:`Panel` control. You can set EXPAND on children size flags, so they will upscale to ScrollContainer size if ScrollContainer size is bigger (scroll is invisible for chosen dimension). Member Function Description --------------------------- diff --git a/classes/class_shadermaterial.rst b/classes/class_shadermaterial.rst index faacca914..8b4928f9e 100644 --- a/classes/class_shadermaterial.rst +++ b/classes/class_shadermaterial.rst @@ -18,15 +18,15 @@ Brief Description Member Functions ---------------- -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Shader` | :ref:`get_shader` **(** **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`get_shader_param` **(** :ref:`String` param **)** const | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shader` **(** :ref:`Shader` shader **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shader_param` **(** :ref:`String` param, :ref:`Variant` value **)** | -+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Shader` | :ref:`get_shader` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_shader_param` **(** :ref:`String` param **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shader` **(** :ref:`Shader` shader **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shader_param` **(** :ref:`String` param, :ref:`Variant` value **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ Member Function Description --------------------------- @@ -37,7 +37,7 @@ Member Function Description .. _class_ShaderMaterial_get_shader_param: -- void **get_shader_param** **(** :ref:`String` param **)** const +- :ref:`Variant` **get_shader_param** **(** :ref:`String` param **)** const .. _class_ShaderMaterial_set_shader: diff --git a/classes/class_shape.rst b/classes/class_shape.rst index 1fdd856b1..7d9e354de 100644 --- a/classes/class_shape.rst +++ b/classes/class_shape.rst @@ -8,7 +8,7 @@ Shape **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`SphereShape`, :ref:`CapsuleShape`, :ref:`BoxShape`, :ref:`ConvexPolygonShape`, :ref:`PlaneShape`, :ref:`RayShape`, :ref:`ConcavePolygonShape` +**Inherited By:** :ref:`SphereShape`, :ref:`PlaneShape`, :ref:`CapsuleShape`, :ref:`BoxShape`, :ref:`ConvexPolygonShape`, :ref:`RayShape`, :ref:`ConcavePolygonShape` **Category:** Core diff --git a/classes/class_slider.rst b/classes/class_slider.rst index aebf7951f..f11e89efc 100644 --- a/classes/class_slider.rst +++ b/classes/class_slider.rst @@ -25,6 +25,10 @@ Member Functions +--------------------------+----------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_ticks_on_borders` **(** **)** const | +--------------------------+----------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_editable` **(** **)** const | ++--------------------------+----------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_editable` **(** :ref:`bool` editable **)** | ++--------------------------+----------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_ticks` **(** :ref:`int` count **)** | +--------------------------+----------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_ticks_on_borders` **(** :ref:`bool` ticks_on_border **)** | @@ -33,6 +37,7 @@ Member Functions Member Variables ---------------- +- :ref:`bool` **editable** - :ref:`int` **focus_mode** - :ref:`int` **tick_count** - :ref:`bool` **ticks_on_borders** @@ -57,6 +62,14 @@ Return amounts of ticks to display on slider. Return true if ticks are visible on borders. +.. _class_Slider_is_editable: + +- :ref:`bool` **is_editable** **(** **)** const + +.. _class_Slider_set_editable: + +- void **set_editable** **(** :ref:`bool` editable **)** + .. _class_Slider_set_ticks: - void **set_ticks** **(** :ref:`int` count **)** diff --git a/classes/class_spatial.rst b/classes/class_spatial.rst index c7f32dcc3..422ef6839 100644 --- a/classes/class_spatial.rst +++ b/classes/class_spatial.rst @@ -8,7 +8,7 @@ Spatial **Inherits:** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`Joint`, :ref:`RayCast`, :ref:`Camera`, :ref:`BoneAttachment`, :ref:`CollisionShape`, :ref:`Path`, :ref:`VisualInstance`, :ref:`VehicleWheel`, :ref:`Position3D`, :ref:`ProximityGroup`, :ref:`RemoteTransform`, :ref:`CollisionObject`, :ref:`WorldEnvironment`, :ref:`Listener`, :ref:`PathFollow`, :ref:`NavigationMeshInstance`, :ref:`VisibilityNotifier`, :ref:`Navigation`, :ref:`CollisionPolygon`, :ref:`GridMap`, :ref:`Skeleton` +**Inherited By:** :ref:`Joint`, :ref:`RayCast`, :ref:`Camera`, :ref:`BoneAttachment`, :ref:`CollisionShape`, :ref:`AudioStreamPlayer3D`, :ref:`Path`, :ref:`VisualInstance`, :ref:`VehicleWheel`, :ref:`Position3D`, :ref:`ProximityGroup`, :ref:`RemoteTransform`, :ref:`CollisionObject`, :ref:`Listener`, :ref:`PathFollow`, :ref:`NavigationMeshInstance`, :ref:`VisibilityNotifier`, :ref:`Navigation`, :ref:`CollisionPolygon`, :ref:`GridMap`, :ref:`Skeleton` **Category:** Core diff --git a/classes/class_spatialmaterial.rst b/classes/class_spatialmaterial.rst index 007998d78..b97e0fd51 100644 --- a/classes/class_spatialmaterial.rst +++ b/classes/class_spatialmaterial.rst @@ -55,6 +55,8 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_flag` **(** :ref:`int` arg0 **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_grow` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_line_width` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_metallic` **(** **)** const | @@ -79,20 +81,28 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_specular` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_specular_mode` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_subsurface_scattering_strength` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture` | :ref:`get_texture` **(** :ref:`Texture` param **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_uv1_offset` **(** **)** const | +| :ref:`Vector3` | :ref:`get_uv1_offset` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_uv1_scale` **(** **)** const | +| :ref:`Vector3` | :ref:`get_uv1_scale` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_uv2_offset` **(** **)** const | +| :ref:`float` | :ref:`get_uv1_triplanar_blend_sharpness` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_uv2_scale` **(** **)** const | +| :ref:`Vector3` | :ref:`get_uv2_offset` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_uv2_scale` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_uv2_triplanar_blend_sharpness` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_depth_deep_parallax_enabled` **(** **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_grow_enabled` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_albedo` **(** :ref:`Color` albedo **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_anisotropy` **(** :ref:`float` anisotropy **)** | @@ -131,6 +141,10 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_flag` **(** :ref:`int` flag, :ref:`bool` enable **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_grow` **(** :ref:`float` amount **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_grow_enabled` **(** :ref:`bool` enable **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_line_width` **(** :ref:`float` line_width **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_metallic` **(** :ref:`float` metallic **)** | @@ -155,17 +169,23 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_specular` **(** :ref:`float` specular **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_specular_mode` **(** :ref:`int` specular_mode **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_subsurface_scattering_strength` **(** :ref:`float` strength **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_texture` **(** :ref:`Texture` param, :ref:`Object` texture **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_uv1_offset` **(** :ref:`Vector2` offset **)** | +| void | :ref:`set_uv1_offset` **(** :ref:`Vector3` offset **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_uv1_scale` **(** :ref:`Vector2` scale **)** | +| void | :ref:`set_uv1_scale` **(** :ref:`Vector3` scale **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_uv2_offset` **(** :ref:`Vector2` offset **)** | +| void | :ref:`set_uv1_triplanar_blend_sharpness` **(** :ref:`float` sharpness **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_uv2_scale` **(** :ref:`Vector2` scale **)** | +| void | :ref:`set_uv2_offset` **(** :ref:`Vector3` offset **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_uv2_scale` **(** :ref:`Vector3` scale **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_uv2_triplanar_blend_sharpness` **(** :ref:`float` sharpness **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ Member Variables @@ -173,12 +193,13 @@ Member Variables - :ref:`Color` **albedo_color** - :ref:`Texture` **albedo_texture** -- :ref:`float` **anisotropy_anisotropy** +- :ref:`float` **anisotropy** - :ref:`bool` **anisotropy_enabled** - :ref:`Texture` **anisotropy_flowmap** - :ref:`bool` **ao_enabled** +- :ref:`bool` **ao_on_uv2** - :ref:`Texture` **ao_texture** -- :ref:`float` **clearcoat_amount** +- :ref:`float` **clearcoat** - :ref:`bool` **clearcoat_enabled** - :ref:`float` **clearcoat_gloss** - :ref:`Texture` **clearcoat_texture** @@ -194,7 +215,7 @@ Member Variables - :ref:`Texture` **detail_mask** - :ref:`Texture` **detail_normal** - :ref:`int` **detail_uv_layer** -- :ref:`Color` **emission_color** +- :ref:`Color` **emission** - :ref:`bool` **emission_enabled** - :ref:`float` **emission_energy** - :ref:`Texture` **emission_texture** @@ -203,7 +224,7 @@ Member Variables - :ref:`bool` **flags_transparent** - :ref:`bool` **flags_unshaded** - :ref:`bool` **flags_use_point_size** -- :ref:`float` **metallic_amount** +- :ref:`float` **metallic** - :ref:`float` **metallic_specular** - :ref:`Texture` **metallic_texture** - :ref:`bool` **normal_enabled** @@ -214,27 +235,34 @@ Member Variables - :ref:`int` **params_cull_mode** - :ref:`int` **params_depth_draw_mode** - :ref:`int` **params_diffuse_mode** +- :ref:`bool` **params_grow** +- :ref:`float` **params_grow_amount** - :ref:`float` **params_line_width** - :ref:`float` **params_point_size** +- :ref:`int` **params_specular_mode** - :ref:`int` **particles_anim_h_frames** - :ref:`bool` **particles_anim_loop** - :ref:`int` **particles_anim_v_frames** - :ref:`bool` **refraction_enabled** - :ref:`float` **refraction_scale** - :ref:`Texture` **refraction_texture** -- :ref:`float` **rim_amount** +- :ref:`float` **rim** - :ref:`bool` **rim_enabled** - :ref:`Texture` **rim_texture** - :ref:`float` **rim_tint** -- :ref:`float` **roughness_amount** +- :ref:`float` **roughness** - :ref:`Texture` **roughness_texture** - :ref:`bool` **subsurf_scatter_enabled** - :ref:`float` **subsurf_scatter_strength** - :ref:`Texture` **subsurf_scatter_texture** -- :ref:`Vector2` **uv1_offset** -- :ref:`Vector2` **uv1_scale** -- :ref:`Vector2` **uv2_offset** -- :ref:`Vector2` **uv2_scale** +- :ref:`Vector3` **uv1_offset** +- :ref:`Vector3` **uv1_scale** +- :ref:`bool` **uv1_triplanar** +- :ref:`float` **uv1_triplanar_sharpness** +- :ref:`Vector3` **uv2_offset** +- :ref:`Vector3` **uv2_scale** +- :ref:`bool` **uv2_triplanar** +- :ref:`float` **uv2_triplanar_sharpness** - :ref:`bool` **vertex_color_is_srgb** - :ref:`bool` **vertex_color_use_as_albedo** @@ -288,11 +316,17 @@ Numeric Constants - **FLAG_SRGB_VERTEX_COLOR** = **3** - **FLAG_USE_POINT_SIZE** = **4** - **FLAG_FIXED_SIZE** = **5** -- **FLAG_MAX** = **6** +- **FLAG_MAX** = **9** - **DIFFUSE_LAMBERT** = **0** - **DIFFUSE_HALF_LAMBERT** = **1** - **DIFFUSE_OREN_NAYAR** = **2** - **DIFFUSE_BURLEY** = **3** +- **DIFFUSE_TOON** = **4** +- **SPECULAR_SCHLICK_GGX** = **0** +- **SPECULAR_BLINN** = **1** +- **SPECULAR_PHONG** = **2** +- **SPECULAR_TOON** = **3** +- **SPECULAR_DISABLED** = **4** - **BILLBOARD_DISABLED** = **0** - **BILLBOARD_ENABLED** = **1** - **BILLBOARD_FIXED_Y** = **2** @@ -373,6 +407,10 @@ Member Function Description - :ref:`bool` **get_flag** **(** :ref:`int` arg0 **)** const +.. _class_SpatialMaterial_get_grow: + +- :ref:`float` **get_grow** **(** **)** const + .. _class_SpatialMaterial_get_line_width: - :ref:`float` **get_line_width** **(** **)** const @@ -421,6 +459,10 @@ Member Function Description - :ref:`float` **get_specular** **(** **)** const +.. _class_SpatialMaterial_get_specular_mode: + +- :ref:`int` **get_specular_mode** **(** **)** const + .. _class_SpatialMaterial_get_subsurface_scattering_strength: - :ref:`float` **get_subsurface_scattering_strength** **(** **)** const @@ -431,24 +473,36 @@ Member Function Description .. _class_SpatialMaterial_get_uv1_offset: -- :ref:`Vector2` **get_uv1_offset** **(** **)** const +- :ref:`Vector3` **get_uv1_offset** **(** **)** const .. _class_SpatialMaterial_get_uv1_scale: -- :ref:`Vector2` **get_uv1_scale** **(** **)** const +- :ref:`Vector3` **get_uv1_scale** **(** **)** const + +.. _class_SpatialMaterial_get_uv1_triplanar_blend_sharpness: + +- :ref:`float` **get_uv1_triplanar_blend_sharpness** **(** **)** const .. _class_SpatialMaterial_get_uv2_offset: -- :ref:`Vector2` **get_uv2_offset** **(** **)** const +- :ref:`Vector3` **get_uv2_offset** **(** **)** const .. _class_SpatialMaterial_get_uv2_scale: -- :ref:`Vector2` **get_uv2_scale** **(** **)** const +- :ref:`Vector3` **get_uv2_scale** **(** **)** const + +.. _class_SpatialMaterial_get_uv2_triplanar_blend_sharpness: + +- :ref:`float` **get_uv2_triplanar_blend_sharpness** **(** **)** const .. _class_SpatialMaterial_is_depth_deep_parallax_enabled: - :ref:`bool` **is_depth_deep_parallax_enabled** **(** **)** const +.. _class_SpatialMaterial_is_grow_enabled: + +- :ref:`bool` **is_grow_enabled** **(** **)** const + .. _class_SpatialMaterial_set_albedo: - void **set_albedo** **(** :ref:`Color` albedo **)** @@ -525,6 +579,14 @@ Member Function Description - void **set_flag** **(** :ref:`int` flag, :ref:`bool` enable **)** +.. _class_SpatialMaterial_set_grow: + +- void **set_grow** **(** :ref:`float` amount **)** + +.. _class_SpatialMaterial_set_grow_enabled: + +- void **set_grow_enabled** **(** :ref:`bool` enable **)** + .. _class_SpatialMaterial_set_line_width: - void **set_line_width** **(** :ref:`float` line_width **)** @@ -573,6 +635,10 @@ Member Function Description - void **set_specular** **(** :ref:`float` specular **)** +.. _class_SpatialMaterial_set_specular_mode: + +- void **set_specular_mode** **(** :ref:`int` specular_mode **)** + .. _class_SpatialMaterial_set_subsurface_scattering_strength: - void **set_subsurface_scattering_strength** **(** :ref:`float` strength **)** @@ -583,18 +649,26 @@ Member Function Description .. _class_SpatialMaterial_set_uv1_offset: -- void **set_uv1_offset** **(** :ref:`Vector2` offset **)** +- void **set_uv1_offset** **(** :ref:`Vector3` offset **)** .. _class_SpatialMaterial_set_uv1_scale: -- void **set_uv1_scale** **(** :ref:`Vector2` scale **)** +- void **set_uv1_scale** **(** :ref:`Vector3` scale **)** + +.. _class_SpatialMaterial_set_uv1_triplanar_blend_sharpness: + +- void **set_uv1_triplanar_blend_sharpness** **(** :ref:`float` sharpness **)** .. _class_SpatialMaterial_set_uv2_offset: -- void **set_uv2_offset** **(** :ref:`Vector2` offset **)** +- void **set_uv2_offset** **(** :ref:`Vector3` offset **)** .. _class_SpatialMaterial_set_uv2_scale: -- void **set_uv2_scale** **(** :ref:`Vector2` scale **)** +- void **set_uv2_scale** **(** :ref:`Vector3` scale **)** + +.. _class_SpatialMaterial_set_uv2_triplanar_blend_sharpness: + +- void **set_uv2_triplanar_blend_sharpness** **(** :ref:`float` sharpness **)** diff --git a/classes/class_spatialvelocitytracker.rst b/classes/class_spatialvelocitytracker.rst new file mode 100644 index 000000000..b6dd5a65b --- /dev/null +++ b/classes/class_spatialvelocitytracker.rst @@ -0,0 +1,56 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. + +.. _class_SpatialVelocityTracker: + +SpatialVelocityTracker +====================== + +**Inherits:** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`get_tracked_linear_velocity` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_tracking_fixed_step` **(** **)** const | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reset` **(** :ref:`Vector3` position **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_track_fixed_step` **(** :ref:`bool` enable **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`update_position` **(** :ref:`Vector3` position **)** | ++--------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ + +Member Function Description +--------------------------- + +.. _class_SpatialVelocityTracker_get_tracked_linear_velocity: + +- :ref:`Vector3` **get_tracked_linear_velocity** **(** **)** const + +.. _class_SpatialVelocityTracker_is_tracking_fixed_step: + +- :ref:`bool` **is_tracking_fixed_step** **(** **)** const + +.. _class_SpatialVelocityTracker_reset: + +- void **reset** **(** :ref:`Vector3` position **)** + +.. _class_SpatialVelocityTracker_set_track_fixed_step: + +- void **set_track_fixed_step** **(** :ref:`bool` enable **)** + +.. _class_SpatialVelocityTracker_update_position: + +- void **update_position** **(** :ref:`Vector3` position **)** + + diff --git a/classes/class_splitcontainer.rst b/classes/class_splitcontainer.rst index d9e64db3f..cbf7942c8 100644 --- a/classes/class_splitcontainer.rst +++ b/classes/class_splitcontainer.rst @@ -67,7 +67,7 @@ Member Function Description - :ref:`int` **get_dragger_visibility** **(** **)** const -Return visibility of the split dragger (one of :ref:`DRAGGER_VISIBLE`, :ref:`DRAGGER_HIDDEN` or :ref:`DRAGGER_HIDDEN_COLLAPSED`). +Return visibility of the split dragger (one of DRAGGER_VISIBLE, DRAGGER_HIDDEN or DRAGGER_HIDDEN_COLLAPSED). .. _class_SplitContainer_get_split_offset: @@ -91,7 +91,7 @@ Set if the split must be collapsed. - void **set_dragger_visibility** **(** :ref:`int` mode **)** -Set visibility of the split dragger (*mode* must be one of :ref:`DRAGGER_VISIBLE`, :ref:`DRAGGER_HIDDEN` or :ref:`DRAGGER_HIDDEN_COLLAPSED`). +Set visibility of the split dragger (*mode* must be one of DRAGGER_VISIBLE, DRAGGER_HIDDEN or DRAGGER_HIDDEN_COLLAPSED). .. _class_SplitContainer_set_split_offset: diff --git a/classes/class_sprite.rst b/classes/class_sprite.rst index deb034252..006f0417d 100644 --- a/classes/class_sprite.rst +++ b/classes/class_sprite.rst @@ -18,47 +18,55 @@ General purpose Sprite node. Member Functions ---------------- -+--------------------------------+---------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_frame` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_hframes` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`get_region_rect` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`get_texture` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_vframes` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_centered` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_flipped_h` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_flipped_v` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_region` **(** **)** const | -+--------------------------------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`set_centered` **(** :ref:`bool` centered **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`set_flip_h` **(** :ref:`bool` flip_h **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`set_flip_v` **(** :ref:`bool` flip_v **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`set_frame` **(** :ref:`int` frame **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`set_hframes` **(** :ref:`int` hframes **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`set_offset` **(** :ref:`Vector2` offset **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`set_region` **(** :ref:`bool` enabled **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`set_region_rect` **(** :ref:`Rect2` rect **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`set_texture` **(** :ref:`Texture` texture **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------+ -| void | :ref:`set_vframes` **(** :ref:`int` vframes **)** | -+--------------------------------+---------------------------------------------------------------------------------------------------+ ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_frame` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_hframes` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_normal_map` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_offset` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_region_rect` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_texture` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_vframes` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_centered` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_flipped_h` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_flipped_v` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_region` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_region_filter_clip_enabled` **(** **)** const | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_centered` **(** :ref:`bool` centered **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_flip_h` **(** :ref:`bool` flip_h **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_flip_v` **(** :ref:`bool` flip_v **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_frame` **(** :ref:`int` frame **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_hframes` **(** :ref:`int` hframes **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_normal_map` **(** :ref:`Texture` normal_map **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_offset` **(** :ref:`Vector2` offset **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_region` **(** :ref:`bool` enabled **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_region_filter_clip` **(** :ref:`bool` enabled **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_region_rect` **(** :ref:`Rect2` rect **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_texture` **(** :ref:`Texture` texture **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_vframes` **(** :ref:`int` vframes **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -74,8 +82,10 @@ Member Variables - :ref:`bool` **flip_v** - :ref:`int` **frame** - :ref:`int` **hframes** +- :ref:`Texture` **normal_map** - :ref:`Vector2` **offset** -- :ref:`bool` **region** +- :ref:`bool` **region_enabled** +- :ref:`bool` **region_filter_clip** - :ref:`Rect2` **region_rect** - :ref:`Texture` **texture** - :ref:`int` **vframes** @@ -100,6 +110,10 @@ Return the texture frame for a sprite-sheet, works when vframes or hframes are g Return the amount of horizontal frames. See :ref:`set_hframes`. +.. _class_Sprite_get_normal_map: + +- :ref:`Texture` **get_normal_map** **(** **)** const + .. _class_Sprite_get_offset: - :ref:`Vector2` **get_offset** **(** **)** const @@ -148,6 +162,10 @@ Return true if the sprite is flipped vertically. Return if the sprite reads from a region. +.. _class_Sprite_is_region_filter_clip_enabled: + +- :ref:`bool` **is_region_filter_clip_enabled** **(** **)** const + .. _class_Sprite_set_centered: - void **set_centered** **(** :ref:`bool` centered **)** @@ -178,6 +196,10 @@ Set the texture frame for a sprite-sheet, works when vframes or hframes are grea Set the amount of horizontal frames and converts the sprite into a sprite-sheet. This is useful for animation. +.. _class_Sprite_set_normal_map: + +- void **set_normal_map** **(** :ref:`Texture` normal_map **)** + .. _class_Sprite_set_offset: - void **set_offset** **(** :ref:`Vector2` offset **)** @@ -190,6 +212,10 @@ Set the sprite draw offset, useful for setting rotation pivots. Set the sprite as a sub-region of a bigger texture. Useful for texture-atlases. +.. _class_Sprite_set_region_filter_clip: + +- void **set_region_filter_clip** **(** :ref:`bool` enabled **)** + .. _class_Sprite_set_region_rect: - void **set_region_rect** **(** :ref:`Rect2` rect **)** diff --git a/classes/class_sprite3d.rst b/classes/class_sprite3d.rst index d938aa5b3..2efd72230 100644 --- a/classes/class_sprite3d.rst +++ b/classes/class_sprite3d.rst @@ -54,7 +54,7 @@ Member Variables - :ref:`int` **frame** - :ref:`int` **hframes** -- :ref:`bool` **region** +- :ref:`bool` **region_enabled** - :ref:`Rect2` **region_rect** - :ref:`Texture` **texture** - :ref:`int` **vframes** diff --git a/classes/class_spritebase3d.rst b/classes/class_spritebase3d.rst index 02b30fb82..73a78b913 100644 --- a/classes/class_spritebase3d.rst +++ b/classes/class_spritebase3d.rst @@ -70,6 +70,7 @@ Member Variables - :ref:`int` **alpha_cut** - :ref:`int` **axis** - :ref:`bool` **centered** +- :ref:`bool` **double_sided** - :ref:`bool` **flip_h** - :ref:`bool` **flip_v** - :ref:`Color` **modulate** @@ -84,7 +85,8 @@ Numeric Constants - **FLAG_TRANSPARENT** = **0** - **FLAG_SHADED** = **1** -- **FLAG_MAX** = **2** +- **FLAG_DOUBLE_SIDED** = **2** +- **FLAG_MAX** = **3** - **ALPHA_CUT_DISABLED** = **0** - **ALPHA_CUT_DISCARD** = **1** - **ALPHA_CUT_OPAQUE_PREPASS** = **2** diff --git a/classes/class_staticbody.rst b/classes/class_staticbody.rst index 1239db820..8a61061f2 100644 --- a/classes/class_staticbody.rst +++ b/classes/class_staticbody.rst @@ -47,7 +47,7 @@ Member Variables Description ----------- -Static body for 3D Physics. A static body is a simple body that is not intended to move. They don't consume any CPU resources in contrast to a :ref:`RigidBody3D` so they are great for scenario collision. +Static body for 3D Physics. A static body is a simple body that is not intended to move. They don't consume any CPU resources in contrast to a RigidBody3D so they are great for scenario collision. A static body can also be animated by using simulated motion mode. This is useful for implementing functionalities such as moving platforms. When this mode is active the body can be animated and automatically computes linear and angular velocity to apply in that frame and to influence other bodies. diff --git a/classes/class_streampeertcp.rst b/classes/class_streampeertcp.rst index 13d12061d..5b766769c 100644 --- a/classes/class_streampeertcp.rst +++ b/classes/class_streampeertcp.rst @@ -52,7 +52,7 @@ Member Function Description - :ref:`int` **connect_to_host** **(** :ref:`String` host, :ref:`int` port **)** -Connect to the specified host:port pair. A hostname will be resolved if valid. Returns :ref:`OK` on success or :ref:`FAILED` on failure. +Connect to the specified host:port pair. A hostname will be resolved if valid. Returns OK on success or FAILED on failure. .. _class_StreamPeerTCP_disconnect_from_host: diff --git a/classes/class_string.rst b/classes/class_string.rst index 2724d023b..263a4a963 100644 --- a/classes/class_string.rst +++ b/classes/class_string.rst @@ -602,13 +602,13 @@ Return the similarity index of the text compared to this string. 1 means totally - :ref:`PoolStringArray` **split** **(** :ref:`String` divisor, :ref:`bool` allow_empty=True **)** -Split the string by a divisor string, return an array of the substrings. Example "One,Two,Three" will return :ref:`"One","Two","Three"` if split by ",". +Split the string by a divisor string, return an array of the substrings. Example "One,Two,Three" will return "One","Two","Three" if split by ",". .. _class_String_split_floats: - :ref:`PoolRealArray` **split_floats** **(** :ref:`String` divisor, :ref:`bool` allow_empty=True **)** -Split the string in floats by using a divisor string, return an array of the substrings. Example "1,2.5,3" will return :ref:`1,2.5,3` if split by ",". +Split the string in floats by using a divisor string, return an array of the substrings. Example "1,2.5,3" will return 1,2.5,3 if split by ",". .. _class_String_strip_edges: diff --git a/classes/class_styleboxtexture.rst b/classes/class_styleboxtexture.rst index bd5911064..8b100ab7c 100644 --- a/classes/class_styleboxtexture.rst +++ b/classes/class_styleboxtexture.rst @@ -27,6 +27,8 @@ Member Functions +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`get_modulate` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`get_normal_map` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`get_region_rect` **(** **)** const | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture` | :ref:`get_texture` **(** **)** const | @@ -39,6 +41,8 @@ Member Functions +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_modulate` **(** :ref:`Color` color **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_normal_map` **(** :ref:`Texture` normal_map **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_region_rect` **(** :ref:`Rect2` region **)** | +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_texture` **(** :ref:`Texture` texture **)** | @@ -62,6 +66,7 @@ Member Variables - :ref:`float` **margin_right** - :ref:`float` **margin_top** - :ref:`Color` **modulate_color** +- :ref:`Texture` **normal_map** - :ref:`Rect2` **region_rect** - :ref:`Texture` **texture** @@ -89,6 +94,10 @@ Member Function Description - :ref:`Color` **get_modulate** **(** **)** const +.. _class_StyleBoxTexture_get_normal_map: + +- :ref:`Texture` **get_normal_map** **(** **)** const + .. _class_StyleBoxTexture_get_region_rect: - :ref:`Rect2` **get_region_rect** **(** **)** const @@ -113,6 +122,10 @@ Member Function Description - void **set_modulate** **(** :ref:`Color` color **)** +.. _class_StyleBoxTexture_set_normal_map: + +- void **set_normal_map** **(** :ref:`Texture` normal_map **)** + .. _class_StyleBoxTexture_set_region_rect: - void **set_region_rect** **(** :ref:`Rect2` region **)** diff --git a/classes/class_tabs.rst b/classes/class_tabs.rst index 80311fcf3..d882b7953 100644 --- a/classes/class_tabs.rst +++ b/classes/class_tabs.rst @@ -33,8 +33,12 @@ Member Functions +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture` | :ref:`get_tab_icon` **(** :ref:`int` tab_idx **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`get_tab_rect` **(** :ref:`int` tab_idx **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_tab_title` **(** :ref:`int` tab_idx **)** const | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`move_tab` **(** :ref:`int` from, :ref:`int` to **)** | ++--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_tab` **(** :ref:`int` tab_idx **)** | +--------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_current_tab` **(** :ref:`int` tab_idx **)** | @@ -51,6 +55,7 @@ Member Functions Signals ------- +- **reposition_active_tab_request** **(** :ref:`int` idx_to **)** - **right_button_pressed** **(** :ref:`int` tab **)** - **tab_changed** **(** :ref:`int` tab **)** - **tab_close** **(** :ref:`int` tab **)** @@ -107,10 +112,22 @@ Member Function Description - :ref:`Texture` **get_tab_icon** **(** :ref:`int` tab_idx **)** const +.. _class_Tabs_get_tab_rect: + +- :ref:`Rect2` **get_tab_rect** **(** :ref:`int` tab_idx **)** + +Returns tab :ref:`Rect2` with local position and size. + .. _class_Tabs_get_tab_title: - :ref:`String` **get_tab_title** **(** :ref:`int` tab_idx **)** const +.. _class_Tabs_move_tab: + +- void **move_tab** **(** :ref:`int` from, :ref:`int` to **)** + +Rearrange tab. + .. _class_Tabs_remove_tab: - void **remove_tab** **(** :ref:`int` tab_idx **)** diff --git a/classes/class_texture.rst b/classes/class_texture.rst index e0d1e3ecd..939c591cc 100644 --- a/classes/class_texture.rst +++ b/classes/class_texture.rst @@ -8,7 +8,7 @@ Texture **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`CurveTexture`, :ref:`AtlasTexture`, :ref:`GradientTexture`, :ref:`ViewportTexture`, :ref:`StreamTexture`, :ref:`ImageTexture`, :ref:`LargeTexture` +**Inherited By:** :ref:`CurveTexture`, :ref:`AtlasTexture`, :ref:`StreamTexture`, :ref:`GradientTexture`, :ref:`ViewportTexture`, :ref:`ImageTexture`, :ref:`LargeTexture` **Category:** Core @@ -20,25 +20,25 @@ Texture for 2D and 3D. Member Functions ---------------- -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw` **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`Color` modulate=Color(1,1,1,1), :ref:`bool` transpose=false **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_rect` **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color(1,1,1,1), :ref:`bool` transpose=false **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_rect_region` **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color(1,1,1,1), :ref:`bool` transpose=false **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_flags` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_height` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_size` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_width` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_alpha` **(** **)** const | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_flags` **(** :ref:`int` flags **)** | -+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw` **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`Color` modulate=Color(1,1,1,1), :ref:`bool` transpose=false, :ref:`Texture` normal_map=NULL **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_rect` **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color(1,1,1,1), :ref:`bool` transpose=false, :ref:`Texture` normal_map=NULL **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_rect_region` **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color(1,1,1,1), :ref:`bool` transpose=false, :ref:`Texture` normal_map=NULL, :ref:`bool` clip_uv=true **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_flags` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_height` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_size` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_width` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_alpha` **(** **)** const | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_flags` **(** :ref:`int` flags **)** | ++--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Numeric Constants ----------------- @@ -62,15 +62,15 @@ Member Function Description .. _class_Texture_draw: -- void **draw** **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`Color` modulate=Color(1,1,1,1), :ref:`bool` transpose=false **)** const +- void **draw** **(** :ref:`RID` canvas_item, :ref:`Vector2` pos, :ref:`Color` modulate=Color(1,1,1,1), :ref:`bool` transpose=false, :ref:`Texture` normal_map=NULL **)** const .. _class_Texture_draw_rect: -- void **draw_rect** **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color(1,1,1,1), :ref:`bool` transpose=false **)** const +- void **draw_rect** **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`bool` tile, :ref:`Color` modulate=Color(1,1,1,1), :ref:`bool` transpose=false, :ref:`Texture` normal_map=NULL **)** const .. _class_Texture_draw_rect_region: -- void **draw_rect_region** **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color(1,1,1,1), :ref:`bool` transpose=false **)** const +- void **draw_rect_region** **(** :ref:`RID` canvas_item, :ref:`Rect2` rect, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color(1,1,1,1), :ref:`bool` transpose=false, :ref:`Texture` normal_map=NULL, :ref:`bool` clip_uv=true **)** const .. _class_Texture_get_flags: diff --git a/classes/class_thread.rst b/classes/class_thread.rst index fb33247a8..710338158 100644 --- a/classes/class_thread.rst +++ b/classes/class_thread.rst @@ -38,7 +38,7 @@ Numeric Constants Description ----------- -A unit of execution in a process. Can run methods on :ref:`Object`s simultaneously. The use of synchronization via :ref:`Mutex`, :ref:`Semaphore` is advised if working with shared objects. +A unit of execution in a process. Can run methods on :ref:`Object`\ s simultaneously. The use of synchronization via :ref:`Mutex`, :ref:`Semaphore` is advised if working with shared objects. Member Function Description --------------------------- diff --git a/classes/class_tileset.rst b/classes/class_tileset.rst index 8ab673346..af4e12516 100644 --- a/classes/class_tileset.rst +++ b/classes/class_tileset.rst @@ -18,67 +18,79 @@ Tile library for tilemaps. Member Functions ---------------- -+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create_tile` **(** :ref:`int` id **)** | -+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`find_tile_by_name` **(** :ref:`String` name **)** const | -+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_last_unused_tile_id` **(** **)** const | -+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_tiles_ids` **(** **)** const | -+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`remove_tile` **(** :ref:`int` id **)** | -+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`OccluderPolygon2D` | :ref:`tile_get_light_occluder` **(** :ref:`int` id **)** const | -+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ShaderMaterial` | :ref:`tile_get_material` **(** :ref:`int` id **)** const | -+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`tile_get_name` **(** :ref:`int` id **)** const | -+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`NavigationPolygon` | :ref:`tile_get_navigation_polygon` **(** :ref:`int` id **)** const | -+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`tile_get_navigation_polygon_offset` **(** :ref:`int` id **)** const | -+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`tile_get_occluder_offset` **(** :ref:`int` id **)** const | -+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`tile_get_region` **(** :ref:`int` id **)** const | -+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Shape2D` | :ref:`tile_get_shape` **(** :ref:`int` id **)** const | -+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`tile_get_shape_offset` **(** :ref:`int` id **)** const | -+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`tile_get_shapes` **(** :ref:`int` id **)** const | -+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture` | :ref:`tile_get_texture` **(** :ref:`int` id **)** const | -+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`tile_get_texture_offset` **(** :ref:`int` id **)** const | -+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_light_occluder` **(** :ref:`int` id, :ref:`OccluderPolygon2D` light_occluder **)** | -+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_material` **(** :ref:`int` id, :ref:`ShaderMaterial` material **)** | -+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_name` **(** :ref:`int` id, :ref:`String` name **)** | -+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_navigation_polygon` **(** :ref:`int` id, :ref:`NavigationPolygon` navigation_polygon **)** | -+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_navigation_polygon_offset` **(** :ref:`int` id, :ref:`Vector2` navigation_polygon_offset **)** | -+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_occluder_offset` **(** :ref:`int` id, :ref:`Vector2` occluder_offset **)** | -+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_region` **(** :ref:`int` id, :ref:`Rect2` region **)** | -+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_shape` **(** :ref:`int` id, :ref:`Shape2D` shape **)** | -+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_shape_offset` **(** :ref:`int` id, :ref:`Vector2` shape_offset **)** | -+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_shapes` **(** :ref:`int` id, :ref:`Array` shapes **)** | -+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_texture` **(** :ref:`int` id, :ref:`Texture` texture **)** | -+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tile_set_texture_offset` **(** :ref:`int` id, :ref:`Vector2` texture_offset **)** | -+----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`create_tile` **(** :ref:`int` id **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`find_tile_by_name` **(** :ref:`String` name **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_last_unused_tile_id` **(** **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_tiles_ids` **(** **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`remove_tile` **(** :ref:`int` id **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_add_shape` **(** :ref:`int` id, :ref:`Shape2D` shape, :ref:`Transform2D` shape_transform, :ref:`bool` one_way=false **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`OccluderPolygon2D` | :ref:`tile_get_light_occluder` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ShaderMaterial` | :ref:`tile_get_material` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`tile_get_name` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`NavigationPolygon` | :ref:`tile_get_navigation_polygon` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`tile_get_navigation_polygon_offset` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`tile_get_normal_map` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`tile_get_occluder_offset` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`tile_get_region` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Shape2D` | :ref:`tile_get_shape` **(** :ref:`int` id, :ref:`int` shape_id **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`tile_get_shape_count` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`tile_get_shape_one_way` **(** :ref:`int` id, :ref:`int` shape_id **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`tile_get_shape_transform` **(** :ref:`int` id, :ref:`int` shape_id **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`tile_get_shapes` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture` | :ref:`tile_get_texture` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`tile_get_texture_offset` **(** :ref:`int` id **)** const | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_light_occluder` **(** :ref:`int` id, :ref:`OccluderPolygon2D` light_occluder **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_material` **(** :ref:`int` id, :ref:`ShaderMaterial` material **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_name` **(** :ref:`int` id, :ref:`String` name **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_navigation_polygon` **(** :ref:`int` id, :ref:`NavigationPolygon` navigation_polygon **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_navigation_polygon_offset` **(** :ref:`int` id, :ref:`Vector2` navigation_polygon_offset **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_normal_map` **(** :ref:`int` id, :ref:`Texture` normal_map **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_occluder_offset` **(** :ref:`int` id, :ref:`Vector2` occluder_offset **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_region` **(** :ref:`int` id, :ref:`Rect2` region **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_shape` **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Shape2D` shape **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_shape_one_way` **(** :ref:`int` id, :ref:`int` shape_id, :ref:`bool` one_way **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_shape_transform` **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Transform2D` shape_transform **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_shapes` **(** :ref:`int` id, :ref:`Array` shapes **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_texture` **(** :ref:`int` id, :ref:`Texture` texture **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tile_set_texture_offset` **(** :ref:`int` id, :ref:`Vector2` texture_offset **)** | ++----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Description ----------- @@ -126,6 +138,10 @@ Return an array of all currently used tile IDs. Remove the tile referenced by the given ID. +.. _class_TileSet_tile_add_shape: + +- void **tile_add_shape** **(** :ref:`int` id, :ref:`Shape2D` shape, :ref:`Transform2D` shape_transform, :ref:`bool` one_way=false **)** + .. _class_TileSet_tile_get_light_occluder: - :ref:`OccluderPolygon2D` **tile_get_light_occluder** **(** :ref:`int` id **)** const @@ -156,6 +172,10 @@ Return the navigation polygon of the tile. Return the offset of the tile's navigation polygon. +.. _class_TileSet_tile_get_normal_map: + +- :ref:`Texture` **tile_get_normal_map** **(** :ref:`int` id **)** const + .. _class_TileSet_tile_get_occluder_offset: - :ref:`Vector2` **tile_get_occluder_offset** **(** :ref:`int` id **)** const @@ -170,15 +190,19 @@ Return the tile sub-region in the texture. .. _class_TileSet_tile_get_shape: -- :ref:`Shape2D` **tile_get_shape** **(** :ref:`int` id **)** const +- :ref:`Shape2D` **tile_get_shape** **(** :ref:`int` id, :ref:`int` shape_id **)** const -Return the shape of the tile. +.. _class_TileSet_tile_get_shape_count: -.. _class_TileSet_tile_get_shape_offset: +- :ref:`int` **tile_get_shape_count** **(** :ref:`int` id **)** const -- :ref:`Vector2` **tile_get_shape_offset** **(** :ref:`int` id **)** const +.. _class_TileSet_tile_get_shape_one_way: -Return the shape offset of the tile. +- :ref:`bool` **tile_get_shape_one_way** **(** :ref:`int` id, :ref:`int` shape_id **)** const + +.. _class_TileSet_tile_get_shape_transform: + +- :ref:`Transform2D` **tile_get_shape_transform** **(** :ref:`int` id, :ref:`int` shape_id **)** const .. _class_TileSet_tile_get_shapes: @@ -228,6 +252,10 @@ Set a navigation polygon for the tile. Set an offset for the tile's navigation polygon. +.. _class_TileSet_tile_set_normal_map: + +- void **tile_set_normal_map** **(** :ref:`int` id, :ref:`Texture` normal_map **)** + .. _class_TileSet_tile_set_occluder_offset: - void **tile_set_occluder_offset** **(** :ref:`int` id, :ref:`Vector2` occluder_offset **)** @@ -242,15 +270,15 @@ Set the tile sub-region in the texture. This is common in texture atlases. .. _class_TileSet_tile_set_shape: -- void **tile_set_shape** **(** :ref:`int` id, :ref:`Shape2D` shape **)** +- void **tile_set_shape** **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Shape2D` shape **)** -Set a shape for the tile, enabling physics to collide with it. +.. _class_TileSet_tile_set_shape_one_way: -.. _class_TileSet_tile_set_shape_offset: +- void **tile_set_shape_one_way** **(** :ref:`int` id, :ref:`int` shape_id, :ref:`bool` one_way **)** -- void **tile_set_shape_offset** **(** :ref:`int` id, :ref:`Vector2` shape_offset **)** +.. _class_TileSet_tile_set_shape_transform: -Set the shape offset of the tile. +- void **tile_set_shape_transform** **(** :ref:`int` id, :ref:`int` shape_id, :ref:`Transform2D` shape_transform **)** .. _class_TileSet_tile_set_shapes: diff --git a/classes/class_transform2d.rst b/classes/class_transform2d.rst index 38d0c8bd6..6a5b5aecc 100644 --- a/classes/class_transform2d.rst +++ b/classes/class_transform2d.rst @@ -55,7 +55,7 @@ Member Functions Member Variables ---------------- -- :ref:`Vector2` **o** +- :ref:`Vector2` **origin** - :ref:`Vector2` **x** - :ref:`Vector2` **y** diff --git a/classes/class_treeitem.rst b/classes/class_treeitem.rst index 0dd9d1bb1..7ab02c6d3 100644 --- a/classes/class_treeitem.rst +++ b/classes/class_treeitem.rst @@ -39,6 +39,8 @@ Member Functions +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Color` | :ref:`get_custom_bg_color` **(** :ref:`int` column **)** const | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_expand_right` **(** :ref:`int` column **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture` | :ref:`get_icon` **(** :ref:`int` column **)** const | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_icon_max_width` **(** :ref:`int` column **)** const | @@ -63,6 +65,8 @@ Member Functions +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_text` **(** :ref:`int` column **)** const | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_text_align` **(** :ref:`int` column **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_tooltip` **(** :ref:`int` column **)** const | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_button_disabled` **(** :ref:`int` column, :ref:`int` button_idx **)** const | @@ -75,6 +79,8 @@ Member Functions +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_editable` **(** :ref:`int` column **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_folding_disabled` **(** **)** const | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_selectable` **(** :ref:`int` column **)** const | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_selected` **(** :ref:`int` column **)** | @@ -103,8 +109,12 @@ Member Functions +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_custom_draw` **(** :ref:`int` column, :ref:`Object` object, :ref:`String` callback **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_disable_folding` **(** :ref:`bool` disable **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_editable` **(** :ref:`int` column, :ref:`bool` enabled **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_expand_right` **(** :ref:`int` column, :ref:`bool` enable **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_icon` **(** :ref:`int` column, :ref:`Texture` texture **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_icon_max_width` **(** :ref:`int` column, :ref:`int` width **)** | @@ -121,6 +131,8 @@ Member Functions +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_text` **(** :ref:`int` column, :ref:`String` text **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_text_align` **(** :ref:`int` column, :ref:`int` text_align **)** | ++--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_tooltip` **(** :ref:`int` column, :ref:`String` tooltip **)** | +--------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -177,6 +189,10 @@ Member Function Description - :ref:`Color` **get_custom_bg_color** **(** :ref:`int` column **)** const +.. _class_TreeItem_get_expand_right: + +- :ref:`bool` **get_expand_right** **(** :ref:`int` column **)** const + .. _class_TreeItem_get_icon: - :ref:`Texture` **get_icon** **(** :ref:`int` column **)** const @@ -225,6 +241,10 @@ Member Function Description - :ref:`String` **get_text** **(** :ref:`int` column **)** const +.. _class_TreeItem_get_text_align: + +- :ref:`int` **get_text_align** **(** :ref:`int` column **)** const + .. _class_TreeItem_get_tooltip: - :ref:`String` **get_tooltip** **(** :ref:`int` column **)** const @@ -249,6 +269,10 @@ Member Function Description - :ref:`bool` **is_editable** **(** :ref:`int` column **)** +.. _class_TreeItem_is_folding_disabled: + +- :ref:`bool` **is_folding_disabled** **(** **)** const + .. _class_TreeItem_is_selectable: - :ref:`bool` **is_selectable** **(** :ref:`int` column **)** const @@ -305,10 +329,18 @@ Member Function Description - void **set_custom_draw** **(** :ref:`int` column, :ref:`Object` object, :ref:`String` callback **)** +.. _class_TreeItem_set_disable_folding: + +- void **set_disable_folding** **(** :ref:`bool` disable **)** + .. _class_TreeItem_set_editable: - void **set_editable** **(** :ref:`int` column, :ref:`bool` enabled **)** +.. _class_TreeItem_set_expand_right: + +- void **set_expand_right** **(** :ref:`int` column, :ref:`bool` enable **)** + .. _class_TreeItem_set_icon: - void **set_icon** **(** :ref:`int` column, :ref:`Texture` texture **)** @@ -341,6 +373,10 @@ Member Function Description - void **set_text** **(** :ref:`int` column, :ref:`String` text **)** +.. _class_TreeItem_set_text_align: + +- void **set_text_align** **(** :ref:`int` column, :ref:`int` text_align **)** + .. _class_TreeItem_set_tooltip: - void **set_tooltip** **(** :ref:`int` column, :ref:`String` tooltip **)** diff --git a/classes/class_tween.rst b/classes/class_tween.rst index be5105567..cb0726c30 100644 --- a/classes/class_tween.rst +++ b/classes/class_tween.rst @@ -179,7 +179,7 @@ Call ``callback`` of ``object`` after ``duration``. ``arg1``-``arg5`` are argume - :ref:`bool` **interpolate_deferred_callback** **(** :ref:`Object` object, :ref:`float` duration, :ref:`String` callback, :ref:`Variant` arg1=NULL, :ref:`Variant` arg2=NULL, :ref:`Variant` arg3=NULL, :ref:`Variant` arg4=NULL, :ref:`Variant` arg5=NULL **)** -Call ``callback`` of ``object`` after ``duration`` on the main thread (similar to :ref:`methog Object.call_deferred). [code`arg1``-``arg5`` are arguments to be passed to the callback. +Call ``callback`` of ``object`` after ``duration`` on the main thread (similar to methog Object.call_deferred). [codearg1``-``arg5`` are arguments to be passed to the callback. .. _class_Tween_interpolate_method: diff --git a/classes/class_undoredo.rst b/classes/class_undoredo.rst index 6e6569af0..708ff1e5f 100644 --- a/classes/class_undoredo.rst +++ b/classes/class_undoredo.rst @@ -52,7 +52,7 @@ Numeric Constants Description ----------- -Helper to maange UndoRedo in the editor or custom tools. It works by storing calls to functions in both 'do' an 'undo' lists. +Helper to manage UndoRedo in the editor or custom tools. It works by storing calls to functions in both 'do' an 'undo' lists. Common behavior is to create an action, then add do/undo calls to functions or property changes, then committing the action. @@ -89,15 +89,13 @@ Undo setting of a property with a custom value. - void **add_undo_reference** **(** :ref:`Object` object **)** -Add an 'undo' reference that will be erased if the 'undo' history is lost. This is useful mostly for nodes rmoved with the 'do' call (not the 'undo' call!). +Add an 'undo' reference that will be erased if the 'undo' history is lost. This is useful mostly for nodes removed with the 'do' call (not the 'undo' call!). .. _class_UndoRedo_clear_history: - void **clear_history** **(** **)** -Clear the undo/redo history and associated - -references. +Clear the undo/redo history and associated references. .. _class_UndoRedo_commit_action: @@ -109,11 +107,7 @@ Commit the action. All 'do' methods/properties are called/set when this function - void **create_action** **(** :ref:`String` name, :ref:`int` merge_mode=0 **)** -Create a new action. After this is called, do all your calls to :ref:`add_do_method`, :ref:`add_undo_method`, :ref:`add_do_property` and :ref:`add_un - -do_property`. +Create a new action. After this is called, do all your calls to :ref:`add_do_method`, :ref:`add_undo_method`, :ref:`add_do_property` and :ref:`add_undo_property`. .. _class_UndoRedo_get_current_action_name: diff --git a/classes/class_vector2.rst b/classes/class_vector2.rst index 63dba3231..e0f844eb8 100644 --- a/classes/class_vector2.rst +++ b/classes/class_vector2.rst @@ -67,8 +67,6 @@ Member Functions Member Variables ---------------- -- :ref:`float` **height** - Height of the vector (Same as Y). -- :ref:`float` **width** - Width of the vector (Same as X). - :ref:`float` **x** - X component of the vector. - :ref:`float` **y** - Y component of the vector. diff --git a/classes/class_viewport.rst b/classes/class_viewport.rst index c7b5bb22a..aa097e5ae 100644 --- a/classes/class_viewport.rst +++ b/classes/class_viewport.rst @@ -456,7 +456,7 @@ Makes the viewport send sounds from 2D emitters to the speakers. - void **set_canvas_transform** **(** :ref:`Transform2D` xform **)** -Set the canvas transform of the viewport, useful for changing the on-screen positions of all child :ref:`CanvasItem`s. This is relative to the global canvas transform of the viewport. +Set the canvas transform of the viewport, useful for changing the on-screen positions of all child :ref:`CanvasItem`\ s. This is relative to the global canvas transform of the viewport. .. _class_Viewport_set_clear_on_new_frame: diff --git a/classes/class_visualscriptconstant.rst b/classes/class_visualscriptconstant.rst index 974cb1c0b..8a7eb4436 100644 --- a/classes/class_visualscriptconstant.rst +++ b/classes/class_visualscriptconstant.rst @@ -18,21 +18,21 @@ Brief Description Member Functions ---------------- -+------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_constant_type` **(** **)** const | -+------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`get_constant_value` **(** **)** const | -+------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_constant_type` **(** :ref:`int` type **)** | -+------------------------+----------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_constant_value` **(** :ref:`Variant` value **)** | -+------------------------+----------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_constant_type` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_constant_value` **(** **)** const | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_constant_type` **(** :ref:`int` type **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_constant_value` **(** :ref:`Variant` value **)** | ++--------------------------------+----------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- -- :ref:`int` **constant/type** -- :ref:`Nil` **constant/value** +- :ref:`int` **type** +- :ref:`Nil` **value** Member Function Description --------------------------- @@ -43,7 +43,7 @@ Member Function Description .. _class_VisualScriptConstant_get_constant_value: -- void **get_constant_value** **(** **)** const +- :ref:`Variant` **get_constant_value** **(** **)** const .. _class_VisualScriptConstant_set_constant_type: diff --git a/classes/class_visualscriptemitsignal.rst b/classes/class_visualscriptemitsignal.rst index f9037365b..2552a47b9 100644 --- a/classes/class_visualscriptemitsignal.rst +++ b/classes/class_visualscriptemitsignal.rst @@ -27,7 +27,7 @@ Member Functions Member Variables ---------------- -- :ref:`String` **signal/signal** +- :ref:`String` **signal** Member Function Description --------------------------- diff --git a/classes/class_visualscriptfunctioncall.rst b/classes/class_visualscriptfunctioncall.rst index d0d9c8415..de9d8aeda 100644 --- a/classes/class_visualscriptfunctioncall.rst +++ b/classes/class_visualscriptfunctioncall.rst @@ -63,17 +63,17 @@ Member Functions Member Variables ---------------- -- :ref:`Dictionary` **function/argument_cache** -- :ref:`String` **function/base_script** -- :ref:`String` **function/base_type** -- :ref:`int` **function/basic_type** -- :ref:`int` **function/call_mode** -- :ref:`String` **function/function** -- :ref:`NodePath` **function/node_path** -- :ref:`String` **function/singleton** -- :ref:`int` **function/use_default_args** -- :ref:`bool` **function/validate** -- :ref:`int` **rpc/call_mode** +- :ref:`Dictionary` **argument_cache** +- :ref:`String` **base_script** +- :ref:`String` **base_type** +- :ref:`int` **basic_type** +- :ref:`int` **call_mode** +- :ref:`String` **function** +- :ref:`NodePath` **node_path** +- :ref:`int` **rpc_call_mode** +- :ref:`String` **singleton** +- :ref:`int` **use_default_args** +- :ref:`bool` **validate** Numeric Constants ----------------- diff --git a/classes/class_visualscriptlocalvar.rst b/classes/class_visualscriptlocalvar.rst index dfc997731..e7562cc37 100644 --- a/classes/class_visualscriptlocalvar.rst +++ b/classes/class_visualscriptlocalvar.rst @@ -31,8 +31,8 @@ Member Functions Member Variables ---------------- -- :ref:`String` **variable/name** -- :ref:`int` **variable/type** +- :ref:`int` **type** +- :ref:`String` **var_name** Member Function Description --------------------------- diff --git a/classes/class_visualscriptlocalvarset.rst b/classes/class_visualscriptlocalvarset.rst index d6865b71f..1375b1c62 100644 --- a/classes/class_visualscriptlocalvarset.rst +++ b/classes/class_visualscriptlocalvarset.rst @@ -31,8 +31,8 @@ Member Functions Member Variables ---------------- -- :ref:`String` **variable/name** -- :ref:`int` **variable/type** +- :ref:`int` **type** +- :ref:`String` **var_name** Member Function Description --------------------------- diff --git a/classes/class_visualscriptnode.rst b/classes/class_visualscriptnode.rst index 3fbcc121b..9bb048bd1 100644 --- a/classes/class_visualscriptnode.rst +++ b/classes/class_visualscriptnode.rst @@ -8,7 +8,7 @@ VisualScriptNode **Inherits:** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` -**Inherited By:** :ref:`VisualScriptDeconstruct`, :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:`VisualScriptTypeCast`, :ref:`VisualScriptGlobalConstant`, :ref:`VisualScriptFunctionCall`, :ref:`VisualScriptYield`, :ref:`VisualScriptSwitch`, :ref:`VisualScriptBuiltinFunc`, :ref:`VisualScriptClassConstant`, :ref:`VisualScriptEngineSingleton`, :ref:`VisualScriptCondition`, :ref:`VisualScriptOperator`, :ref:`VisualScriptIterator`, :ref:`VisualScriptCustomNode`, :ref:`VisualScriptSubCall`, :ref:`VisualScriptYieldSignal`, :ref:`VisualScriptIndexGet`, :ref:`VisualScriptLocalVarSet`, :ref:`VisualScriptWhile`, :ref:`VisualScriptConstructor`, :ref:`VisualScriptMathConstant`, :ref:`VisualScriptComment`, :ref:`VisualScriptExpression`, :ref:`VisualScriptPropertySet`, :ref:`VisualScriptFunction`, :ref:`VisualScriptPreload` +**Inherited By:** :ref:`VisualScriptDeconstruct`, :ref:`VisualScriptLocalVar`, :ref:`VisualScriptSceneNode`, :ref:`VisualScriptBasicTypeConstant`, :ref:`VisualScriptSequence`, :ref:`VisualScriptVariableSet`, :ref:`VisualScriptConstant`, :ref:`VisualScriptReturn`, :ref:`VisualScriptSceneTree`, :ref:`VisualScriptSelf`, :ref:`VisualScriptIndexSet`, :ref:`VisualScriptResourcePath`, :ref:`VisualScriptPropertyGet`, :ref:`VisualScriptVariableGet`, :ref:`VisualScriptInputAction`, :ref:`VisualScriptEmitSignal`, :ref:`VisualScriptTypeCast`, :ref:`VisualScriptGlobalConstant`, :ref:`VisualScriptFunctionCall`, :ref:`VisualScriptPreload`, :ref:`VisualScriptYield`, :ref:`VisualScriptSwitch`, :ref:`VisualScriptBuiltinFunc`, :ref:`VisualScriptClassConstant`, :ref:`VisualScriptEngineSingleton`, :ref:`VisualScriptCondition`, :ref:`VisualScriptOperator`, :ref:`VisualScriptIterator`, :ref:`VisualScriptCustomNode`, :ref:`VisualScriptSubCall`, :ref:`VisualScriptYieldSignal`, :ref:`VisualScriptIndexGet`, :ref:`VisualScriptLocalVarSet`, :ref:`VisualScriptWhile`, :ref:`VisualScriptConstructor`, :ref:`VisualScriptMathConstant`, :ref:`VisualScriptComment`, :ref:`VisualScriptExpression`, :ref:`VisualScriptPropertySet`, :ref:`VisualScriptFunction`, :ref:`VisualScriptSelect` **Category:** Core diff --git a/classes/class_visualscriptoperator.rst b/classes/class_visualscriptoperator.rst index 907d428fc..4c8a5c425 100644 --- a/classes/class_visualscriptoperator.rst +++ b/classes/class_visualscriptoperator.rst @@ -31,8 +31,8 @@ Member Functions Member Variables ---------------- -- :ref:`int` **operator_value/type** -- :ref:`int` **typed_value/typed** +- :ref:`int` **operator** +- :ref:`int` **type** Member Function Description --------------------------- diff --git a/classes/class_visualscriptpropertyget.rst b/classes/class_visualscriptpropertyget.rst index 45ef31a00..fcd1097b1 100644 --- a/classes/class_visualscriptpropertyget.rst +++ b/classes/class_visualscriptpropertyget.rst @@ -29,6 +29,8 @@ Member Functions +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_call_mode` **(** **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_index` **(** **)** const | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_property` **(** **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_base_path` **(** :ref:`NodePath` base_path **)** | @@ -41,19 +43,22 @@ Member Functions +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_call_mode` **(** :ref:`int` mode **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_index` **(** :ref:`String` index **)** | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_property` **(** :ref:`String` property **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- -- :ref:`String` **property/base_script** -- :ref:`String` **property/base_type** -- :ref:`int` **property/basic_type** -- :ref:`NodePath` **property/node_path** -- :ref:`String` **property/property** -- :ref:`int` **property/set_mode** -- :ref:`int` **property/type_cache** +- :ref:`String` **base_script** +- :ref:`String` **base_type** +- :ref:`int` **basic_type** +- :ref:`String` **index** +- :ref:`NodePath` **node_path** +- :ref:`String` **property** +- :ref:`int` **set_mode** +- :ref:`int` **type_cache** Numeric Constants ----------------- @@ -85,6 +90,10 @@ Member Function Description - :ref:`int` **get_call_mode** **(** **)** const +.. _class_VisualScriptPropertyGet_get_index: + +- :ref:`String` **get_index** **(** **)** const + .. _class_VisualScriptPropertyGet_get_property: - :ref:`String` **get_property** **(** **)** const @@ -109,6 +118,10 @@ Member Function Description - void **set_call_mode** **(** :ref:`int` mode **)** +.. _class_VisualScriptPropertyGet_set_index: + +- void **set_index** **(** :ref:`String` index **)** + .. _class_VisualScriptPropertyGet_set_property: - void **set_property** **(** :ref:`String` property **)** diff --git a/classes/class_visualscriptpropertyset.rst b/classes/class_visualscriptpropertyset.rst index ab1fc3f31..4b03439d3 100644 --- a/classes/class_visualscriptpropertyset.rst +++ b/classes/class_visualscriptpropertyset.rst @@ -18,6 +18,8 @@ Brief Description Member Functions ---------------- ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_assign_op` **(** **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | :ref:`NodePath` | :ref:`get_base_path` **(** **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ @@ -29,8 +31,12 @@ Member Functions +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_call_mode` **(** **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_index` **(** **)** const | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_property` **(** **)** const | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_assign_op` **(** :ref:`int` assign_op **)** | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_base_path` **(** :ref:`NodePath` base_path **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_base_script` **(** :ref:`String` base_script **)** | @@ -41,19 +47,23 @@ Member Functions +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_call_mode` **(** :ref:`int` mode **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_index` **(** :ref:`String` index **)** | ++----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_property` **(** :ref:`String` property **)** | +----------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ Member Variables ---------------- -- :ref:`String` **property/base_script** -- :ref:`String` **property/base_type** -- :ref:`int` **property/basic_type** -- :ref:`NodePath` **property/node_path** -- :ref:`String` **property/property** -- :ref:`int` **property/set_mode** -- :ref:`int` **property/type_cache** +- :ref:`int` **assign_op** +- :ref:`String` **base_script** +- :ref:`String` **base_type** +- :ref:`int` **basic_type** +- :ref:`String` **index** +- :ref:`NodePath` **node_path** +- :ref:`String` **property** +- :ref:`int` **set_mode** +- :ref:`int` **type_cache** Numeric Constants ----------------- @@ -65,6 +75,10 @@ Numeric Constants Member Function Description --------------------------- +.. _class_VisualScriptPropertySet_get_assign_op: + +- :ref:`int` **get_assign_op** **(** **)** const + .. _class_VisualScriptPropertySet_get_base_path: - :ref:`NodePath` **get_base_path** **(** **)** const @@ -85,10 +99,18 @@ Member Function Description - :ref:`int` **get_call_mode** **(** **)** const +.. _class_VisualScriptPropertySet_get_index: + +- :ref:`String` **get_index** **(** **)** const + .. _class_VisualScriptPropertySet_get_property: - :ref:`String` **get_property** **(** **)** const +.. _class_VisualScriptPropertySet_set_assign_op: + +- void **set_assign_op** **(** :ref:`int` assign_op **)** + .. _class_VisualScriptPropertySet_set_base_path: - void **set_base_path** **(** :ref:`NodePath` base_path **)** @@ -109,6 +131,10 @@ Member Function Description - void **set_call_mode** **(** :ref:`int` mode **)** +.. _class_VisualScriptPropertySet_set_index: + +- void **set_index** **(** :ref:`String` index **)** + .. _class_VisualScriptPropertySet_set_property: - void **set_property** **(** :ref:`String` property **)** diff --git a/classes/class_visualscriptreturn.rst b/classes/class_visualscriptreturn.rst index 2886a6d58..2f60545e6 100644 --- a/classes/class_visualscriptreturn.rst +++ b/classes/class_visualscriptreturn.rst @@ -31,8 +31,8 @@ Member Functions Member Variables ---------------- -- :ref:`bool` **return_value/enabled** -- :ref:`int` **return_value/type** +- :ref:`bool` **return_enabled** +- :ref:`int` **return_type** Member Function Description --------------------------- diff --git a/classes/class_visualscriptselect.rst b/classes/class_visualscriptselect.rst new file mode 100644 index 000000000..ad1f09a6e --- /dev/null +++ b/classes/class_visualscriptselect.rst @@ -0,0 +1,43 @@ +.. Generated automatically by doc/tools/makerst.py in Godot's source tree. +.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead. + +.. _class_VisualScriptSelect: + +VisualScriptSelect +================== + +**Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` + +**Category:** Core + +Brief Description +----------------- + + + +Member Functions +---------------- + ++------------------------+-----------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_typed` **(** **)** const | ++------------------------+-----------------------------------------------------------------------------------------------+ +| void | :ref:`set_typed` **(** :ref:`int` type **)** | ++------------------------+-----------------------------------------------------------------------------------------------+ + +Member Variables +---------------- + +- :ref:`int` **type** + +Member Function Description +--------------------------- + +.. _class_VisualScriptSelect_get_typed: + +- :ref:`int` **get_typed** **(** **)** const + +.. _class_VisualScriptSelect_set_typed: + +- void **set_typed** **(** :ref:`int` type **)** + + diff --git a/classes/class_visualscripttypecast.rst b/classes/class_visualscripttypecast.rst index ddc7c149f..42a6d222f 100644 --- a/classes/class_visualscripttypecast.rst +++ b/classes/class_visualscripttypecast.rst @@ -31,8 +31,8 @@ Member Functions Member Variables ---------------- -- :ref:`String` **function/base_type** -- :ref:`String` **property/base_script** +- :ref:`String` **base_script** +- :ref:`String` **base_type** Member Function Description --------------------------- diff --git a/classes/class_visualscriptvariableget.rst b/classes/class_visualscriptvariableget.rst index 6895d3721..b02a723b6 100644 --- a/classes/class_visualscriptvariableget.rst +++ b/classes/class_visualscriptvariableget.rst @@ -27,7 +27,7 @@ Member Functions Member Variables ---------------- -- :ref:`String` **variable/name** +- :ref:`String` **var_name** Member Function Description --------------------------- diff --git a/classes/class_visualscriptvariableset.rst b/classes/class_visualscriptvariableset.rst index 711bc24c5..3a59d16fc 100644 --- a/classes/class_visualscriptvariableset.rst +++ b/classes/class_visualscriptvariableset.rst @@ -27,7 +27,7 @@ Member Functions Member Variables ---------------- -- :ref:`String` **variable/name** +- :ref:`String` **var_name** Member Function Description --------------------------- diff --git a/classes/class_visualscriptyieldsignal.rst b/classes/class_visualscriptyieldsignal.rst index 2799a2c65..13f01b4ee 100644 --- a/classes/class_visualscriptyieldsignal.rst +++ b/classes/class_visualscriptyieldsignal.rst @@ -39,10 +39,10 @@ Member Functions Member Variables ---------------- -- :ref:`String` **signal/base_type** -- :ref:`int` **signal/call_mode** -- :ref:`NodePath` **signal/node_path** -- :ref:`String` **signal/signal** +- :ref:`String` **base_type** +- :ref:`int` **call_mode** +- :ref:`NodePath` **node_path** +- :ref:`String` **signal** Numeric Constants ----------------- diff --git a/classes/class_world2d.rst b/classes/class_world2d.rst index fe3ad1c06..9e581ef7c 100644 --- a/classes/class_world2d.rst +++ b/classes/class_world2d.rst @@ -23,8 +23,6 @@ Member Functions +--------------------------------------------------------------------+----------------------------------------------------------------------------------+ | :ref:`Physics2DDirectSpaceState` | :ref:`get_direct_space_state` **(** **)** | +--------------------------------------------------------------------+----------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_sound_space` **(** **)** | -+--------------------------------------------------------------------+----------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_space` **(** **)** | +--------------------------------------------------------------------+----------------------------------------------------------------------------------+ @@ -48,12 +46,6 @@ Retrieve the :ref:`RID` of this world's canvas resource. Used by the Retrieve the state of this world's physics space. This allows arbitrary querying for collision. -.. _class_World2D_get_sound_space: - -- :ref:`RID` **get_sound_space** **(** **)** - -Retrieve the :ref:`RID` of this world's sound space resource. Used by the :ref:`SpatialSound2DServer` for 2D spatial audio. - .. _class_World2D_get_space: - :ref:`RID` **get_space** **(** **)** diff --git a/classes/class_worldenvironment.rst b/classes/class_worldenvironment.rst index c55acba34..9e33d765f 100644 --- a/classes/class_worldenvironment.rst +++ b/classes/class_worldenvironment.rst @@ -6,7 +6,7 @@ WorldEnvironment ================ -**Inherits:** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` +**Inherits:** :ref:`Node` **<** :ref:`Object` **Category:** Core