diff --git a/classes/class_@gdscript.rst b/classes/class_@gdscript.rst index 485fd466c..ec646c236 100644 --- a/classes/class_@gdscript.rst +++ b/classes/class_@gdscript.rst @@ -397,7 +397,7 @@ See also :ref:`@GlobalScope.PROPERTY_HINT_PLACEHOLDER_TEXT` | :ref:`JavaClassWrapper` | +---------------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`JavaScript` | :ref:`JavaScript` | +| :ref:`JavaScriptBridge` | :ref:`JavaScriptBridge` | +---------------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`Marshalls` | :ref:`Marshalls` | +---------------------------------------------------------------+-------------------------------------------------------------------------------------+ @@ -74,8 +74,12 @@ Properties +---------------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`PhysicsServer2D` | :ref:`PhysicsServer2D` | +---------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`PhysicsServer2DManager` | :ref:`PhysicsServer2DManager` | ++---------------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`PhysicsServer3D` | :ref:`PhysicsServer3D` | +---------------------------------------------------------------+-------------------------------------------------------------------------------------+ +| :ref:`PhysicsServer3DManager` | :ref:`PhysicsServer3DManager` | ++---------------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`ProjectSettings` | :ref:`ProjectSettings` | +---------------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`RenderingServer` | :ref:`RenderingServer` | @@ -251,7 +255,7 @@ Methods +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`randomize` **(** **)** | +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`range_lerp` **(** :ref:`float` value, :ref:`float` istart, :ref:`float` istop, :ref:`float` ostart, :ref:`float` ostop **)** | +| :ref:`float` | :ref:`remap` **(** :ref:`float` value, :ref:`float` istart, :ref:`float` istop, :ref:`float` ostart, :ref:`float` ostop **)** | +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`rid_allocate_id` **(** **)** | +-------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -1013,259 +1017,259 @@ enum **Key**: - **KEY_NONE** = **0** --- Enum value which doesn't correspond to any key. This is used to initialize :ref:`Key` properties with a generic state. -- **KEY_SPECIAL** = **16777216** --- Keycodes with this bit applied are non-printable. +- **KEY_SPECIAL** = **4194304** --- Keycodes with this bit applied are non-printable. -- **KEY_ESCAPE** = **16777217** --- Escape key. +- **KEY_ESCAPE** = **4194305** --- Escape key. -- **KEY_TAB** = **16777218** --- Tab key. +- **KEY_TAB** = **4194306** --- Tab key. -- **KEY_BACKTAB** = **16777219** --- Shift + Tab key. +- **KEY_BACKTAB** = **4194307** --- Shift + Tab key. -- **KEY_BACKSPACE** = **16777220** --- Backspace key. +- **KEY_BACKSPACE** = **4194308** --- Backspace key. -- **KEY_ENTER** = **16777221** --- Return key (on the main keyboard). +- **KEY_ENTER** = **4194309** --- Return key (on the main keyboard). -- **KEY_KP_ENTER** = **16777222** --- Enter key on the numeric keypad. +- **KEY_KP_ENTER** = **4194310** --- Enter key on the numeric keypad. -- **KEY_INSERT** = **16777223** --- Insert key. +- **KEY_INSERT** = **4194311** --- Insert key. -- **KEY_DELETE** = **16777224** --- Delete key. +- **KEY_DELETE** = **4194312** --- Delete key. -- **KEY_PAUSE** = **16777225** --- Pause key. +- **KEY_PAUSE** = **4194313** --- Pause key. -- **KEY_PRINT** = **16777226** --- Print Screen key. +- **KEY_PRINT** = **4194314** --- Print Screen key. -- **KEY_SYSREQ** = **16777227** --- System Request key. +- **KEY_SYSREQ** = **4194315** --- System Request key. -- **KEY_CLEAR** = **16777228** --- Clear key. +- **KEY_CLEAR** = **4194316** --- Clear key. -- **KEY_HOME** = **16777229** --- Home key. +- **KEY_HOME** = **4194317** --- Home key. -- **KEY_END** = **16777230** --- End key. +- **KEY_END** = **4194318** --- End key. -- **KEY_LEFT** = **16777231** --- Left arrow key. +- **KEY_LEFT** = **4194319** --- Left arrow key. -- **KEY_UP** = **16777232** --- Up arrow key. +- **KEY_UP** = **4194320** --- Up arrow key. -- **KEY_RIGHT** = **16777233** --- Right arrow key. +- **KEY_RIGHT** = **4194321** --- Right arrow key. -- **KEY_DOWN** = **16777234** --- Down arrow key. +- **KEY_DOWN** = **4194322** --- Down arrow key. -- **KEY_PAGEUP** = **16777235** --- Page Up key. +- **KEY_PAGEUP** = **4194323** --- Page Up key. -- **KEY_PAGEDOWN** = **16777236** --- Page Down key. +- **KEY_PAGEDOWN** = **4194324** --- Page Down key. -- **KEY_SHIFT** = **16777237** --- Shift key. +- **KEY_SHIFT** = **4194325** --- Shift key. -- **KEY_CTRL** = **16777238** --- Control key. +- **KEY_CTRL** = **4194326** --- Control key. -- **KEY_META** = **16777239** --- Meta key. +- **KEY_META** = **4194327** --- Meta key. -- **KEY_ALT** = **16777240** --- Alt key. +- **KEY_ALT** = **4194328** --- Alt key. -- **KEY_CAPSLOCK** = **16777241** --- Caps Lock key. +- **KEY_CAPSLOCK** = **4194329** --- Caps Lock key. -- **KEY_NUMLOCK** = **16777242** --- Num Lock key. +- **KEY_NUMLOCK** = **4194330** --- Num Lock key. -- **KEY_SCROLLLOCK** = **16777243** --- Scroll Lock key. +- **KEY_SCROLLLOCK** = **4194331** --- Scroll Lock key. -- **KEY_F1** = **16777244** --- F1 key. +- **KEY_F1** = **4194332** --- F1 key. -- **KEY_F2** = **16777245** --- F2 key. +- **KEY_F2** = **4194333** --- F2 key. -- **KEY_F3** = **16777246** --- F3 key. +- **KEY_F3** = **4194334** --- F3 key. -- **KEY_F4** = **16777247** --- F4 key. +- **KEY_F4** = **4194335** --- F4 key. -- **KEY_F5** = **16777248** --- F5 key. +- **KEY_F5** = **4194336** --- F5 key. -- **KEY_F6** = **16777249** --- F6 key. +- **KEY_F6** = **4194337** --- F6 key. -- **KEY_F7** = **16777250** --- F7 key. +- **KEY_F7** = **4194338** --- F7 key. -- **KEY_F8** = **16777251** --- F8 key. +- **KEY_F8** = **4194339** --- F8 key. -- **KEY_F9** = **16777252** --- F9 key. +- **KEY_F9** = **4194340** --- F9 key. -- **KEY_F10** = **16777253** --- F10 key. +- **KEY_F10** = **4194341** --- F10 key. -- **KEY_F11** = **16777254** --- F11 key. +- **KEY_F11** = **4194342** --- F11 key. -- **KEY_F12** = **16777255** --- F12 key. +- **KEY_F12** = **4194343** --- F12 key. -- **KEY_F13** = **16777256** --- F13 key. +- **KEY_F13** = **4194344** --- F13 key. -- **KEY_F14** = **16777257** --- F14 key. +- **KEY_F14** = **4194345** --- F14 key. -- **KEY_F15** = **16777258** --- F15 key. +- **KEY_F15** = **4194346** --- F15 key. -- **KEY_F16** = **16777259** --- F16 key. +- **KEY_F16** = **4194347** --- F16 key. -- **KEY_F17** = **16777260** --- F17 key. +- **KEY_F17** = **4194348** --- F17 key. -- **KEY_F18** = **16777261** --- F18 key. +- **KEY_F18** = **4194349** --- F18 key. -- **KEY_F19** = **16777262** --- F19 key. +- **KEY_F19** = **4194350** --- F19 key. -- **KEY_F20** = **16777263** --- F20 key. +- **KEY_F20** = **4194351** --- F20 key. -- **KEY_F21** = **16777264** --- F21 key. +- **KEY_F21** = **4194352** --- F21 key. -- **KEY_F22** = **16777265** --- F22 key. +- **KEY_F22** = **4194353** --- F22 key. -- **KEY_F23** = **16777266** --- F23 key. +- **KEY_F23** = **4194354** --- F23 key. -- **KEY_F24** = **16777267** --- F24 key. +- **KEY_F24** = **4194355** --- F24 key. -- **KEY_F25** = **16777268** --- F25 key. Only supported on macOS and Linux due to a Windows limitation. +- **KEY_F25** = **4194356** --- F25 key. Only supported on macOS and Linux due to a Windows limitation. -- **KEY_F26** = **16777269** --- F26 key. Only supported on macOS and Linux due to a Windows limitation. +- **KEY_F26** = **4194357** --- F26 key. Only supported on macOS and Linux due to a Windows limitation. -- **KEY_F27** = **16777270** --- F27 key. Only supported on macOS and Linux due to a Windows limitation. +- **KEY_F27** = **4194358** --- F27 key. Only supported on macOS and Linux due to a Windows limitation. -- **KEY_F28** = **16777271** --- F28 key. Only supported on macOS and Linux due to a Windows limitation. +- **KEY_F28** = **4194359** --- F28 key. Only supported on macOS and Linux due to a Windows limitation. -- **KEY_F29** = **16777272** --- F29 key. Only supported on macOS and Linux due to a Windows limitation. +- **KEY_F29** = **4194360** --- F29 key. Only supported on macOS and Linux due to a Windows limitation. -- **KEY_F30** = **16777273** --- F30 key. Only supported on macOS and Linux due to a Windows limitation. +- **KEY_F30** = **4194361** --- F30 key. Only supported on macOS and Linux due to a Windows limitation. -- **KEY_F31** = **16777274** --- F31 key. Only supported on macOS and Linux due to a Windows limitation. +- **KEY_F31** = **4194362** --- F31 key. Only supported on macOS and Linux due to a Windows limitation. -- **KEY_F32** = **16777275** --- F32 key. Only supported on macOS and Linux due to a Windows limitation. +- **KEY_F32** = **4194363** --- F32 key. Only supported on macOS and Linux due to a Windows limitation. -- **KEY_F33** = **16777276** --- F33 key. Only supported on macOS and Linux due to a Windows limitation. +- **KEY_F33** = **4194364** --- F33 key. Only supported on macOS and Linux due to a Windows limitation. -- **KEY_F34** = **16777277** --- F34 key. Only supported on macOS and Linux due to a Windows limitation. +- **KEY_F34** = **4194365** --- F34 key. Only supported on macOS and Linux due to a Windows limitation. -- **KEY_F35** = **16777278** --- F35 key. Only supported on macOS and Linux due to a Windows limitation. +- **KEY_F35** = **4194366** --- F35 key. Only supported on macOS and Linux due to a Windows limitation. -- **KEY_KP_MULTIPLY** = **16777345** --- Multiply (\*) key on the numeric keypad. +- **KEY_KP_MULTIPLY** = **4194433** --- Multiply (\*) key on the numeric keypad. -- **KEY_KP_DIVIDE** = **16777346** --- Divide (/) key on the numeric keypad. +- **KEY_KP_DIVIDE** = **4194434** --- Divide (/) key on the numeric keypad. -- **KEY_KP_SUBTRACT** = **16777347** --- Subtract (-) key on the numeric keypad. +- **KEY_KP_SUBTRACT** = **4194435** --- Subtract (-) key on the numeric keypad. -- **KEY_KP_PERIOD** = **16777348** --- Period (.) key on the numeric keypad. +- **KEY_KP_PERIOD** = **4194436** --- Period (.) key on the numeric keypad. -- **KEY_KP_ADD** = **16777349** --- Add (+) key on the numeric keypad. +- **KEY_KP_ADD** = **4194437** --- Add (+) key on the numeric keypad. -- **KEY_KP_0** = **16777350** --- Number 0 on the numeric keypad. +- **KEY_KP_0** = **4194438** --- Number 0 on the numeric keypad. -- **KEY_KP_1** = **16777351** --- Number 1 on the numeric keypad. +- **KEY_KP_1** = **4194439** --- Number 1 on the numeric keypad. -- **KEY_KP_2** = **16777352** --- Number 2 on the numeric keypad. +- **KEY_KP_2** = **4194440** --- Number 2 on the numeric keypad. -- **KEY_KP_3** = **16777353** --- Number 3 on the numeric keypad. +- **KEY_KP_3** = **4194441** --- Number 3 on the numeric keypad. -- **KEY_KP_4** = **16777354** --- Number 4 on the numeric keypad. +- **KEY_KP_4** = **4194442** --- Number 4 on the numeric keypad. -- **KEY_KP_5** = **16777355** --- Number 5 on the numeric keypad. +- **KEY_KP_5** = **4194443** --- Number 5 on the numeric keypad. -- **KEY_KP_6** = **16777356** --- Number 6 on the numeric keypad. +- **KEY_KP_6** = **4194444** --- Number 6 on the numeric keypad. -- **KEY_KP_7** = **16777357** --- Number 7 on the numeric keypad. +- **KEY_KP_7** = **4194445** --- Number 7 on the numeric keypad. -- **KEY_KP_8** = **16777358** --- Number 8 on the numeric keypad. +- **KEY_KP_8** = **4194446** --- Number 8 on the numeric keypad. -- **KEY_KP_9** = **16777359** --- Number 9 on the numeric keypad. +- **KEY_KP_9** = **4194447** --- Number 9 on the numeric keypad. -- **KEY_SUPER_L** = **16777280** --- Left Super key (Windows key). +- **KEY_SUPER_L** = **4194368** --- Left Super key (Windows key). -- **KEY_SUPER_R** = **16777281** --- Right Super key (Windows key). +- **KEY_SUPER_R** = **4194369** --- Right Super key (Windows key). -- **KEY_MENU** = **16777282** --- Context menu key. +- **KEY_MENU** = **4194370** --- Context menu key. -- **KEY_HYPER_L** = **16777283** --- Left Hyper key. +- **KEY_HYPER_L** = **4194371** --- Left Hyper key. -- **KEY_HYPER_R** = **16777284** --- Right Hyper key. +- **KEY_HYPER_R** = **4194372** --- Right Hyper key. -- **KEY_HELP** = **16777285** --- Help key. +- **KEY_HELP** = **4194373** --- Help key. -- **KEY_DIRECTION_L** = **16777286** --- Left Direction key. +- **KEY_DIRECTION_L** = **4194374** --- Left Direction key. -- **KEY_DIRECTION_R** = **16777287** --- Right Direction key. +- **KEY_DIRECTION_R** = **4194375** --- Right Direction key. -- **KEY_BACK** = **16777288** --- Media back key. Not to be confused with the Back button on an Android device. +- **KEY_BACK** = **4194376** --- Media back key. Not to be confused with the Back button on an Android device. -- **KEY_FORWARD** = **16777289** --- Media forward key. +- **KEY_FORWARD** = **4194377** --- Media forward key. -- **KEY_STOP** = **16777290** --- Media stop key. +- **KEY_STOP** = **4194378** --- Media stop key. -- **KEY_REFRESH** = **16777291** --- Media refresh key. +- **KEY_REFRESH** = **4194379** --- Media refresh key. -- **KEY_VOLUMEDOWN** = **16777292** --- Volume down key. +- **KEY_VOLUMEDOWN** = **4194380** --- Volume down key. -- **KEY_VOLUMEMUTE** = **16777293** --- Mute volume key. +- **KEY_VOLUMEMUTE** = **4194381** --- Mute volume key. -- **KEY_VOLUMEUP** = **16777294** --- Volume up key. +- **KEY_VOLUMEUP** = **4194382** --- Volume up key. -- **KEY_BASSBOOST** = **16777295** --- Bass Boost key. +- **KEY_BASSBOOST** = **4194383** --- Bass Boost key. -- **KEY_BASSUP** = **16777296** --- Bass up key. +- **KEY_BASSUP** = **4194384** --- Bass up key. -- **KEY_BASSDOWN** = **16777297** --- Bass down key. +- **KEY_BASSDOWN** = **4194385** --- Bass down key. -- **KEY_TREBLEUP** = **16777298** --- Treble up key. +- **KEY_TREBLEUP** = **4194386** --- Treble up key. -- **KEY_TREBLEDOWN** = **16777299** --- Treble down key. +- **KEY_TREBLEDOWN** = **4194387** --- Treble down key. -- **KEY_MEDIAPLAY** = **16777300** --- Media play key. +- **KEY_MEDIAPLAY** = **4194388** --- Media play key. -- **KEY_MEDIASTOP** = **16777301** --- Media stop key. +- **KEY_MEDIASTOP** = **4194389** --- Media stop key. -- **KEY_MEDIAPREVIOUS** = **16777302** --- Previous song key. +- **KEY_MEDIAPREVIOUS** = **4194390** --- Previous song key. -- **KEY_MEDIANEXT** = **16777303** --- Next song key. +- **KEY_MEDIANEXT** = **4194391** --- Next song key. -- **KEY_MEDIARECORD** = **16777304** --- Media record key. +- **KEY_MEDIARECORD** = **4194392** --- Media record key. -- **KEY_HOMEPAGE** = **16777305** --- Home page key. +- **KEY_HOMEPAGE** = **4194393** --- Home page key. -- **KEY_FAVORITES** = **16777306** --- Favorites key. +- **KEY_FAVORITES** = **4194394** --- Favorites key. -- **KEY_SEARCH** = **16777307** --- Search key. +- **KEY_SEARCH** = **4194395** --- Search key. -- **KEY_STANDBY** = **16777308** --- Standby key. +- **KEY_STANDBY** = **4194396** --- Standby key. -- **KEY_OPENURL** = **16777309** --- Open URL / Launch Browser key. +- **KEY_OPENURL** = **4194397** --- Open URL / Launch Browser key. -- **KEY_LAUNCHMAIL** = **16777310** --- Launch Mail key. +- **KEY_LAUNCHMAIL** = **4194398** --- Launch Mail key. -- **KEY_LAUNCHMEDIA** = **16777311** --- Launch Media key. +- **KEY_LAUNCHMEDIA** = **4194399** --- Launch Media key. -- **KEY_LAUNCH0** = **16777312** --- Launch Shortcut 0 key. +- **KEY_LAUNCH0** = **4194400** --- Launch Shortcut 0 key. -- **KEY_LAUNCH1** = **16777313** --- Launch Shortcut 1 key. +- **KEY_LAUNCH1** = **4194401** --- Launch Shortcut 1 key. -- **KEY_LAUNCH2** = **16777314** --- Launch Shortcut 2 key. +- **KEY_LAUNCH2** = **4194402** --- Launch Shortcut 2 key. -- **KEY_LAUNCH3** = **16777315** --- Launch Shortcut 3 key. +- **KEY_LAUNCH3** = **4194403** --- Launch Shortcut 3 key. -- **KEY_LAUNCH4** = **16777316** --- Launch Shortcut 4 key. +- **KEY_LAUNCH4** = **4194404** --- Launch Shortcut 4 key. -- **KEY_LAUNCH5** = **16777317** --- Launch Shortcut 5 key. +- **KEY_LAUNCH5** = **4194405** --- Launch Shortcut 5 key. -- **KEY_LAUNCH6** = **16777318** --- Launch Shortcut 6 key. +- **KEY_LAUNCH6** = **4194406** --- Launch Shortcut 6 key. -- **KEY_LAUNCH7** = **16777319** --- Launch Shortcut 7 key. +- **KEY_LAUNCH7** = **4194407** --- Launch Shortcut 7 key. -- **KEY_LAUNCH8** = **16777320** --- Launch Shortcut 8 key. +- **KEY_LAUNCH8** = **4194408** --- Launch Shortcut 8 key. -- **KEY_LAUNCH9** = **16777321** --- Launch Shortcut 9 key. +- **KEY_LAUNCH9** = **4194409** --- Launch Shortcut 9 key. -- **KEY_LAUNCHA** = **16777322** --- Launch Shortcut A key. +- **KEY_LAUNCHA** = **4194410** --- Launch Shortcut A key. -- **KEY_LAUNCHB** = **16777323** --- Launch Shortcut B key. +- **KEY_LAUNCHB** = **4194411** --- Launch Shortcut B key. -- **KEY_LAUNCHC** = **16777324** --- Launch Shortcut C key. +- **KEY_LAUNCHC** = **4194412** --- Launch Shortcut C key. -- **KEY_LAUNCHD** = **16777325** --- Launch Shortcut D key. +- **KEY_LAUNCHD** = **4194413** --- Launch Shortcut D key. -- **KEY_LAUNCHE** = **16777326** --- Launch Shortcut E key. +- **KEY_LAUNCHE** = **4194414** --- Launch Shortcut E key. -- **KEY_LAUNCHF** = **16777327** --- Launch Shortcut F key. +- **KEY_LAUNCHF** = **4194415** --- Launch Shortcut F key. -- **KEY_UNKNOWN** = **33554431** --- Unknown key. +- **KEY_UNKNOWN** = **16777215** --- Unknown key. - **KEY_SPACE** = **32** --- Space key. @@ -1545,6 +1549,8 @@ enum **Key**: .. _class_@GlobalScope_constant_KEY_MODIFIER_MASK: +.. _class_@GlobalScope_constant_KEY_MASK_CMD_OR_CTRL: + .. _class_@GlobalScope_constant_KEY_MASK_SHIFT: .. _class_@GlobalScope_constant_KEY_MASK_ALT: @@ -1553,28 +1559,26 @@ enum **Key**: .. _class_@GlobalScope_constant_KEY_MASK_CTRL: -.. _class_@GlobalScope_constant_KEY_MASK_CMD: - .. _class_@GlobalScope_constant_KEY_MASK_KPAD: .. _class_@GlobalScope_constant_KEY_MASK_GROUP_SWITCH: enum **KeyModifierMask**: -- **KEY_CODE_MASK** = **33554431** --- Key Code mask. +- **KEY_CODE_MASK** = **8388607** --- Key Code mask. -- **KEY_MODIFIER_MASK** = **2130706432** --- Modifier key mask. +- **KEY_MODIFIER_MASK** = **532676608** --- Modifier key mask. + +- **KEY_MASK_CMD_OR_CTRL** = **16777216** --- Automatically remapped to :ref:`KEY_META` on macOS and :ref:`KEY_CTRL` on other platforms, this mask is never set in the actual events, and should be used for key mapping only. - **KEY_MASK_SHIFT** = **33554432** --- Shift key mask. -- **KEY_MASK_ALT** = **67108864** --- Alt key mask. +- **KEY_MASK_ALT** = **67108864** --- Alt or Option (on macOS) key mask. -- **KEY_MASK_META** = **134217728** --- Meta key mask. +- **KEY_MASK_META** = **134217728** --- Command (on macOS) or Meta/Windows key mask. - **KEY_MASK_CTRL** = **268435456** --- Ctrl key mask. -- **KEY_MASK_CMD** = **platform-dependent** --- Command key mask. On macOS, this is equivalent to :ref:`KEY_MASK_META`. On other platforms, this is equivalent to :ref:`KEY_MASK_CTRL`. This mask should be preferred to :ref:`KEY_MASK_META` or :ref:`KEY_MASK_CTRL` for system shortcuts as it handles all platforms correctly. - - **KEY_MASK_KPAD** = **536870912** --- Keypad key mask. - **KEY_MASK_GROUP_SWITCH** = **1073741824** --- Group Switch key mask. @@ -2194,7 +2198,7 @@ enum **PropertyHint**: - **PROPERTY_HINT_NONE** = **0** --- No hint for the edited property. -- **PROPERTY_HINT_RANGE** = **1** --- Hints that an integer or float property should be within a range specified via the hint string ``"min,max"`` or ``"min,max,step"``. The hint string can optionally include ``"or_greater"`` and/or ``"or_lesser"`` to allow manual input going respectively above the max or below the min values. Example: ``"-360,360,1,or_greater,or_lesser"``. +- **PROPERTY_HINT_RANGE** = **1** --- Hints that an integer or float property should be within a range specified via the hint string ``"min,max"`` or ``"min,max,step"``. The hint string can optionally include ``"or_greater"`` and/or ``"or_less"`` to allow manual input going respectively above the max or below the min values. Example: ``"-360,360,1,or_greater,or_less"``. Additionally, other keywords can be included: ``"exp"`` for exponential range editing, ``"radians"`` for editing radian angles in degrees, ``"degrees"`` to hint at an angle and ``"no_slider"`` to hide the slider. @@ -2856,11 +2860,11 @@ The :ref:`JavaClassWrapper` singleton. ---- -.. _class_@GlobalScope_property_JavaScript: +.. _class_@GlobalScope_property_JavaScriptBridge: -- :ref:`JavaScript` **JavaScript** +- :ref:`JavaScriptBridge` **JavaScriptBridge** -The :ref:`JavaScript` singleton. +The :ref:`JavaScriptBridge` singleton. \ **Note:** Only implemented on the Web platform. @@ -2928,6 +2932,14 @@ The :ref:`PhysicsServer2D` singleton. ---- +.. _class_@GlobalScope_property_PhysicsServer2DManager: + +- :ref:`PhysicsServer2DManager` **PhysicsServer2DManager** + +The :ref:`PhysicsServer2DManager` singleton. + +---- + .. _class_@GlobalScope_property_PhysicsServer3D: - :ref:`PhysicsServer3D` **PhysicsServer3D** @@ -2936,6 +2948,14 @@ The :ref:`PhysicsServer3D` singleton. ---- +.. _class_@GlobalScope_property_PhysicsServer3DManager: + +- :ref:`PhysicsServer3DManager` **PhysicsServer3DManager** + +The :ref:`PhysicsServer3DManager` singleton. + +---- + .. _class_@GlobalScope_property_ProjectSettings: - :ref:`ProjectSettings` **ProjectSettings** @@ -3517,7 +3537,7 @@ Returns an interpolation or extrapolation factor considering the range specified var ratio = inverse_lerp(20, 30, 27.5) # `ratio` is now 0.75. -See also :ref:`lerp` which performs the reverse of this operation, and :ref:`range_lerp` to map a continuous series of values to another. +See also :ref:`lerp` which performs the reverse of this operation, and :ref:`remap` to map a continuous series of values to another. ---- @@ -3587,7 +3607,7 @@ Both ``from`` and ``to`` must have matching types. Supported types: :ref:`float< lerp(0, 4, 0.75) # Returns 3.0 -See also :ref:`inverse_lerp` which performs the reverse of this operation. To perform eased interpolation with :ref:`lerp`, combine it with :ref:`ease` or :ref:`smoothstep`. See also :ref:`range_lerp` to map a continuous series of values to another. +See also :ref:`inverse_lerp` which performs the reverse of this operation. To perform eased interpolation with :ref:`lerp`, combine it with :ref:`ease` or :ref:`smoothstep`. See also :ref:`remap` to map a continuous series of values to another. \ **Note:** For better type safety, you can use :ref:`lerpf`, :ref:`Vector2.lerp`, :ref:`Vector3.lerp`, :ref:`Vector4.lerp`, :ref:`Color.lerp`, :ref:`Quaternion.slerp` or :ref:`Basis.slerp` instead. @@ -4038,15 +4058,15 @@ Randomizes the seed (or the internal state) of the random number generator. Curr ---- -.. _class_@GlobalScope_method_range_lerp: +.. _class_@GlobalScope_method_remap: -- :ref:`float` **range_lerp** **(** :ref:`float` value, :ref:`float` istart, :ref:`float` istop, :ref:`float` ostart, :ref:`float` ostop **)** +- :ref:`float` **remap** **(** :ref:`float` value, :ref:`float` istart, :ref:`float` istop, :ref:`float` ostart, :ref:`float` ostop **)** -Maps a ``value`` from range ``[istart, istop]`` to ``[ostart, ostop]``. See also :ref:`lerp` and :ref:`inverse_lerp`. If ``value`` is outside ``[istart, istop]``, then the resulting value will also be outside ``[ostart, ostop]``. Use :ref:`clamp` on the result of :ref:`range_lerp` if this is not desired. +Maps a ``value`` from range ``[istart, istop]`` to ``[ostart, ostop]``. See also :ref:`lerp` and :ref:`inverse_lerp`. If ``value`` is outside ``[istart, istop]``, then the resulting value will also be outside ``[ostart, ostop]``. Use :ref:`clamp` on the result of :ref:`remap` if this is not desired. :: - range_lerp(75, 0, 100, -1, 1) # Returns 0.5 + remap(75, 0, 100, -1, 1) # Returns 0.5 For complex use cases where you need multiple ranges, consider using :ref:`Curve` or :ref:`Gradient` instead. diff --git a/classes/class_aabb.rst b/classes/class_aabb.rst index 0bdfb795c..82c1e3ff8 100644 --- a/classes/class_aabb.rst +++ b/classes/class_aabb.rst @@ -86,12 +86,12 @@ Methods +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AABB` | :ref:`grow` **(** :ref:`float` by **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_no_surface` **(** **)** |const| | -+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_no_volume` **(** **)** |const| | -+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_point` **(** :ref:`Vector3` point **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_surface` **(** **)** |const| | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_volume` **(** **)** |const| | ++-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AABB` | :ref:`intersection` **(** :ref:`AABB` with **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`intersects` **(** :ref:`AABB` with **)** |const| | @@ -314,22 +314,6 @@ Returns a copy of the ``AABB`` grown a given number of units towards all the sid ---- -.. _class_AABB_method_has_no_surface: - -- :ref:`bool` **has_no_surface** **(** **)** |const| - -Returns ``true`` if the ``AABB`` is empty. - ----- - -.. _class_AABB_method_has_no_volume: - -- :ref:`bool` **has_no_volume** **(** **)** |const| - -Returns ``true`` if the ``AABB`` is flat or empty. - ----- - .. _class_AABB_method_has_point: - :ref:`bool` **has_point** **(** :ref:`Vector3` point **)** |const| @@ -340,6 +324,22 @@ Returns ``true`` if the ``AABB`` contains a point. Points on the faces of the AA ---- +.. _class_AABB_method_has_surface: + +- :ref:`bool` **has_surface** **(** **)** |const| + +Returns ``true`` if the ``AABB`` has a surface or a length, and ``false`` if the ``AABB`` is empty (all components of :ref:`size` are zero or negative). + +---- + +.. _class_AABB_method_has_volume: + +- :ref:`bool` **has_volume** **(** **)** |const| + +Returns ``true`` if the ``AABB`` has a volume, and ``false`` if the ``AABB`` is flat, empty, or has a negative :ref:`size`. + +---- + .. _class_AABB_method_intersection: - :ref:`AABB` **intersection** **(** :ref:`AABB` with **)** |const| diff --git a/classes/class_acceptdialog.rst b/classes/class_acceptdialog.rst index 674d36184..e734c1bc4 100644 --- a/classes/class_acceptdialog.rst +++ b/classes/class_acceptdialog.rst @@ -66,9 +66,11 @@ Methods Theme Properties ---------------- -+---------------------------------+----------------------------------------------------+ -| :ref:`StyleBox` | :ref:`panel` | -+---------------------------------+----------------------------------------------------+ ++---------------------------------+---------------------------------------------------------------------------------+--------+ +| :ref:`int` | :ref:`buttons_separation` | ``10`` | ++---------------------------------+---------------------------------------------------------------------------------+--------+ +| :ref:`StyleBox` | :ref:`panel` | | ++---------------------------------+---------------------------------------------------------------------------------+--------+ Signals ------- @@ -240,11 +242,23 @@ Removes the ``button`` from the dialog. Does NOT free the ``button``. The ``butt Theme Property Descriptions --------------------------- +.. _class_AcceptDialog_theme_constant_buttons_separation: + +- :ref:`int` **buttons_separation** + ++-----------+--------+ +| *Default* | ``10`` | ++-----------+--------+ + +The size of the vertical space between the dialog's content and the button row. + +---- + .. _class_AcceptDialog_theme_style_panel: - :ref:`StyleBox` **panel** -Panel that fills up the background of the window. +The panel that fills the background of the window. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_animatedsprite3d.rst b/classes/class_animatedsprite3d.rst index 29156a58b..f2ccf1902 100644 --- a/classes/class_animatedsprite3d.rst +++ b/classes/class_animatedsprite3d.rst @@ -40,13 +40,11 @@ Properties Methods ------- -+-------------------------+----------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_playing` **(** **)** |const| | -+-------------------------+----------------------------------------------------------------------------------------------------------+ -| void | :ref:`play` **(** :ref:`StringName` anim=&"" **)** | -+-------------------------+----------------------------------------------------------------------------------------------------------+ -| void | :ref:`stop` **(** **)** | -+-------------------------+----------------------------------------------------------------------------------------------------------+ ++------+----------------------------------------------------------------------------------------------------------+ +| void | :ref:`play` **(** :ref:`StringName` anim=&"" **)** | ++------+----------------------------------------------------------------------------------------------------------+ +| void | :ref:`stop` **(** **)** | ++------+----------------------------------------------------------------------------------------------------------+ Signals ------- @@ -118,23 +116,19 @@ The :ref:`SpriteFrames` resource containing the animation(s) - :ref:`bool` **playing** -+-----------+-----------+ -| *Default* | ``false`` | -+-----------+-----------+ ++-----------+--------------------+ +| *Default* | ``false`` | ++-----------+--------------------+ +| *Setter* | set_playing(value) | ++-----------+--------------------+ +| *Getter* | is_playing() | ++-----------+--------------------+ If ``true``, the :ref:`animation` is currently playing. Method Descriptions ------------------- -.. _class_AnimatedSprite3D_method_is_playing: - -- :ref:`bool` **is_playing** **(** **)** |const| - -Returns ``true`` if an animation is currently being played. - ----- - .. _class_AnimatedSprite3D_method_play: - void **play** **(** :ref:`StringName` anim=&"" **)** diff --git a/classes/class_animatedtexture.rst b/classes/class_animatedtexture.rst index e8cf4ac00..ce7c08c76 100644 --- a/classes/class_animatedtexture.rst +++ b/classes/class_animatedtexture.rst @@ -19,7 +19,7 @@ Description ``AnimatedTexture`` is a resource format for frame-based animations, where multiple textures can be chained automatically with a predefined delay for each frame. Unlike :ref:`AnimationPlayer` or :ref:`AnimatedSprite2D`, it isn't a :ref:`Node`, but has the advantage of being usable anywhere a :ref:`Texture2D` resource can be used, e.g. in a :ref:`TileSet`. -The playback of the animation is controlled by the :ref:`fps` property as well as each frame's optional delay (see :ref:`set_frame_delay`). The animation loops, i.e. it will restart at frame 0 automatically after playing the last frame. +The playback of the animation is controlled by the :ref:`speed_scale` property, as well as each frame's duration (see :ref:`set_frame_duration`). The animation loops, i.e. it will restart at frame 0 automatically after playing the last frame. \ ``AnimatedTexture`` currently requires all frame textures to have the same size, otherwise the bigger ones will be cropped to match the smallest one. @@ -31,24 +31,24 @@ Properties +---------------------------+--------------------------------------------------------------------+-----------+ | :ref:`int` | :ref:`current_frame` | | +---------------------------+--------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`fps` | ``4.0`` | -+---------------------------+--------------------------------------------------------------------+-----------+ | :ref:`int` | :ref:`frames` | ``1`` | +---------------------------+--------------------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`oneshot` | ``false`` | +| :ref:`bool` | :ref:`one_shot` | ``false`` | +---------------------------+--------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`pause` | ``false`` | +---------------------------+--------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`speed_scale` | ``1.0`` | ++---------------------------+--------------------------------------------------------------------+-----------+ Methods ------- +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_frame_delay` **(** :ref:`int` frame **)** |const| | +| :ref:`float` | :ref:`get_frame_duration` **(** :ref:`int` frame **)** |const| | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture2D` | :ref:`get_frame_texture` **(** :ref:`int` frame **)** |const| | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_frame_delay` **(** :ref:`int` frame, :ref:`float` delay **)** | +| void | :ref:`set_frame_duration` **(** :ref:`int` frame, :ref:`float` duration **)** | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_frame_texture` **(** :ref:`int` frame, :ref:`Texture2D` texture **)** | +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -77,24 +77,6 @@ Sets the currently visible frame of the texture. ---- -.. _class_AnimatedTexture_property_fps: - -- :ref:`float` **fps** - -+-----------+----------------+ -| *Default* | ``4.0`` | -+-----------+----------------+ -| *Setter* | set_fps(value) | -+-----------+----------------+ -| *Getter* | get_fps() | -+-----------+----------------+ - -Animation speed in frames per second. This value defines the default time interval between two frames of the animation, and thus the overall duration of the animation loop based on the :ref:`frames` property. A value of 0 means no predefined number of frames per second, the animation will play according to each frame's frame delay (see :ref:`set_frame_delay`). - -For example, an animation with 8 frames, no frame delay and a ``fps`` value of 2 will run for 4 seconds, with each frame lasting 0.5 seconds. - ----- - .. _class_AnimatedTexture_property_frames: - :ref:`int` **frames** @@ -111,17 +93,17 @@ Number of frames to use in the animation. While you can create the frames indepe ---- -.. _class_AnimatedTexture_property_oneshot: +.. _class_AnimatedTexture_property_one_shot: -- :ref:`bool` **oneshot** +- :ref:`bool` **one_shot** -+-----------+--------------------+ -| *Default* | ``false`` | -+-----------+--------------------+ -| *Setter* | set_oneshot(value) | -+-----------+--------------------+ -| *Getter* | get_oneshot() | -+-----------+--------------------+ ++-----------+---------------------+ +| *Default* | ``false`` | ++-----------+---------------------+ +| *Setter* | set_one_shot(value) | ++-----------+---------------------+ +| *Getter* | get_one_shot() | ++-----------+---------------------+ If ``true``, the animation will only play once and will not loop back to the first frame after reaching the end. Note that reaching the end will not set :ref:`pause` to ``true``. @@ -141,14 +123,30 @@ If ``true``, the animation will only play once and will not loop back to the fir If ``true``, the animation will pause where it currently is (i.e. at :ref:`current_frame`). The animation will continue from where it was paused when changing this property to ``false``. +---- + +.. _class_AnimatedTexture_property_speed_scale: + +- :ref:`float` **speed_scale** + ++-----------+------------------------+ +| *Default* | ``1.0`` | ++-----------+------------------------+ +| *Setter* | set_speed_scale(value) | ++-----------+------------------------+ +| *Getter* | get_speed_scale() | ++-----------+------------------------+ + +The animation speed is multiplied by this value. If set to a negative value, the animation is played in reverse. + Method Descriptions ------------------- -.. _class_AnimatedTexture_method_get_frame_delay: +.. _class_AnimatedTexture_method_get_frame_duration: -- :ref:`float` **get_frame_delay** **(** :ref:`int` frame **)** |const| +- :ref:`float` **get_frame_duration** **(** :ref:`int` frame **)** |const| -Returns the given frame's delay value. +Returns the given ``frame``'s duration, in seconds. ---- @@ -160,20 +158,11 @@ Returns the given frame's :ref:`Texture2D`. ---- -.. _class_AnimatedTexture_method_set_frame_delay: +.. _class_AnimatedTexture_method_set_frame_duration: -- void **set_frame_delay** **(** :ref:`int` frame, :ref:`float` delay **)** +- void **set_frame_duration** **(** :ref:`int` frame, :ref:`float` duration **)** -Sets an additional delay (in seconds) between this frame and the next one, that will be added to the time interval defined by :ref:`fps`. By default, frames have no delay defined. If a delay value is defined, the final time interval between this frame and the next will be ``1.0 / fps + delay``. - -For example, for an animation with 3 frames, 2 FPS and a frame delay on the second frame of 1.2, the resulting playback will be: - -:: - - Frame 0: 0.5 s (1 / fps) - Frame 1: 1.7 s (1 / fps + 1.2) - Frame 2: 0.5 s (1 / fps) - Total duration: 2.7 s +Sets the duration of any given ``frame``. The final duration is affected by the :ref:`speed_scale`. If set to ``0``, the frame is skipped during playback. ---- diff --git a/classes/class_arraymesh.rst b/classes/class_arraymesh.rst index ddadfc02b..33b92bcdb 100644 --- a/classes/class_arraymesh.rst +++ b/classes/class_arraymesh.rst @@ -87,45 +87,45 @@ Properties Methods ------- -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_blend_shape` **(** :ref:`StringName` name **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_surface_from_arrays` **(** :ref:`PrimitiveType` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[], :ref:`Dictionary` lods={}, :ref:`int` compress_flags=0 **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_blend_shapes` **(** **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear_surfaces` **(** **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_blend_shape_count` **(** **)** |const| | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StringName` | :ref:`get_blend_shape_name` **(** :ref:`int` index **)** |const| | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`lightmap_unwrap` **(** :ref:`Transform3D` transform, :ref:`float` texel_size **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`regen_normal_maps` **(** **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_blend_shape_name` **(** :ref:`int` index, :ref:`StringName` name **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`surface_find_by_name` **(** :ref:`String` name **)** |const| | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`surface_get_array_index_len` **(** :ref:`int` surf_idx **)** |const| | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`surface_get_array_len` **(** :ref:`int` surf_idx **)** |const| | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`surface_get_format` **(** :ref:`int` surf_idx **)** |const| | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`surface_get_name` **(** :ref:`int` surf_idx **)** |const| | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PrimitiveType` | :ref:`surface_get_primitive_type` **(** :ref:`int` surf_idx **)** |const| | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`surface_set_name` **(** :ref:`int` surf_idx, :ref:`String` name **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`surface_update_attribute_region` **(** :ref:`int` surf_idx, :ref:`int` offset, :ref:`PackedByteArray` data **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`surface_update_skin_region` **(** :ref:`int` surf_idx, :ref:`int` offset, :ref:`PackedByteArray` data **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`surface_update_vertex_region` **(** :ref:`int` surf_idx, :ref:`int` offset, :ref:`PackedByteArray` data **)** | -+-----------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_blend_shape` **(** :ref:`StringName` name **)** | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_surface_from_arrays` **(** :ref:`PrimitiveType` primitive, :ref:`Array` arrays, :ref:`Array[]` blend_shapes=[], :ref:`Dictionary` lods={}, :ref:`int` compress_flags=0 **)** | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_blend_shapes` **(** **)** | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear_surfaces` **(** **)** | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_blend_shape_count` **(** **)** |const| | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`StringName` | :ref:`get_blend_shape_name` **(** :ref:`int` index **)** |const| | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`lightmap_unwrap` **(** :ref:`Transform3D` transform, :ref:`float` texel_size **)** | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`regen_normal_maps` **(** **)** | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_blend_shape_name` **(** :ref:`int` index, :ref:`StringName` name **)** | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`surface_find_by_name` **(** :ref:`String` name **)** |const| | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`surface_get_array_index_len` **(** :ref:`int` surf_idx **)** |const| | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`surface_get_array_len` **(** :ref:`int` surf_idx **)** |const| | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`surface_get_format` **(** :ref:`int` surf_idx **)** |const| | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`surface_get_name` **(** :ref:`int` surf_idx **)** |const| | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PrimitiveType` | :ref:`surface_get_primitive_type` **(** :ref:`int` surf_idx **)** |const| | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`surface_set_name` **(** :ref:`int` surf_idx, :ref:`String` name **)** | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`surface_update_attribute_region` **(** :ref:`int` surf_idx, :ref:`int` offset, :ref:`PackedByteArray` data **)** | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`surface_update_skin_region` **(** :ref:`int` surf_idx, :ref:`int` offset, :ref:`PackedByteArray` data **)** | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`surface_update_vertex_region` **(** :ref:`int` surf_idx, :ref:`int` offset, :ref:`PackedByteArray` data **)** | ++-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- @@ -185,7 +185,7 @@ Adds name for a blend shape that will be added with :ref:`add_surface_from_array .. _class_ArrayMesh_method_add_surface_from_arrays: -- void **add_surface_from_arrays** **(** :ref:`PrimitiveType` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[], :ref:`Dictionary` lods={}, :ref:`int` compress_flags=0 **)** +- void **add_surface_from_arrays** **(** :ref:`PrimitiveType` primitive, :ref:`Array` arrays, :ref:`Array[]` blend_shapes=[], :ref:`Dictionary` lods={}, :ref:`int` compress_flags=0 **)** Creates a new surface. diff --git a/classes/class_astargrid2d.rst b/classes/class_astargrid2d.rst index 0a2a4020e..a3f11d372 100644 --- a/classes/class_astargrid2d.rst +++ b/classes/class_astargrid2d.rst @@ -12,7 +12,23 @@ AStarGrid2D **Inherits:** :ref:`RefCounted` **<** :ref:`Object` +A\* (or "A-Star") pathfinding tailored to find the shortest paths on 2D grids. +Description +----------- + +Compared to :ref:`AStar2D` you don't need to manually create points or connect them together. It also supports multiple type of heuristics and modes for diagonal movement. This class also provides a jumping mode which is faster to calculate than without it in the :ref:`AStar2D` class. + +In contrast to :ref:`AStar2D`, you only need set the :ref:`size` of the grid, optionally set the :ref:`cell_size` and then call the :ref:`update` method: + +:: + + var astar_grid = AStarGrid2D.new() + astar_grid.size = Vector2i(32, 32) + astar_grid.cell_size = Vector2(16, 16) + astar_grid.update() + print(astar_grid.get_id_path(Vector2i(0, 0), Vector2i(3, 4))) # prints (0, 0), (1, 1), (2, 2), (3, 3), (3, 4) + print(astar_grid.get_point_path(Vector2i(0, 0), Vector2i(3, 4))) # prints (0, 0), (16, 16), (32, 32), (48, 48), (48, 64) Properties ---------- @@ -75,15 +91,40 @@ Enumerations enum **Heuristic**: -- **HEURISTIC_EUCLIDEAN** = **0** +- **HEURISTIC_EUCLIDEAN** = **0** --- The Euclidean heuristic to be used for the pathfinding using the following formula: -- **HEURISTIC_MANHATTAN** = **1** +:: -- **HEURISTIC_OCTILE** = **2** + dx = abs(to_id.x - from_id.x) + dy = abs(to_id.y - from_id.y) + result = sqrt(dx * dx + dy * dy) -- **HEURISTIC_CHEBYSHEV** = **3** +- **HEURISTIC_MANHATTAN** = **1** --- The Manhattan heuristic to be used for the pathfinding using the following formula: -- **HEURISTIC_MAX** = **4** +:: + + dx = abs(to_id.x - from_id.x) + dy = abs(to_id.y - from_id.y) + result = dx + dy + +- **HEURISTIC_OCTILE** = **2** --- The Octile heuristic to be used for the pathfinding using the following formula: + +:: + + dx = abs(to_id.x - from_id.x) + dy = abs(to_id.y - from_id.y) + f = sqrt(2) - 1 + result = (dx < dy) ? f * dx + dy : f * dy + dx; + +- **HEURISTIC_CHEBYSHEV** = **3** --- The Chebyshev heuristic to be used for the pathfinding using the following formula: + +:: + + dx = abs(to_id.x - from_id.x) + dy = abs(to_id.y - from_id.y) + result = max(dx, dy) + +- **HEURISTIC_MAX** = **4** --- Represents the size of the :ref:`Heuristic` enum. ---- @@ -101,15 +142,15 @@ enum **Heuristic**: enum **DiagonalMode**: -- **DIAGONAL_MODE_ALWAYS** = **0** +- **DIAGONAL_MODE_ALWAYS** = **0** --- The pathfinding algorithm will ignore solid neighbors around the target cell and allow passing using diagonals. -- **DIAGONAL_MODE_NEVER** = **1** +- **DIAGONAL_MODE_NEVER** = **1** --- The pathfinding algorithm will ignore all diagonals and the way will be always orthogonal. -- **DIAGONAL_MODE_AT_LEAST_ONE_WALKABLE** = **2** +- **DIAGONAL_MODE_AT_LEAST_ONE_WALKABLE** = **2** --- The pathfinding algorithm will avoid using diagonals if at least two obstacles have been placed around the neighboring cells of the specific path segment. -- **DIAGONAL_MODE_ONLY_IF_NO_OBSTACLES** = **3** +- **DIAGONAL_MODE_ONLY_IF_NO_OBSTACLES** = **3** --- The pathfinding algorithm will avoid using diagonals if any obstacle has been placed around the neighboring cells of the specific path segment. -- **DIAGONAL_MODE_MAX** = **4** +- **DIAGONAL_MODE_MAX** = **4** --- Represents the size of the :ref:`DiagonalMode` enum. Property Descriptions --------------------- @@ -126,6 +167,8 @@ Property Descriptions | *Getter* | get_cell_size() | +-----------+----------------------+ +The size of the point cell which will be applied to calculate the resulting point position returned by :ref:`get_point_path`. If changed, :ref:`update` needs to be called before finding the next path. + ---- .. _class_AStarGrid2D_property_default_heuristic: @@ -140,6 +183,8 @@ Property Descriptions | *Getter* | get_default_heuristic() | +-----------+------------------------------+ +The default :ref:`Heuristic` which will be used to calculate the path if :ref:`_compute_cost` and/or :ref:`_estimate_cost` were not overridden. + ---- .. _class_AStarGrid2D_property_diagonal_mode: @@ -154,6 +199,8 @@ Property Descriptions | *Getter* | get_diagonal_mode() | +-----------+--------------------------+ +A specific :ref:`DiagonalMode` mode which will force the path to avoid or accept the specified diagonals. + ---- .. _class_AStarGrid2D_property_jumping_enabled: @@ -168,6 +215,8 @@ Property Descriptions | *Getter* | is_jumping_enabled() | +-----------+----------------------------+ +Enables or disables jumping to skip up the intermediate points and speeds up the searching algorithm. + ---- .. _class_AStarGrid2D_property_offset: @@ -182,6 +231,8 @@ Property Descriptions | *Getter* | get_offset() | +-----------+-------------------+ +The offset of the grid which will be applied to calculate the resulting point position returned by :ref:`get_point_path`. If changed, :ref:`update` needs to be called before finding the next path. + ---- .. _class_AStarGrid2D_property_size: @@ -196,6 +247,8 @@ Property Descriptions | *Getter* | get_size() | +-----------+--------------------+ +The size of the grid (number of cells of size :ref:`cell_size` on each axis). If changed, :ref:`update` needs to be called before finding the next path. + Method Descriptions ------------------- @@ -203,66 +256,94 @@ Method Descriptions - :ref:`float` **_compute_cost** **(** :ref:`Vector2i` from_id, :ref:`Vector2i` to_id **)** |virtual| |const| +Called when computing the cost between two connected points. + +Note that this function is hidden in the default ``AStarGrid2D`` class. + ---- .. _class_AStarGrid2D_method__estimate_cost: - :ref:`float` **_estimate_cost** **(** :ref:`Vector2i` from_id, :ref:`Vector2i` to_id **)** |virtual| |const| +Called when estimating the cost between a point and the path's ending point. + +Note that this function is hidden in the default ``AStarGrid2D`` class. + ---- .. _class_AStarGrid2D_method_clear: - void **clear** **(** **)** +Clears the grid and sets the :ref:`size` to :ref:`Vector2i.ZERO`. + ---- .. _class_AStarGrid2D_method_get_id_path: - :ref:`PackedVector2Array` **get_id_path** **(** :ref:`Vector2i` from_id, :ref:`Vector2i` to_id **)** +Returns an array with the IDs of the points that form the path found by AStar2D between the given points. The array is ordered from the starting point to the ending point of the path. + ---- .. _class_AStarGrid2D_method_get_point_path: - :ref:`PackedVector2Array` **get_point_path** **(** :ref:`Vector2i` from_id, :ref:`Vector2i` to_id **)** +Returns an array with the points that are in the path found by AStarGrid2D between the given points. The array is ordered from the starting point to the ending point of the path. + +\ **Note:** This method is not thread-safe. If called from a :ref:`Thread`, it will return an empty :ref:`PackedVector3Array` and will print an error message. + ---- .. _class_AStarGrid2D_method_is_dirty: - :ref:`bool` **is_dirty** **(** **)** |const| +Indicates that the grid parameters were changed and :ref:`update` needs to be called. + ---- .. _class_AStarGrid2D_method_is_in_bounds: - :ref:`bool` **is_in_bounds** **(** :ref:`int` x, :ref:`int` y **)** |const| +Returns ``true`` if the ``x`` and ``y`` is a valid grid coordinate (id). + ---- .. _class_AStarGrid2D_method_is_in_boundsv: - :ref:`bool` **is_in_boundsv** **(** :ref:`Vector2i` id **)** |const| +Returns ``true`` if the ``id`` vector is a valid grid coordinate. + ---- .. _class_AStarGrid2D_method_is_point_solid: - :ref:`bool` **is_point_solid** **(** :ref:`Vector2i` id **)** |const| +Returns ``true`` if a point is disabled for pathfinding. By default, all points are enabled. + ---- .. _class_AStarGrid2D_method_set_point_solid: - void **set_point_solid** **(** :ref:`Vector2i` id, :ref:`bool` solid=true **)** +Disables or enables the specified point for pathfinding. Useful for making an obstacle. By default, all points are enabled. + ---- .. _class_AStarGrid2D_method_update: - void **update** **(** **)** +Updates the internal state of the grid according to the parameters to prepare it to search the path. Needs to be called if parameters like :ref:`size`, :ref:`cell_size` or :ref:`offset` are changed. :ref:`is_dirty` will return ``true`` if this is the case and this needs to be called. + .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_audioeffectcapture.rst b/classes/class_audioeffectcapture.rst index cd31ad6a7..255f491bc 100644 --- a/classes/class_audioeffectcapture.rst +++ b/classes/class_audioeffectcapture.rst @@ -19,13 +19,17 @@ Description AudioEffectCapture is an AudioEffect which copies all audio frames from the attached audio effect bus into its internal ring buffer. -Application code should consume these audio frames from this ring buffer using :ref:`get_buffer` and process it as needed, for example to capture data from a microphone, implement application defined effects, or to transmit audio over the network. When capturing audio data from a microphone, the format of the samples will be stereo 32-bit floating point PCM. +Application code should consume these audio frames from this ring buffer using :ref:`get_buffer` and process it as needed, for example to capture data from an :ref:`AudioStreamMicrophone`, implement application-defined effects, or to transmit audio over the network. When capturing audio data from a microphone, the format of the samples will be stereo 32-bit floating point PCM. + +\ **Note:** :ref:`ProjectSettings.audio/driver/enable_input` must be ``true`` for audio input to work. See also that setting's description for caveats related to permissions and operating system privacy settings. Tutorials --------- - :doc:`Audio buses <../tutorials/audio/audio_buses>` +- `Audio Mic Record Demo `__ + Properties ---------- diff --git a/classes/class_audioserver.rst b/classes/class_audioserver.rst index 721837f33..f2f6c684b 100644 --- a/classes/class_audioserver.rst +++ b/classes/class_audioserver.rst @@ -189,7 +189,9 @@ Number of available audio buses. | *Getter* | capture_get_device() | +-----------+---------------------------+ -Name of the current device for audio input (see :ref:`get_device_list`). On systems with multiple audio inputs (such as analog, USB and HDMI audio), this can be used to select the audio input device. The value ``"Default"`` will record audio on the system-wide default audio input. If an invalid device name is set, the value will be reverted back to ``"Default"``. +Name of the current device for audio input (see :ref:`capture_get_device_list`). On systems with multiple audio inputs (such as analog, USB and HDMI audio), this can be used to select the audio input device. The value ``"Default"`` will record audio on the system-wide default audio input. If an invalid device name is set, the value will be reverted back to ``"Default"``. + +\ **Note:** :ref:`ProjectSettings.audio/driver/enable_input` must be ``true`` for audio input to work. See also that setting's description for caveats related to permissions and operating system privacy settings. ---- @@ -248,6 +250,8 @@ Adds an :ref:`AudioEffect` effect to the bus ``bus_idx`` at ` Returns the names of all audio input devices detected on the system. +\ **Note:** :ref:`ProjectSettings.audio/driver/enable_input` must be ``true`` for audio input to work. See also that setting's description for caveats related to permissions and operating system privacy settings. + ---- .. _class_AudioServer_method_generate_bus_layout: diff --git a/classes/class_audiostreammicrophone.rst b/classes/class_audiostreammicrophone.rst index d0012e8a1..2ee57ff30 100644 --- a/classes/class_audiostreammicrophone.rst +++ b/classes/class_audiostreammicrophone.rst @@ -12,7 +12,19 @@ AudioStreamMicrophone **Inherits:** :ref:`AudioStream` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +Plays real-time audio input data. +Description +----------- + +When used directly in an :ref:`AudioStreamPlayer` node, ``AudioStreamMicrophone`` plays back microphone input in real-time. This can be used in conjunction with :ref:`AudioEffectCapture` to process the data or save it. + +\ **Note:** :ref:`ProjectSettings.audio/driver/enable_input` must be ``true`` for audio input to work. See also that setting's description for caveats related to permissions and operating system privacy settings. + +Tutorials +--------- + +- `Audio Mic Record Demo `__ .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_basematerial3d.rst b/classes/class_basematerial3d.rst index 24d49bc4e..f9fad38fc 100644 --- a/classes/class_basematerial3d.rst +++ b/classes/class_basematerial3d.rst @@ -114,7 +114,9 @@ Properties +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`emission_enabled` | ``false`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+ -| :ref:`float` | :ref:`emission_energy` | ``1.0`` | +| :ref:`float` | :ref:`emission_energy_multiplier` | ``1.0`` | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`emission_intensity` | | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`emission_on_uv2` | ``false`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+-----------------------+ @@ -1490,23 +1492,37 @@ The emitted light's color. See :ref:`emission_enabled` is used and this object is used in baked lighting. +If ``true``, the body emits light. Emitting light makes the object appear brighter. The object can also cast light on other objects if a :ref:`VoxelGI`, SDFGI, or :ref:`LightmapGI` is used and this object is used in baked lighting. ---- -.. _class_BaseMaterial3D_property_emission_energy: +.. _class_BaseMaterial3D_property_emission_energy_multiplier: -- :ref:`float` **emission_energy** +- :ref:`float` **emission_energy_multiplier** -+-----------+----------------------------+ -| *Default* | ``1.0`` | -+-----------+----------------------------+ -| *Setter* | set_emission_energy(value) | -+-----------+----------------------------+ -| *Getter* | get_emission_energy() | -+-----------+----------------------------+ ++-----------+---------------------------------------+ +| *Default* | ``1.0`` | ++-----------+---------------------------------------+ +| *Setter* | set_emission_energy_multiplier(value) | ++-----------+---------------------------------------+ +| *Getter* | get_emission_energy_multiplier() | ++-----------+---------------------------------------+ -The emitted light's strength. See :ref:`emission_enabled`. +Multiplier for emitted light. See :ref:`emission_enabled`. + +---- + +.. _class_BaseMaterial3D_property_emission_intensity: + +- :ref:`float` **emission_intensity** + ++----------+-------------------------------+ +| *Setter* | set_emission_intensity(value) | ++----------+-------------------------------+ +| *Getter* | get_emission_intensity() | ++----------+-------------------------------+ + +Luminance of emitted light, measured in nits (candela per square meter). Only available when :ref:`ProjectSettings.rendering/lights_and_shadows/use_physical_light_units` is enabled. The default is roughly equivalent to an indoor lightbulb. ---- diff --git a/classes/class_bitmap.rst b/classes/class_bitmap.rst index 39bfb60a5..4798df80e 100644 --- a/classes/class_bitmap.rst +++ b/classes/class_bitmap.rst @@ -25,25 +25,29 @@ Methods +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Image` | :ref:`convert_to_image` **(** **)** |const| | +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`create` **(** :ref:`Vector2` size **)** | +| void | :ref:`create` **(** :ref:`Vector2i` size **)** | +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`create_from_image_alpha` **(** :ref:`Image` image, :ref:`float` threshold=0.1 **)** | +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_bit` **(** :ref:`Vector2` position **)** |const| | +| :ref:`bool` | :ref:`get_bit` **(** :ref:`int` x, :ref:`int` y **)** |const| | +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_size` **(** **)** |const| | +| :ref:`bool` | :ref:`get_bitv` **(** :ref:`Vector2i` position **)** |const| | ++-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2i` | :ref:`get_size` **(** **)** |const| | +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_true_bit_count` **(** **)** |const| | +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`grow_mask` **(** :ref:`int` pixels, :ref:`Rect2` rect **)** | +| void | :ref:`grow_mask` **(** :ref:`int` pixels, :ref:`Rect2i` rect **)** | +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedVector2Array[]` | :ref:`opaque_to_polygons` **(** :ref:`Rect2` rect, :ref:`float` epsilon=2.0 **)** |const| | +| :ref:`PackedVector2Array[]` | :ref:`opaque_to_polygons` **(** :ref:`Rect2i` rect, :ref:`float` epsilon=2.0 **)** |const| | +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`resize` **(** :ref:`Vector2` new_size **)** | +| void | :ref:`resize` **(** :ref:`Vector2i` new_size **)** | +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bit` **(** :ref:`Vector2` position, :ref:`bool` bit **)** | +| void | :ref:`set_bit` **(** :ref:`int` x, :ref:`int` y, :ref:`bool` bit **)** | +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_bit_rect` **(** :ref:`Rect2` rect, :ref:`bool` bit **)** | +| void | :ref:`set_bit_rect` **(** :ref:`Rect2i` rect, :ref:`bool` bit **)** | ++-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_bitv` **(** :ref:`Vector2i` position, :ref:`bool` bit **)** | +-------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions @@ -59,7 +63,7 @@ Returns an image of the same size as the bitmap and with a :ref:`Format` size **)** +- void **create** **(** :ref:`Vector2i` size **)** Creates a bitmap with the specified size, filled with ``false``. @@ -75,7 +79,15 @@ Creates a bitmap that matches the given image dimensions, every element of the b .. _class_BitMap_method_get_bit: -- :ref:`bool` **get_bit** **(** :ref:`Vector2` position **)** |const| +- :ref:`bool` **get_bit** **(** :ref:`int` x, :ref:`int` y **)** |const| + +Returns bitmap's value at the specified position. + +---- + +.. _class_BitMap_method_get_bitv: + +- :ref:`bool` **get_bitv** **(** :ref:`Vector2i` position **)** |const| Returns bitmap's value at the specified position. @@ -83,7 +95,7 @@ Returns bitmap's value at the specified position. .. _class_BitMap_method_get_size: -- :ref:`Vector2` **get_size** **(** **)** |const| +- :ref:`Vector2i` **get_size** **(** **)** |const| Returns bitmap's dimensions. @@ -99,7 +111,7 @@ Returns the number of bitmap elements that are set to ``true``. .. _class_BitMap_method_grow_mask: -- void **grow_mask** **(** :ref:`int` pixels, :ref:`Rect2` rect **)** +- void **grow_mask** **(** :ref:`int` pixels, :ref:`Rect2i` rect **)** Applies morphological dilation or erosion to the bitmap. If ``pixels`` is positive, dilation is applied to the bitmap. If ``pixels`` is negative, erosion is applied to the bitmap. ``rect`` defines the area where the morphological operation is applied. Pixels located outside the ``rect`` are unaffected by :ref:`grow_mask`. @@ -107,7 +119,7 @@ Applies morphological dilation or erosion to the bitmap. If ``pixels`` is positi .. _class_BitMap_method_opaque_to_polygons: -- :ref:`PackedVector2Array[]` **opaque_to_polygons** **(** :ref:`Rect2` rect, :ref:`float` epsilon=2.0 **)** |const| +- :ref:`PackedVector2Array[]` **opaque_to_polygons** **(** :ref:`Rect2i` rect, :ref:`float` epsilon=2.0 **)** |const| Creates an :ref:`Array` of polygons covering a rectangular portion of the bitmap. It uses a marching squares algorithm, followed by Ramer-Douglas-Peucker (RDP) reduction of the number of vertices. Each polygon is described as a :ref:`PackedVector2Array` of its vertices. @@ -123,7 +135,7 @@ To get polygons covering the whole bitmap, pass: .. _class_BitMap_method_resize: -- void **resize** **(** :ref:`Vector2` new_size **)** +- void **resize** **(** :ref:`Vector2i` new_size **)** Resizes the image to ``new_size``. @@ -131,7 +143,7 @@ Resizes the image to ``new_size``. .. _class_BitMap_method_set_bit: -- void **set_bit** **(** :ref:`Vector2` position, :ref:`bool` bit **)** +- void **set_bit** **(** :ref:`int` x, :ref:`int` y, :ref:`bool` bit **)** Sets the bitmap's element at the specified position, to the specified value. @@ -139,10 +151,18 @@ Sets the bitmap's element at the specified position, to the specified value. .. _class_BitMap_method_set_bit_rect: -- void **set_bit_rect** **(** :ref:`Rect2` rect, :ref:`bool` bit **)** +- void **set_bit_rect** **(** :ref:`Rect2i` rect, :ref:`bool` bit **)** Sets a rectangular portion of the bitmap to the specified value. +---- + +.. _class_BitMap_method_set_bitv: + +- void **set_bitv** **(** :ref:`Vector2i` position, :ref:`bool` bit **)** + +Sets the bitmap's element at the specified position, to the specified value. + .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_boxcontainer.rst b/classes/class_boxcontainer.rst index 03e0c6e27..9fc59cb12 100644 --- a/classes/class_boxcontainer.rst +++ b/classes/class_boxcontainer.rst @@ -29,9 +29,11 @@ Tutorials Properties ---------- -+-------------------------------------------------------+---------------------------------------------------------+-------+ -| :ref:`AlignmentMode` | :ref:`alignment` | ``0`` | -+-------------------------------------------------------+---------------------------------------------------------+-------+ ++-------------------------------------------------------+---------------------------------------------------------+-----------+ +| :ref:`AlignmentMode` | :ref:`alignment` | ``0`` | ++-------------------------------------------------------+---------------------------------------------------------+-----------+ +| :ref:`bool` | :ref:`vertical` | ``false`` | ++-------------------------------------------------------+---------------------------------------------------------+-----------+ Methods ------- @@ -40,6 +42,13 @@ Methods | :ref:`Control` | :ref:`add_spacer` **(** :ref:`bool` begin **)** | +-------------------------------+---------------------------------------------------------------------------------------------------+ +Theme Properties +---------------- + ++-----------------------+-----------------------------------------------------------------+-------+ +| :ref:`int` | :ref:`separation` | ``4`` | ++-----------------------+-----------------------------------------------------------------+-------+ + Enumerations ------------ @@ -53,11 +62,11 @@ Enumerations enum **AlignmentMode**: -- **ALIGNMENT_BEGIN** = **0** +- **ALIGNMENT_BEGIN** = **0** --- The child controls will be arranged at the beginning of the container, i.e. top if orientation is vertical, left if orientation is horizontal (right for RTL layout). -- **ALIGNMENT_CENTER** = **1** +- **ALIGNMENT_CENTER** = **1** --- The child controls will be centered in the container. -- **ALIGNMENT_END** = **2** +- **ALIGNMENT_END** = **2** --- The child controls will be arranged at the end of the container, i.e. bottom if orientation is vertical, right if orientation is horizontal (left for RTL layout). Property Descriptions --------------------- @@ -76,6 +85,24 @@ Property Descriptions The alignment of the container's children (must be one of :ref:`ALIGNMENT_BEGIN`, :ref:`ALIGNMENT_CENTER`, or :ref:`ALIGNMENT_END`). +---- + +.. _class_BoxContainer_property_vertical: + +- :ref:`bool` **vertical** + ++-----------+---------------------+ +| *Default* | ``false`` | ++-----------+---------------------+ +| *Setter* | set_vertical(value) | ++-----------+---------------------+ +| *Getter* | is_vertical() | ++-----------+---------------------+ + +If ``true``, the ``BoxContainer`` will arrange its children vertically, rather than horizontally. + +Can't be changed when using :ref:`HBoxContainer` and :ref:`VBoxContainer`. + Method Descriptions ------------------- @@ -85,6 +112,19 @@ Method Descriptions Adds a :ref:`Control` node to the box as a spacer. If ``begin`` is ``true``, it will insert the :ref:`Control` node in front of all other children. +Theme Property Descriptions +--------------------------- + +.. _class_BoxContainer_theme_constant_separation: + +- :ref:`int` **separation** + ++-----------+-------+ +| *Default* | ``4`` | ++-----------+-------+ + +The space between the ``BoxContainer``'s elements, in pixels. + .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_camera2d.rst b/classes/class_camera2d.rst index fcceeb86b..5142deeff 100644 --- a/classes/class_camera2d.rst +++ b/classes/class_camera2d.rst @@ -23,7 +23,7 @@ Cameras register themselves in the nearest :ref:`Viewport` node This node is intended to be a simple helper to get things going quickly, but more functionality may be desired to change how the camera works. To make your own custom camera node, inherit it from :ref:`Node2D` and change the transform of the canvas by setting :ref:`Viewport.canvas_transform` in :ref:`Viewport` (you can obtain the current :ref:`Viewport` by using :ref:`Node.get_viewport`). -Note that the ``Camera2D`` node's ``position`` doesn't represent the actual position of the screen, which may differ due to applied smoothing or limits. You can use :ref:`get_camera_screen_center` to get the real position. +Note that the ``Camera2D`` node's ``position`` doesn't represent the actual position of the screen, which may differ due to applied smoothing or limits. You can use :ref:`get_screen_center_position` to get the real position. Tutorials --------- @@ -97,14 +97,14 @@ Methods +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`force_update_scroll` **(** **)** | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_camera_position` **(** **)** |const| | -+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_camera_screen_center` **(** **)** |const| | -+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_drag_margin` **(** :ref:`Side` margin **)** |const| | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_limit` **(** :ref:`Side` margin **)** |const| | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_screen_center_position` **(** **)** |const| | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_target_position` **(** **)** |const| | ++-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`reset_smoothing` **(** **)** | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_drag_margin` **(** :ref:`Side` margin, :ref:`float` drag_margin **)** | @@ -567,26 +567,6 @@ Forces the camera to update scroll immediately. ---- -.. _class_Camera2D_method_get_camera_position: - -- :ref:`Vector2` **get_camera_position** **(** **)** |const| - -Returns the camera's ``position`` (the tracked point the camera attempts to follow), relative to the origin. - -\ **Note:** The returned value is not the same as :ref:`Node2D.position` or :ref:`Node2D.global_position`, as it is affected by the ``drag`` properties. - ----- - -.. _class_Camera2D_method_get_camera_screen_center: - -- :ref:`Vector2` **get_camera_screen_center** **(** **)** |const| - -Returns the location of the ``Camera2D``'s screen-center, relative to the origin. - -\ **Note:** The real ``position`` of the camera may be different, see :ref:`get_camera_position`. - ----- - .. _class_Camera2D_method_get_drag_margin: - :ref:`float` **get_drag_margin** **(** :ref:`Side` margin **)** |const| @@ -603,6 +583,26 @@ Returns the camera limit for the specified :ref:`Side`. ---- +.. _class_Camera2D_method_get_screen_center_position: + +- :ref:`Vector2` **get_screen_center_position** **(** **)** |const| + +Returns the center of the screen from this camera's point of view, in global coordinates. + +\ **Note:** The exact targeted position of the camera may be different. See :ref:`get_target_position`. + +---- + +.. _class_Camera2D_method_get_target_position: + +- :ref:`Vector2` **get_target_position** **(** **)** |const| + +Returns this camera's target position, in global coordinates. + +\ **Note:** The returned value is not the same as :ref:`Node2D.global_position`, as it is affected by the drag properties. It is also not the same as the current position if :ref:`smoothing_enabled` is ``true`` (see :ref:`get_screen_center_position`). + +---- + .. _class_Camera2D_method_reset_smoothing: - void **reset_smoothing** **(** **)** diff --git a/classes/class_camera3d.rst b/classes/class_camera3d.rst index 01a3be770..df2a2cb9e 100644 --- a/classes/class_camera3d.rst +++ b/classes/class_camera3d.rst @@ -29,6 +29,8 @@ Tutorials Properties ---------- ++-------------------------------------------------------+-------------------------------------------------------------------+-------------------+ +| :ref:`CameraAttributes` | :ref:`attributes` | | +-------------------------------------------------------+-------------------------------------------------------------------+-------------------+ | :ref:`int` | :ref:`cull_mask` | ``1048575`` | +-------------------------------------------------------+-------------------------------------------------------------------+-------------------+ @@ -36,8 +38,6 @@ Properties +-------------------------------------------------------+-------------------------------------------------------------------+-------------------+ | :ref:`DopplerTracking` | :ref:`doppler_tracking` | ``0`` | +-------------------------------------------------------+-------------------------------------------------------------------+-------------------+ -| :ref:`CameraEffects` | :ref:`effects` | | -+-------------------------------------------------------+-------------------------------------------------------------------+-------------------+ | :ref:`Environment` | :ref:`environment` | | +-------------------------------------------------------+-------------------------------------------------------------------+-------------------+ | :ref:`float` | :ref:`far` | ``4000.0`` | @@ -154,6 +154,20 @@ enum **DopplerTracking**: Property Descriptions --------------------- +.. _class_Camera3D_property_attributes: + +- :ref:`CameraAttributes` **attributes** + ++----------+-----------------------+ +| *Setter* | set_attributes(value) | ++----------+-----------------------+ +| *Getter* | get_attributes() | ++----------+-----------------------+ + +The :ref:`CameraAttributes` to use for this camera. + +---- + .. _class_Camera3D_property_cull_mask: - :ref:`int` **cull_mask** @@ -204,20 +218,6 @@ If not :ref:`DOPPLER_TRACKING_DISABLED` **effects** - -+----------+--------------------+ -| *Setter* | set_effects(value) | -+----------+--------------------+ -| *Getter* | get_effects() | -+----------+--------------------+ - -The :ref:`CameraEffects` to use for this camera. - ----- - .. _class_Camera3D_property_environment: - :ref:`Environment` **environment** diff --git a/classes/class_cameraattributes.rst b/classes/class_cameraattributes.rst new file mode 100644 index 000000000..291b78ef4 --- /dev/null +++ b/classes/class_cameraattributes.rst @@ -0,0 +1,121 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CameraAttributes.xml. + +.. _class_CameraAttributes: + +CameraAttributes +================ + +**Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` + +**Inherited By:** :ref:`CameraAttributesPhysical`, :ref:`CameraAttributesPractical` + +Parent class for camera settings. + +Description +----------- + +Controls camera-specific attributes such as depth of field and exposure override. + +When used in a :ref:`WorldEnvironment` it provides default settings for exposure, auto-exposure, and depth of field that will be used by all cameras without their own ``CameraAttributes``, including the editor camera. When used in a :ref:`Camera3D` it will override any ``CameraAttributes`` set in the :ref:`WorldEnvironment`. When used in :ref:`VoxelGI` or :ref:`LightmapGI`, only the exposure settings will be used. + +See also :ref:`Environment` for general 3D environment settings. + +This is a pure virtual class that is inherited by :ref:`CameraAttributesPhysical` and :ref:`CameraAttributesPractical`. + +Properties +---------- + ++---------------------------+-------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`auto_exposure_enabled` | ++---------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`auto_exposure_scale` | ++---------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`auto_exposure_speed` | ++---------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`exposure_multiplier` | ++---------------------------+-------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`exposure_sensitivity` | ++---------------------------+-------------------------------------------------------------------------------------+ + +Property Descriptions +--------------------- + +.. _class_CameraAttributes_property_auto_exposure_enabled: + +- :ref:`bool` **auto_exposure_enabled** + ++----------+----------------------------------+ +| *Setter* | set_auto_exposure_enabled(value) | ++----------+----------------------------------+ +| *Getter* | is_auto_exposure_enabled() | ++----------+----------------------------------+ + +If ``true``, enables the tonemapping auto exposure mode of the scene renderer. If ``true``, the renderer will automatically determine the exposure setting to adapt to the scene's illumination and the observed light. + +---- + +.. _class_CameraAttributes_property_auto_exposure_scale: + +- :ref:`float` **auto_exposure_scale** + ++----------+--------------------------------+ +| *Setter* | set_auto_exposure_scale(value) | ++----------+--------------------------------+ +| *Getter* | get_auto_exposure_scale() | ++----------+--------------------------------+ + +The scale of the auto exposure effect. Affects the intensity of auto exposure. + +---- + +.. _class_CameraAttributes_property_auto_exposure_speed: + +- :ref:`float` **auto_exposure_speed** + ++----------+--------------------------------+ +| *Setter* | set_auto_exposure_speed(value) | ++----------+--------------------------------+ +| *Getter* | get_auto_exposure_speed() | ++----------+--------------------------------+ + +The speed of the auto exposure effect. Affects the time needed for the camera to perform auto exposure. + +---- + +.. _class_CameraAttributes_property_exposure_multiplier: + +- :ref:`float` **exposure_multiplier** + ++----------+--------------------------------+ +| *Setter* | set_exposure_multiplier(value) | ++----------+--------------------------------+ +| *Getter* | get_exposure_multiplier() | ++----------+--------------------------------+ + +Multiplier for the exposure amount. A higher value results in a brighter image. + +---- + +.. _class_CameraAttributes_property_exposure_sensitivity: + +- :ref:`float` **exposure_sensitivity** + ++----------+---------------------------------+ +| *Setter* | set_exposure_sensitivity(value) | ++----------+---------------------------------+ +| *Getter* | get_exposure_sensitivity() | ++----------+---------------------------------+ + +Sensitivity of camera sensors, measured in ISO. A higher sensitivity results in a brighter image. Only available when :ref:`ProjectSettings.rendering/lights_and_shadows/use_physical_light_units` is enabled. When :ref:`auto_exposure_enabled` this can be used as a method of exposure compensation, doubling the value will increase the exposure value (measured in EV100) by 1 stop. + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` diff --git a/classes/class_cameraattributesphysical.rst b/classes/class_cameraattributesphysical.rst new file mode 100644 index 000000000..05c88a19b --- /dev/null +++ b/classes/class_cameraattributesphysical.rst @@ -0,0 +1,201 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CameraAttributesPhysical.xml. + +.. _class_CameraAttributesPhysical: + +CameraAttributesPhysical +======================== + +**Inherits:** :ref:`CameraAttributes` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` + +Physically-based camera settings. + +Description +----------- + +``CameraAttributesPhysical`` is used to set rendering settings based on a physically-based camera's settings. It is responsible for exposure, auto-exposure, and depth of field. + +When used in a :ref:`WorldEnvironment` it provides default settings for exposure, auto-exposure, and depth of field that will be used by all cameras without their own :ref:`CameraAttributes`, including the editor camera. When used in a :ref:`Camera3D` it will override any :ref:`CameraAttributes` set in the :ref:`WorldEnvironment` and will override the :ref:`Camera3D`\ s :ref:`Camera3D.far`, :ref:`Camera3D.near`, :ref:`Camera3D.fov`, and :ref:`Camera3D.keep_aspect` properties. When used in :ref:`VoxelGI` or :ref:`LightmapGI`, only the exposure settings will be used. + +The default settings are intended for use in an outdoor environment, tips for settings for use in an indoor environment can be found in each setting's documentation. + +Properties +---------- + ++---------------------------+-------------------------------------------------------------------------------------------------------------------+------------+ +| :ref:`float` | :ref:`auto_exposure_max_exposure_value` | ``10.0`` | ++---------------------------+-------------------------------------------------------------------------------------------------------------------+------------+ +| :ref:`float` | :ref:`auto_exposure_min_exposure_value` | ``-8.0`` | ++---------------------------+-------------------------------------------------------------------------------------------------------------------+------------+ +| :ref:`float` | :ref:`exposure_aperture` | ``16.0`` | ++---------------------------+-------------------------------------------------------------------------------------------------------------------+------------+ +| :ref:`float` | :ref:`exposure_shutter_speed` | ``100.0`` | ++---------------------------+-------------------------------------------------------------------------------------------------------------------+------------+ +| :ref:`float` | :ref:`frustum_far` | ``4000.0`` | ++---------------------------+-------------------------------------------------------------------------------------------------------------------+------------+ +| :ref:`float` | :ref:`frustum_focal_length` | ``35.0`` | ++---------------------------+-------------------------------------------------------------------------------------------------------------------+------------+ +| :ref:`float` | :ref:`frustum_focus_distance` | ``10.0`` | ++---------------------------+-------------------------------------------------------------------------------------------------------------------+------------+ +| :ref:`float` | :ref:`frustum_near` | ``0.05`` | ++---------------------------+-------------------------------------------------------------------------------------------------------------------+------------+ + +Methods +------- + ++---------------------------+-----------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_fov` **(** **)** |const| | ++---------------------------+-----------------------------------------------------------------------------------+ + +Property Descriptions +--------------------- + +.. _class_CameraAttributesPhysical_property_auto_exposure_max_exposure_value: + +- :ref:`float` **auto_exposure_max_exposure_value** + ++-----------+---------------------------------------------+ +| *Default* | ``10.0`` | ++-----------+---------------------------------------------+ +| *Setter* | set_auto_exposure_max_exposure_value(value) | ++-----------+---------------------------------------------+ +| *Getter* | get_auto_exposure_max_exposure_value() | ++-----------+---------------------------------------------+ + +The maximum luminance (in EV100) used when calculating auto exposure. When calculating scene average luminance, color values will be clamped to at least this value. This limits the auto-exposure from exposing below a certain brightness, resulting in a cut off point where the scene will remain bright. + +---- + +.. _class_CameraAttributesPhysical_property_auto_exposure_min_exposure_value: + +- :ref:`float` **auto_exposure_min_exposure_value** + ++-----------+---------------------------------------------+ +| *Default* | ``-8.0`` | ++-----------+---------------------------------------------+ +| *Setter* | set_auto_exposure_min_exposure_value(value) | ++-----------+---------------------------------------------+ +| *Getter* | get_auto_exposure_min_exposure_value() | ++-----------+---------------------------------------------+ + +The minimum luminance luminance (in EV100) used when calculating auto exposure. When calculating scene average luminance, color values will be clamped to at least this value. This limits the auto-exposure from exposing above a certain brightness, resulting in a cut off point where the scene will remain dark. + +---- + +.. _class_CameraAttributesPhysical_property_exposure_aperture: + +- :ref:`float` **exposure_aperture** + ++-----------+---------------------+ +| *Default* | ``16.0`` | ++-----------+---------------------+ +| *Setter* | set_aperture(value) | ++-----------+---------------------+ +| *Getter* | get_aperture() | ++-----------+---------------------+ + +Size of the aperture of the camera, measured in f-stops. An f-stop is a unitless ratio between the focal length of the camera and the diameter of the aperture. A high aperture setting will result in a smaller aperture which leads to a dimmer image and sharper focus. A low aperture results in a wide aperture which lets in more light resulting in a brighter, less-focused image. Default is appropriate for outdoors at daytime (i.e. for use with a default :ref:`DirectionalLight3D`), for indoor lighting, a value between 2 and 4 is more appropriate. + +Only available when :ref:`ProjectSettings.rendering/lights_and_shadows/use_physical_light_units` is enabled. + +---- + +.. _class_CameraAttributesPhysical_property_exposure_shutter_speed: + +- :ref:`float` **exposure_shutter_speed** + ++-----------+--------------------------+ +| *Default* | ``100.0`` | ++-----------+--------------------------+ +| *Setter* | set_shutter_speed(value) | ++-----------+--------------------------+ +| *Getter* | get_shutter_speed() | ++-----------+--------------------------+ + +Time for shutter to open and close, measured in seconds. A higher value will let in more light leading to a brighter image, while a lower amount will let in less light leading to a darker image. + +Only available when :ref:`ProjectSettings.rendering/lights_and_shadows/use_physical_light_units` is enabled. + +---- + +.. _class_CameraAttributesPhysical_property_frustum_far: + +- :ref:`float` **frustum_far** + ++-----------+----------------+ +| *Default* | ``4000.0`` | ++-----------+----------------+ +| *Setter* | set_far(value) | ++-----------+----------------+ +| *Getter* | get_far() | ++-----------+----------------+ + +Override value for :ref:`Camera3D.far`. Used internally when calculating depth of field. When attached to a :ref:`Camera3D` as its :ref:`Camera3D.attributes`, it will override the :ref:`Camera3D.far` property. + +---- + +.. _class_CameraAttributesPhysical_property_frustum_focal_length: + +- :ref:`float` **frustum_focal_length** + ++-----------+-------------------------+ +| *Default* | ``35.0`` | ++-----------+-------------------------+ +| *Setter* | set_focal_length(value) | ++-----------+-------------------------+ +| *Getter* | get_focal_length() | ++-----------+-------------------------+ + +Distance between camera lens and camera aperture, measured in millimeters. Controls field of view and depth of field. A larger focal length will result in a smaller field of view and a narrower depth of field meaning fewer objects will be in focus. A smaller focal length will result in a wider field of view and a larger depth of field meaning more objects will be in focus. When attached to a :ref:`Camera3D` as its :ref:`Camera3D.attributes`, it will override the :ref:`Camera3D.fov` property and the :ref:`Camera3D.keep_aspect` property. + +---- + +.. _class_CameraAttributesPhysical_property_frustum_focus_distance: + +- :ref:`float` **frustum_focus_distance** + ++-----------+---------------------------+ +| *Default* | ``10.0`` | ++-----------+---------------------------+ +| *Setter* | set_focus_distance(value) | ++-----------+---------------------------+ +| *Getter* | get_focus_distance() | ++-----------+---------------------------+ + +Distance from camera of object that will be in focus, measured in meters. Internally this will be clamped to be at least 1 millimeter larger than :ref:`frustum_focal_length`. + +---- + +.. _class_CameraAttributesPhysical_property_frustum_near: + +- :ref:`float` **frustum_near** + ++-----------+-----------------+ +| *Default* | ``0.05`` | ++-----------+-----------------+ +| *Setter* | set_near(value) | ++-----------+-----------------+ +| *Getter* | get_near() | ++-----------+-----------------+ + +Override value for :ref:`Camera3D.near`. Used internally when calculating depth of field. When attached to a :ref:`Camera3D` as its :ref:`Camera3D.attributes`, it will override the :ref:`Camera3D.near` property. + +Method Descriptions +------------------- + +.. _class_CameraAttributesPhysical_method_get_fov: + +- :ref:`float` **get_fov** **(** **)** |const| + +Returns the vertical field of view that corresponds to the :ref:`frustum_focal_length`. This value is calculated internally whenever :ref:`frustum_focal_length` is changed. + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` diff --git a/classes/class_cameraattributespractical.rst b/classes/class_cameraattributespractical.rst new file mode 100644 index 000000000..e587107ac --- /dev/null +++ b/classes/class_cameraattributespractical.rst @@ -0,0 +1,197 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CameraAttributesPractical.xml. + +.. _class_CameraAttributesPractical: + +CameraAttributesPractical +========================= + +**Inherits:** :ref:`CameraAttributes` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` + +Camera settings in an easy to use format. + +Description +----------- + +Controls camera-specific attributes such as auto-exposure, depth of field, and exposure override. + +When used in a :ref:`WorldEnvironment` it provides default settings for exposure, auto-exposure, and depth of field that will be used by all cameras without their own :ref:`CameraAttributes`, including the editor camera. When used in a :ref:`Camera3D` it will override any :ref:`CameraAttributes` set in the :ref:`WorldEnvironment`. When used in :ref:`VoxelGI` or :ref:`LightmapGI`, only the exposure settings will be used. + +Properties +---------- + ++---------------------------+--------------------------------------------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`auto_exposure_max_sensitivity` | ``800.0`` | ++---------------------------+--------------------------------------------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`auto_exposure_min_sensitivity` | ``0.0`` | ++---------------------------+--------------------------------------------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`dof_blur_amount` | ``0.1`` | ++---------------------------+--------------------------------------------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`dof_blur_far_distance` | ``10.0`` | ++---------------------------+--------------------------------------------------------------------------------------------------------------+-----------+ +| :ref:`bool` | :ref:`dof_blur_far_enabled` | ``false`` | ++---------------------------+--------------------------------------------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`dof_blur_far_transition` | ``5.0`` | ++---------------------------+--------------------------------------------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`dof_blur_near_distance` | ``2.0`` | ++---------------------------+--------------------------------------------------------------------------------------------------------------+-----------+ +| :ref:`bool` | :ref:`dof_blur_near_enabled` | ``false`` | ++---------------------------+--------------------------------------------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`dof_blur_near_transition` | ``1.0`` | ++---------------------------+--------------------------------------------------------------------------------------------------------------+-----------+ + +Property Descriptions +--------------------- + +.. _class_CameraAttributesPractical_property_auto_exposure_max_sensitivity: + +- :ref:`float` **auto_exposure_max_sensitivity** + ++-----------+------------------------------------------+ +| *Default* | ``800.0`` | ++-----------+------------------------------------------+ +| *Setter* | set_auto_exposure_max_sensitivity(value) | ++-----------+------------------------------------------+ +| *Getter* | get_auto_exposure_max_sensitivity() | ++-----------+------------------------------------------+ + +The maximum sensitivity (in ISO) used when calculating auto exposure. When calculating scene average luminance, color values will be clamped to at least this value. This limits the auto-exposure from exposing below a certain brightness, resulting in a cut off point where the scene will remain bright. + +---- + +.. _class_CameraAttributesPractical_property_auto_exposure_min_sensitivity: + +- :ref:`float` **auto_exposure_min_sensitivity** + ++-----------+------------------------------------------+ +| *Default* | ``0.0`` | ++-----------+------------------------------------------+ +| *Setter* | set_auto_exposure_min_sensitivity(value) | ++-----------+------------------------------------------+ +| *Getter* | get_auto_exposure_min_sensitivity() | ++-----------+------------------------------------------+ + +The minimum sensitivity (in ISO) used when calculating auto exposure. When calculating scene average luminance, color values will be clamped to at least this value. This limits the auto-exposure from exposing above a certain brightness, resulting in a cut off point where the scene will remain dark. + +---- + +.. _class_CameraAttributesPractical_property_dof_blur_amount: + +- :ref:`float` **dof_blur_amount** + ++-----------+----------------------------+ +| *Default* | ``0.1`` | ++-----------+----------------------------+ +| *Setter* | set_dof_blur_amount(value) | ++-----------+----------------------------+ +| *Getter* | get_dof_blur_amount() | ++-----------+----------------------------+ + +Sets the maximum amount of blur. When using physically-based blur amounts, will instead act as a multiplier. High values lead to an increased amount of bluriness, but can be much more expensive to calculate. It is best to keep this as low as possible for a given art style. + +---- + +.. _class_CameraAttributesPractical_property_dof_blur_far_distance: + +- :ref:`float` **dof_blur_far_distance** + ++-----------+----------------------------------+ +| *Default* | ``10.0`` | ++-----------+----------------------------------+ +| *Setter* | set_dof_blur_far_distance(value) | ++-----------+----------------------------------+ +| *Getter* | get_dof_blur_far_distance() | ++-----------+----------------------------------+ + +Objects further from the :ref:`Camera3D` by this amount will be blurred by the depth of field effect. Measured in meters. + +---- + +.. _class_CameraAttributesPractical_property_dof_blur_far_enabled: + +- :ref:`bool` **dof_blur_far_enabled** + ++-----------+---------------------------------+ +| *Default* | ``false`` | ++-----------+---------------------------------+ +| *Setter* | set_dof_blur_far_enabled(value) | ++-----------+---------------------------------+ +| *Getter* | is_dof_blur_far_enabled() | ++-----------+---------------------------------+ + +Enables depth of field blur for objects further than :ref:`dof_blur_far_distance`. Strength of blur is controlled by :ref:`dof_blur_amount` and modulated by :ref:`dof_blur_far_transition`. + +---- + +.. _class_CameraAttributesPractical_property_dof_blur_far_transition: + +- :ref:`float` **dof_blur_far_transition** + ++-----------+------------------------------------+ +| *Default* | ``5.0`` | ++-----------+------------------------------------+ +| *Setter* | set_dof_blur_far_transition(value) | ++-----------+------------------------------------+ +| *Getter* | get_dof_blur_far_transition() | ++-----------+------------------------------------+ + +When positive, distance over which (starting from :ref:`dof_blur_far_distance`) blur effect will scale from 0 to :ref:`dof_blur_amount`. When negative, uses physically-based scaling so depth of field effect will scale from 0 at :ref:`dof_blur_far_distance` and will increase in a physically accurate way as objects get further from the :ref:`Camera3D`. + +---- + +.. _class_CameraAttributesPractical_property_dof_blur_near_distance: + +- :ref:`float` **dof_blur_near_distance** + ++-----------+-----------------------------------+ +| *Default* | ``2.0`` | ++-----------+-----------------------------------+ +| *Setter* | set_dof_blur_near_distance(value) | ++-----------+-----------------------------------+ +| *Getter* | get_dof_blur_near_distance() | ++-----------+-----------------------------------+ + +Objects closer from the :ref:`Camera3D` by this amount will be blurred by the depth of field effect. Measured in meters. + +---- + +.. _class_CameraAttributesPractical_property_dof_blur_near_enabled: + +- :ref:`bool` **dof_blur_near_enabled** + ++-----------+----------------------------------+ +| *Default* | ``false`` | ++-----------+----------------------------------+ +| *Setter* | set_dof_blur_near_enabled(value) | ++-----------+----------------------------------+ +| *Getter* | is_dof_blur_near_enabled() | ++-----------+----------------------------------+ + +Enables depth of field blur for objects closer than :ref:`dof_blur_near_distance`. Strength of blur is controlled by :ref:`dof_blur_amount` and modulated by :ref:`dof_blur_near_transition`. + +---- + +.. _class_CameraAttributesPractical_property_dof_blur_near_transition: + +- :ref:`float` **dof_blur_near_transition** + ++-----------+-------------------------------------+ +| *Default* | ``1.0`` | ++-----------+-------------------------------------+ +| *Setter* | set_dof_blur_near_transition(value) | ++-----------+-------------------------------------+ +| *Getter* | get_dof_blur_near_transition() | ++-----------+-------------------------------------+ + +When positive, distance over which blur effect will scale from 0 to :ref:`dof_blur_amount`, ending at :ref:`dof_blur_near_distance`. When negative, uses physically-based scaling so depth of field effect will scale from 0 at :ref:`dof_blur_near_distance` and will increase in a physically accurate way as objects get closer to the :ref:`Camera3D`. + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` diff --git a/classes/class_cameraeffects.rst b/classes/class_cameraeffects.rst deleted file mode 100644 index ab14c5914..000000000 --- a/classes/class_cameraeffects.rst +++ /dev/null @@ -1,197 +0,0 @@ -:github_url: hide - -.. DO NOT EDIT THIS FILE!!! -.. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CameraEffects.xml. - -.. _class_CameraEffects: - -CameraEffects -============= - -**Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` - -Contains camera-specific effects such as depth of field and exposure override. - -Description ------------ - -Contains camera-specific effects such as depth of field and exposure override. - -See also :ref:`Environment` for general 3D environment settings. - -Properties ----------- - -+---------------------------+------------------------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`dof_blur_amount` | ``0.1`` | -+---------------------------+------------------------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`dof_blur_far_distance` | ``10.0`` | -+---------------------------+------------------------------------------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`dof_blur_far_enabled` | ``false`` | -+---------------------------+------------------------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`dof_blur_far_transition` | ``5.0`` | -+---------------------------+------------------------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`dof_blur_near_distance` | ``2.0`` | -+---------------------------+------------------------------------------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`dof_blur_near_enabled` | ``false`` | -+---------------------------+------------------------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`dof_blur_near_transition` | ``1.0`` | -+---------------------------+------------------------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`override_exposure` | ``1.0`` | -+---------------------------+------------------------------------------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`override_exposure_enabled` | ``false`` | -+---------------------------+------------------------------------------------------------------------------------------+-----------+ - -Property Descriptions ---------------------- - -.. _class_CameraEffects_property_dof_blur_amount: - -- :ref:`float` **dof_blur_amount** - -+-----------+----------------------------+ -| *Default* | ``0.1`` | -+-----------+----------------------------+ -| *Setter* | set_dof_blur_amount(value) | -+-----------+----------------------------+ -| *Getter* | get_dof_blur_amount() | -+-----------+----------------------------+ - -The amount of blur for both near and far depth-of-field effects. The amount of blur increases the radius of the blur effect, making the affected area blurrier. However, If the amount is too high, you might start to see lines appearing, especially when using a low quality blur. - ----- - -.. _class_CameraEffects_property_dof_blur_far_distance: - -- :ref:`float` **dof_blur_far_distance** - -+-----------+----------------------------------+ -| *Default* | ``10.0`` | -+-----------+----------------------------------+ -| *Setter* | set_dof_blur_far_distance(value) | -+-----------+----------------------------------+ -| *Getter* | get_dof_blur_far_distance() | -+-----------+----------------------------------+ - -The distance from the camera where the far blur effect affects the rendering. - ----- - -.. _class_CameraEffects_property_dof_blur_far_enabled: - -- :ref:`bool` **dof_blur_far_enabled** - -+-----------+---------------------------------+ -| *Default* | ``false`` | -+-----------+---------------------------------+ -| *Setter* | set_dof_blur_far_enabled(value) | -+-----------+---------------------------------+ -| *Getter* | is_dof_blur_far_enabled() | -+-----------+---------------------------------+ - -If ``true``, enables the depth-of-field far blur effect. This has a significant performance cost. Consider disabling it in scenes where there are no far away objects. - ----- - -.. _class_CameraEffects_property_dof_blur_far_transition: - -- :ref:`float` **dof_blur_far_transition** - -+-----------+------------------------------------+ -| *Default* | ``5.0`` | -+-----------+------------------------------------+ -| *Setter* | set_dof_blur_far_transition(value) | -+-----------+------------------------------------+ -| *Getter* | get_dof_blur_far_transition() | -+-----------+------------------------------------+ - -The length of the transition between the no-blur area and far blur. - ----- - -.. _class_CameraEffects_property_dof_blur_near_distance: - -- :ref:`float` **dof_blur_near_distance** - -+-----------+-----------------------------------+ -| *Default* | ``2.0`` | -+-----------+-----------------------------------+ -| *Setter* | set_dof_blur_near_distance(value) | -+-----------+-----------------------------------+ -| *Getter* | get_dof_blur_near_distance() | -+-----------+-----------------------------------+ - -Distance from the camera where the near blur effect affects the rendering. - ----- - -.. _class_CameraEffects_property_dof_blur_near_enabled: - -- :ref:`bool` **dof_blur_near_enabled** - -+-----------+----------------------------------+ -| *Default* | ``false`` | -+-----------+----------------------------------+ -| *Setter* | set_dof_blur_near_enabled(value) | -+-----------+----------------------------------+ -| *Getter* | is_dof_blur_near_enabled() | -+-----------+----------------------------------+ - -If ``true``, enables the depth-of-field near blur effect. This has a significant performance cost. Consider disabling it in scenes where there are no nearby objects. - ----- - -.. _class_CameraEffects_property_dof_blur_near_transition: - -- :ref:`float` **dof_blur_near_transition** - -+-----------+-------------------------------------+ -| *Default* | ``1.0`` | -+-----------+-------------------------------------+ -| *Setter* | set_dof_blur_near_transition(value) | -+-----------+-------------------------------------+ -| *Getter* | get_dof_blur_near_transition() | -+-----------+-------------------------------------+ - -The length of the transition between the near blur and no-blur area. - ----- - -.. _class_CameraEffects_property_override_exposure: - -- :ref:`float` **override_exposure** - -+-----------+------------------------------+ -| *Default* | ``1.0`` | -+-----------+------------------------------+ -| *Setter* | set_override_exposure(value) | -+-----------+------------------------------+ -| *Getter* | get_override_exposure() | -+-----------+------------------------------+ - -The exposure override value to use. Higher values will result in a brighter scene. Only effective if :ref:`override_exposure_enabled` is ``true``. - ----- - -.. _class_CameraEffects_property_override_exposure_enabled: - -- :ref:`bool` **override_exposure_enabled** - -+-----------+--------------------------------------+ -| *Default* | ``false`` | -+-----------+--------------------------------------+ -| *Setter* | set_override_exposure_enabled(value) | -+-----------+--------------------------------------+ -| *Getter* | is_override_exposure_enabled() | -+-----------+--------------------------------------+ - -If ``true``, overrides the manual or automatic exposure defined in the :ref:`Environment` with the value in :ref:`override_exposure`. - -.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` -.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` -.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` -.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` -.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` -.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` diff --git a/classes/class_canvasitem.rst b/classes/class_canvasitem.rst index 58fc44632..d5ba3a805 100644 --- a/classes/class_canvasitem.rst +++ b/classes/class_canvasitem.rst @@ -171,6 +171,8 @@ Methods +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`InputEvent` | :ref:`make_input_local` **(** :ref:`InputEvent` event **)** |const| | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`move_to_front` **(** **)** | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`queue_redraw` **(** **)** | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_notify_local_transform` **(** :ref:`bool` enable **)** | @@ -935,6 +937,16 @@ Transformations issued by ``event``'s inputs are applied in local space instead ---- +.. _class_CanvasItem_method_move_to_front: + +- void **move_to_front** **(** **)** + +Moves this node to display on top of its siblings. This has more use in :ref:`Control`, as :ref:`Node2D` can be ordered with :ref:`Node2D.z_index`. + +Internally, the node is moved to the bottom of parent's children list. The method has no effect on nodes without a parent. + +---- + .. _class_CanvasItem_method_queue_redraw: - void **queue_redraw** **(** **)** diff --git a/classes/class_canvaslayer.rst b/classes/class_canvaslayer.rst index 74879c9b1..37b9c311b 100644 --- a/classes/class_canvaslayer.rst +++ b/classes/class_canvaslayer.rst @@ -102,7 +102,9 @@ The custom :ref:`Viewport` node assigned to the ``CanvasLayer``. | *Getter* | is_following_viewport() | +-----------+----------------------------+ -Sets the layer to follow the viewport in order to simulate a pseudo 3D effect. +If enabled, the ``CanvasLayer`` will use the viewport's transform, so it will move when camera moves instead of being anchored in a fixed position on the screen. + +Together with :ref:`follow_viewport_scale` it can be used for a pseudo 3D effect. ---- diff --git a/classes/class_checkbox.rst b/classes/class_checkbox.rst index 367b5a824..934d3d3d3 100644 --- a/classes/class_checkbox.rst +++ b/classes/class_checkbox.rst @@ -48,7 +48,7 @@ Theme Properties +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`Color` | :ref:`font_pressed_color` | ``Color(1, 1, 1, 1)`` | +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ -| :ref:`int` | :ref:`check_v_adjust` | ``0`` | +| :ref:`int` | :ref:`check_v_offset` | ``0`` | +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ | :ref:`int` | :ref:`h_separation` | ``4`` | +-----------------------------------+--------------------------------------------------------------------------------------+-------------------------------------+ @@ -174,9 +174,9 @@ The ``CheckBox`` text's font color when it's pressed. ---- -.. _class_CheckBox_theme_constant_check_v_adjust: +.. _class_CheckBox_theme_constant_check_v_offset: -- :ref:`int` **check_v_adjust** +- :ref:`int` **check_v_offset** +-----------+-------+ | *Default* | ``0`` | diff --git a/classes/class_checkbutton.rst b/classes/class_checkbutton.rst index 2073ffdd8..f830f498e 100644 --- a/classes/class_checkbutton.rst +++ b/classes/class_checkbutton.rst @@ -33,59 +33,59 @@ Properties Theme Properties ---------------- -+-----------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------+ -| :ref:`Color` | :ref:`font_color` | ``Color(0.875, 0.875, 0.875, 1)`` | -+-----------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------+ -| :ref:`Color` | :ref:`font_disabled_color` | ``Color(0.875, 0.875, 0.875, 0.5)`` | -+-----------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------+ -| :ref:`Color` | :ref:`font_focus_color` | ``Color(0.95, 0.95, 0.95, 1)`` | -+-----------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------+ -| :ref:`Color` | :ref:`font_hover_color` | ``Color(0.95, 0.95, 0.95, 1)`` | -+-----------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------+ -| :ref:`Color` | :ref:`font_hover_pressed_color` | ``Color(1, 1, 1, 1)`` | -+-----------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------+ -| :ref:`Color` | :ref:`font_outline_color` | ``Color(1, 1, 1, 1)`` | -+-----------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------+ -| :ref:`Color` | :ref:`font_pressed_color` | ``Color(1, 1, 1, 1)`` | -+-----------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------+ -| :ref:`int` | :ref:`check_v_adjust` | ``0`` | -+-----------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------+ -| :ref:`int` | :ref:`h_separation` | ``4`` | -+-----------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------+ -| :ref:`int` | :ref:`outline_size` | ``0`` | -+-----------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------+ -| :ref:`Font` | :ref:`font` | | -+-----------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------+ -| :ref:`int` | :ref:`font_size` | | -+-----------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------+ -| :ref:`Texture2D` | :ref:`off` | | -+-----------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------+ -| :ref:`Texture2D` | :ref:`off_disabled` | | -+-----------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------+ -| :ref:`Texture2D` | :ref:`off_disabled_mirrored` | | -+-----------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------+ -| :ref:`Texture2D` | :ref:`off_mirrored` | | -+-----------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------+ -| :ref:`Texture2D` | :ref:`on` | | -+-----------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------+ -| :ref:`Texture2D` | :ref:`on_disabled` | | -+-----------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------+ -| :ref:`Texture2D` | :ref:`on_disabled_mirrored` | | -+-----------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------+ -| :ref:`Texture2D` | :ref:`on_mirrored` | | -+-----------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------+ -| :ref:`StyleBox` | :ref:`disabled` | | -+-----------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------+ -| :ref:`StyleBox` | :ref:`focus` | | -+-----------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------+ -| :ref:`StyleBox` | :ref:`hover` | | -+-----------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------+ -| :ref:`StyleBox` | :ref:`hover_pressed` | | -+-----------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------+ -| :ref:`StyleBox` | :ref:`normal` | | -+-----------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------+ -| :ref:`StyleBox` | :ref:`pressed` | | -+-----------------------------------+-----------------------------------------------------------------------------------------+-------------------------------------+ ++-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ +| :ref:`Color` | :ref:`font_color` | ``Color(0.875, 0.875, 0.875, 1)`` | ++-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ +| :ref:`Color` | :ref:`font_disabled_color` | ``Color(0.875, 0.875, 0.875, 0.5)`` | ++-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ +| :ref:`Color` | :ref:`font_focus_color` | ``Color(0.95, 0.95, 0.95, 1)`` | ++-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ +| :ref:`Color` | :ref:`font_hover_color` | ``Color(0.95, 0.95, 0.95, 1)`` | ++-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ +| :ref:`Color` | :ref:`font_hover_pressed_color` | ``Color(1, 1, 1, 1)`` | ++-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ +| :ref:`Color` | :ref:`font_outline_color` | ``Color(1, 1, 1, 1)`` | ++-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ +| :ref:`Color` | :ref:`font_pressed_color` | ``Color(1, 1, 1, 1)`` | ++-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ +| :ref:`int` | :ref:`check_v_offset` | ``0`` | ++-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ +| :ref:`int` | :ref:`h_separation` | ``4`` | ++-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ +| :ref:`int` | :ref:`outline_size` | ``0`` | ++-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ +| :ref:`Font` | :ref:`font` | | ++-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ +| :ref:`int` | :ref:`font_size` | | ++-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ +| :ref:`Texture2D` | :ref:`checked` | | ++-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ +| :ref:`Texture2D` | :ref:`checked_disabled` | | ++-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ +| :ref:`Texture2D` | :ref:`checked_disabled_mirrored` | | ++-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ +| :ref:`Texture2D` | :ref:`checked_mirrored` | | ++-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ +| :ref:`Texture2D` | :ref:`unchecked` | | ++-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ +| :ref:`Texture2D` | :ref:`unchecked_disabled` | | ++-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ +| :ref:`Texture2D` | :ref:`unchecked_disabled_mirrored` | | ++-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ +| :ref:`Texture2D` | :ref:`unchecked_mirrored` | | ++-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ +| :ref:`StyleBox` | :ref:`disabled` | | ++-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ +| :ref:`StyleBox` | :ref:`focus` | | ++-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ +| :ref:`StyleBox` | :ref:`hover` | | ++-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ +| :ref:`StyleBox` | :ref:`hover_pressed` | | ++-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ +| :ref:`StyleBox` | :ref:`normal` | | ++-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ +| :ref:`StyleBox` | :ref:`pressed` | | ++-----------------------------------+----------------------------------------------------------------------------------------------+-------------------------------------+ Theme Property Descriptions --------------------------- @@ -174,9 +174,9 @@ The ``CheckButton`` text's font color when it's pressed. ---- -.. _class_CheckButton_theme_constant_check_v_adjust: +.. _class_CheckButton_theme_constant_check_v_offset: -- :ref:`int` **check_v_adjust** +- :ref:`int` **check_v_offset** +-----------+-------+ | *Default* | ``0`` | @@ -226,70 +226,70 @@ Font size of the ``CheckButton``'s text. ---- -.. _class_CheckButton_theme_icon_off: +.. _class_CheckButton_theme_icon_checked: -- :ref:`Texture2D` **off** - -The icon to display when the ``CheckButton`` is unchecked (for left-to-right layouts). - ----- - -.. _class_CheckButton_theme_icon_off_disabled: - -- :ref:`Texture2D` **off_disabled** - -The icon to display when the ``CheckButton`` is unchecked and disabled (for left-to-right layouts). - ----- - -.. _class_CheckButton_theme_icon_off_disabled_mirrored: - -- :ref:`Texture2D` **off_disabled_mirrored** - -The icon to display when the ``CheckButton`` is unchecked and disabled (for right-to-left layouts). - ----- - -.. _class_CheckButton_theme_icon_off_mirrored: - -- :ref:`Texture2D` **off_mirrored** - -The icon to display when the ``CheckButton`` is unchecked (for right-to-left layouts). - ----- - -.. _class_CheckButton_theme_icon_on: - -- :ref:`Texture2D` **on** +- :ref:`Texture2D` **checked** The icon to display when the ``CheckButton`` is checked (for left-to-right layouts). ---- -.. _class_CheckButton_theme_icon_on_disabled: +.. _class_CheckButton_theme_icon_checked_disabled: -- :ref:`Texture2D` **on_disabled** +- :ref:`Texture2D` **checked_disabled** The icon to display when the ``CheckButton`` is checked and disabled (for left-to-right layouts). ---- -.. _class_CheckButton_theme_icon_on_disabled_mirrored: +.. _class_CheckButton_theme_icon_checked_disabled_mirrored: -- :ref:`Texture2D` **on_disabled_mirrored** +- :ref:`Texture2D` **checked_disabled_mirrored** The icon to display when the ``CheckButton`` is checked and disabled (for right-to-left layouts). ---- -.. _class_CheckButton_theme_icon_on_mirrored: +.. _class_CheckButton_theme_icon_checked_mirrored: -- :ref:`Texture2D` **on_mirrored** +- :ref:`Texture2D` **checked_mirrored** The icon to display when the ``CheckButton`` is checked (for right-to-left layouts). ---- +.. _class_CheckButton_theme_icon_unchecked: + +- :ref:`Texture2D` **unchecked** + +The icon to display when the ``CheckButton`` is unchecked (for left-to-right layouts). + +---- + +.. _class_CheckButton_theme_icon_unchecked_disabled: + +- :ref:`Texture2D` **unchecked_disabled** + +The icon to display when the ``CheckButton`` is unchecked and disabled (for left-to-right layouts). + +---- + +.. _class_CheckButton_theme_icon_unchecked_disabled_mirrored: + +- :ref:`Texture2D` **unchecked_disabled_mirrored** + +The icon to display when the ``CheckButton`` is unchecked and disabled (for right-to-left layouts). + +---- + +.. _class_CheckButton_theme_icon_unchecked_mirrored: + +- :ref:`Texture2D` **unchecked_mirrored** + +The icon to display when the ``CheckButton`` is unchecked (for right-to-left layouts). + +---- + .. _class_CheckButton_theme_style_disabled: - :ref:`StyleBox` **disabled** diff --git a/classes/class_colorpicker.rst b/classes/class_colorpicker.rst index 65f9ceb80..91f8eeaed 100644 --- a/classes/class_colorpicker.rst +++ b/classes/class_colorpicker.rst @@ -29,21 +29,23 @@ Tutorials Properties ---------- -+----------------------------------------------------------+--------------------------------------------------------------------+-----------------------+ -| :ref:`Color` | :ref:`color` | ``Color(1, 1, 1, 1)`` | -+----------------------------------------------------------+--------------------------------------------------------------------+-----------------------+ -| :ref:`ColorModeType` | :ref:`color_mode` | ``0`` | -+----------------------------------------------------------+--------------------------------------------------------------------+-----------------------+ -| :ref:`bool` | :ref:`deferred_mode` | ``false`` | -+----------------------------------------------------------+--------------------------------------------------------------------+-----------------------+ -| :ref:`bool` | :ref:`edit_alpha` | ``true`` | -+----------------------------------------------------------+--------------------------------------------------------------------+-----------------------+ -| :ref:`PickerShapeType` | :ref:`picker_shape` | ``0`` | -+----------------------------------------------------------+--------------------------------------------------------------------+-----------------------+ -| :ref:`bool` | :ref:`presets_enabled` | ``true`` | -+----------------------------------------------------------+--------------------------------------------------------------------+-----------------------+ -| :ref:`bool` | :ref:`presets_visible` | ``true`` | -+----------------------------------------------------------+--------------------------------------------------------------------+-----------------------+ ++----------------------------------------------------------+--------------------------------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`color` | ``Color(1, 1, 1, 1)`` | ++----------------------------------------------------------+--------------------------------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`ColorModeType` | :ref:`color_mode` | ``0`` | ++----------------------------------------------------------+--------------------------------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`deferred_mode` | ``false`` | ++----------------------------------------------------------+--------------------------------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`edit_alpha` | ``true`` | ++----------------------------------------------------------+--------------------------------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`PickerShapeType` | :ref:`picker_shape` | ``0`` | ++----------------------------------------------------------+--------------------------------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`presets_enabled` | ``true`` | ++----------------------------------------------------------+--------------------------------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`presets_visible` | ``true`` | ++----------------------------------------------------------+--------------------------------------------------------------------+--------------------------------------------------------------------------------+ +| :ref:`bool` | vertical | ``true`` (overrides :ref:`BoxContainer`) | ++----------------------------------------------------------+--------------------------------------------------------------------+--------------------------------------------------------------------------------+ Methods ------- diff --git a/classes/class_configfile.rst b/classes/class_configfile.rst index 0ae167955..ae6a6abfa 100644 --- a/classes/class_configfile.rst +++ b/classes/class_configfile.rst @@ -126,6 +126,8 @@ Methods +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`encode_to_text` **(** **)** |const| | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`erase_section` **(** :ref:`String` section **)** | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`erase_section_key` **(** :ref:`String` section, :ref:`String` key **)** | @@ -168,6 +170,14 @@ Removes the entire contents of the config. ---- +.. _class_ConfigFile_method_encode_to_text: + +- :ref:`String` **encode_to_text** **(** **)** |const| + +Obtain the text version of this config file (the same text that would be written to a file). + +---- + .. _class_ConfigFile_method_erase_section: - void **erase_section** **(** :ref:`String` section **)** diff --git a/classes/class_control.rst b/classes/class_control.rst index a35422178..3aa480972 100644 --- a/classes/class_control.rst +++ b/classes/class_control.rst @@ -53,79 +53,79 @@ Tutorials Properties ---------- -+------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ -| :ref:`float` | :ref:`anchor_bottom` | ``0.0`` | -+------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ -| :ref:`float` | :ref:`anchor_left` | ``0.0`` | -+------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ -| :ref:`float` | :ref:`anchor_right` | ``0.0`` | -+------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ -| :ref:`float` | :ref:`anchor_top` | ``0.0`` | -+------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ -| :ref:`bool` | :ref:`auto_translate` | ``true`` | -+------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ -| :ref:`bool` | :ref:`clip_contents` | ``false`` | -+------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ -| :ref:`Vector2` | :ref:`custom_minimum_size` | ``Vector2(0, 0)`` | -+------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ -| :ref:`FocusMode` | :ref:`focus_mode` | ``0`` | -+------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ -| :ref:`NodePath` | :ref:`focus_neighbor_bottom` | ``NodePath("")`` | -+------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ -| :ref:`NodePath` | :ref:`focus_neighbor_left` | ``NodePath("")`` | -+------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ -| :ref:`NodePath` | :ref:`focus_neighbor_right` | ``NodePath("")`` | -+------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ -| :ref:`NodePath` | :ref:`focus_neighbor_top` | ``NodePath("")`` | -+------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ -| :ref:`NodePath` | :ref:`focus_next` | ``NodePath("")`` | -+------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ -| :ref:`NodePath` | :ref:`focus_previous` | ``NodePath("")`` | -+------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ -| :ref:`Vector2` | :ref:`global_position` | | -+------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ -| :ref:`GrowDirection` | :ref:`grow_horizontal` | ``1`` | -+------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ -| :ref:`GrowDirection` | :ref:`grow_vertical` | ``1`` | -+------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ -| :ref:`LayoutDirection` | :ref:`layout_direction` | ``0`` | -+------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ -| :ref:`CursorShape` | :ref:`mouse_default_cursor_shape` | ``0`` | -+------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ -| :ref:`MouseFilter` | :ref:`mouse_filter` | ``0`` | -+------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ -| :ref:`bool` | :ref:`mouse_force_pass_scroll_events` | ``true`` | -+------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ -| :ref:`float` | :ref:`offset_bottom` | ``0.0`` | -+------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ -| :ref:`float` | :ref:`offset_left` | ``0.0`` | -+------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ -| :ref:`float` | :ref:`offset_right` | ``0.0`` | -+------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ -| :ref:`float` | :ref:`offset_top` | ``0.0`` | -+------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ -| :ref:`Vector2` | :ref:`pivot_offset` | ``Vector2(0, 0)`` | -+------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ -| :ref:`Vector2` | :ref:`position` | ``Vector2(0, 0)`` | -+------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ -| :ref:`float` | :ref:`rotation` | ``0.0`` | -+------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ -| :ref:`Vector2` | :ref:`scale` | ``Vector2(1, 1)`` | -+------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ -| :ref:`Vector2` | :ref:`size` | ``Vector2(0, 0)`` | -+------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ -| :ref:`int` | :ref:`size_flags_horizontal` | ``1`` | -+------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ -| :ref:`float` | :ref:`size_flags_stretch_ratio` | ``1.0`` | -+------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ -| :ref:`int` | :ref:`size_flags_vertical` | ``1`` | -+------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ -| :ref:`Theme` | :ref:`theme` | | -+------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ -| :ref:`StringName` | :ref:`theme_type_variation` | ``&""`` | -+------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ -| :ref:`String` | :ref:`tooltip_text` | ``""`` | -+------------------------------------------------------+----------------------------------------------------------------------------------------------+-------------------+ ++------------------------------------------------------+----------------------------------------------------------------------------------------------+--------------------+ +| :ref:`float` | :ref:`anchor_bottom` | ``0.0`` | ++------------------------------------------------------+----------------------------------------------------------------------------------------------+--------------------+ +| :ref:`float` | :ref:`anchor_left` | ``0.0`` | ++------------------------------------------------------+----------------------------------------------------------------------------------------------+--------------------+ +| :ref:`float` | :ref:`anchor_right` | ``0.0`` | ++------------------------------------------------------+----------------------------------------------------------------------------------------------+--------------------+ +| :ref:`float` | :ref:`anchor_top` | ``0.0`` | ++------------------------------------------------------+----------------------------------------------------------------------------------------------+--------------------+ +| :ref:`bool` | :ref:`auto_translate` | ``true`` | ++------------------------------------------------------+----------------------------------------------------------------------------------------------+--------------------+ +| :ref:`bool` | :ref:`clip_contents` | ``false`` | ++------------------------------------------------------+----------------------------------------------------------------------------------------------+--------------------+ +| :ref:`Vector2i` | :ref:`custom_minimum_size` | ``Vector2i(0, 0)`` | ++------------------------------------------------------+----------------------------------------------------------------------------------------------+--------------------+ +| :ref:`FocusMode` | :ref:`focus_mode` | ``0`` | ++------------------------------------------------------+----------------------------------------------------------------------------------------------+--------------------+ +| :ref:`NodePath` | :ref:`focus_neighbor_bottom` | ``NodePath("")`` | ++------------------------------------------------------+----------------------------------------------------------------------------------------------+--------------------+ +| :ref:`NodePath` | :ref:`focus_neighbor_left` | ``NodePath("")`` | ++------------------------------------------------------+----------------------------------------------------------------------------------------------+--------------------+ +| :ref:`NodePath` | :ref:`focus_neighbor_right` | ``NodePath("")`` | ++------------------------------------------------------+----------------------------------------------------------------------------------------------+--------------------+ +| :ref:`NodePath` | :ref:`focus_neighbor_top` | ``NodePath("")`` | ++------------------------------------------------------+----------------------------------------------------------------------------------------------+--------------------+ +| :ref:`NodePath` | :ref:`focus_next` | ``NodePath("")`` | ++------------------------------------------------------+----------------------------------------------------------------------------------------------+--------------------+ +| :ref:`NodePath` | :ref:`focus_previous` | ``NodePath("")`` | ++------------------------------------------------------+----------------------------------------------------------------------------------------------+--------------------+ +| :ref:`Vector2` | :ref:`global_position` | | ++------------------------------------------------------+----------------------------------------------------------------------------------------------+--------------------+ +| :ref:`GrowDirection` | :ref:`grow_horizontal` | ``1`` | ++------------------------------------------------------+----------------------------------------------------------------------------------------------+--------------------+ +| :ref:`GrowDirection` | :ref:`grow_vertical` | ``1`` | ++------------------------------------------------------+----------------------------------------------------------------------------------------------+--------------------+ +| :ref:`LayoutDirection` | :ref:`layout_direction` | ``0`` | ++------------------------------------------------------+----------------------------------------------------------------------------------------------+--------------------+ +| :ref:`CursorShape` | :ref:`mouse_default_cursor_shape` | ``0`` | ++------------------------------------------------------+----------------------------------------------------------------------------------------------+--------------------+ +| :ref:`MouseFilter` | :ref:`mouse_filter` | ``0`` | ++------------------------------------------------------+----------------------------------------------------------------------------------------------+--------------------+ +| :ref:`bool` | :ref:`mouse_force_pass_scroll_events` | ``true`` | ++------------------------------------------------------+----------------------------------------------------------------------------------------------+--------------------+ +| :ref:`float` | :ref:`offset_bottom` | ``0.0`` | ++------------------------------------------------------+----------------------------------------------------------------------------------------------+--------------------+ +| :ref:`float` | :ref:`offset_left` | ``0.0`` | ++------------------------------------------------------+----------------------------------------------------------------------------------------------+--------------------+ +| :ref:`float` | :ref:`offset_right` | ``0.0`` | ++------------------------------------------------------+----------------------------------------------------------------------------------------------+--------------------+ +| :ref:`float` | :ref:`offset_top` | ``0.0`` | ++------------------------------------------------------+----------------------------------------------------------------------------------------------+--------------------+ +| :ref:`Vector2` | :ref:`pivot_offset` | ``Vector2(0, 0)`` | ++------------------------------------------------------+----------------------------------------------------------------------------------------------+--------------------+ +| :ref:`Vector2` | :ref:`position` | ``Vector2(0, 0)`` | ++------------------------------------------------------+----------------------------------------------------------------------------------------------+--------------------+ +| :ref:`float` | :ref:`rotation` | ``0.0`` | ++------------------------------------------------------+----------------------------------------------------------------------------------------------+--------------------+ +| :ref:`Vector2` | :ref:`scale` | ``Vector2(1, 1)`` | ++------------------------------------------------------+----------------------------------------------------------------------------------------------+--------------------+ +| :ref:`Vector2` | :ref:`size` | ``Vector2(0, 0)`` | ++------------------------------------------------------+----------------------------------------------------------------------------------------------+--------------------+ +| :ref:`int` | :ref:`size_flags_horizontal` | ``1`` | ++------------------------------------------------------+----------------------------------------------------------------------------------------------+--------------------+ +| :ref:`float` | :ref:`size_flags_stretch_ratio` | ``1.0`` | ++------------------------------------------------------+----------------------------------------------------------------------------------------------+--------------------+ +| :ref:`int` | :ref:`size_flags_vertical` | ``1`` | ++------------------------------------------------------+----------------------------------------------------------------------------------------------+--------------------+ +| :ref:`Theme` | :ref:`theme` | | ++------------------------------------------------------+----------------------------------------------------------------------------------------------+--------------------+ +| :ref:`StringName` | :ref:`theme_type_variation` | ``&""`` | ++------------------------------------------------------+----------------------------------------------------------------------------------------------+--------------------+ +| :ref:`String` | :ref:`tooltip_text` | ``""`` | ++------------------------------------------------------+----------------------------------------------------------------------------------------------+--------------------+ Methods ------- @@ -840,10 +840,10 @@ Enables whether rendering of :ref:`CanvasItem` based children .. _class_Control_property_custom_minimum_size: -- :ref:`Vector2` **custom_minimum_size** +- :ref:`Vector2i` **custom_minimum_size** +-----------+--------------------------------+ -| *Default* | ``Vector2(0, 0)`` | +| *Default* | ``Vector2i(0, 0)`` | +-----------+--------------------------------+ | *Setter* | set_custom_minimum_size(value) | +-----------+--------------------------------+ diff --git a/classes/class_crypto.rst b/classes/class_crypto.rst index f190f7af3..04200fd5a 100644 --- a/classes/class_crypto.rst +++ b/classes/class_crypto.rst @@ -156,7 +156,7 @@ Generates a :ref:`PackedByteArray` of cryptographically s - :ref:`CryptoKey` **generate_rsa** **(** :ref:`int` size **)** -Generates an RSA :ref:`CryptoKey` that can be used for creating self-signed certificates and passed to :ref:`StreamPeerSSL.accept_stream`. +Generates an RSA :ref:`CryptoKey` that can be used for creating self-signed certificates and passed to :ref:`StreamPeerTLS.accept_stream`. ---- diff --git a/classes/class_cryptokey.rst b/classes/class_cryptokey.rst index 422f9a01c..38e34d434 100644 --- a/classes/class_cryptokey.rst +++ b/classes/class_cryptokey.rst @@ -19,7 +19,7 @@ Description The CryptoKey class represents a cryptographic key. Keys can be loaded and saved like any other :ref:`Resource`. -They can be used to generate a self-signed :ref:`X509Certificate` via :ref:`Crypto.generate_self_signed_certificate` and as private key in :ref:`StreamPeerSSL.accept_stream` along with the appropriate certificate. +They can be used to generate a self-signed :ref:`X509Certificate` via :ref:`Crypto.generate_self_signed_certificate` and as private key in :ref:`StreamPeerTLS.accept_stream` along with the appropriate certificate. Methods ------- diff --git a/classes/class_dictionary.rst b/classes/class_dictionary.rst index f9e042400..3722b869a 100644 --- a/classes/class_dictionary.rst +++ b/classes/class_dictionary.rst @@ -15,7 +15,7 @@ Dictionary type. Description ----------- -Dictionary type. Associative container which contains values referenced by unique keys. Dictionaries are composed of pairs of keys (which must be unique) and values. Dictionaries will preserve the insertion order when adding elements, even though this may not be reflected when printing the dictionary. In other programming languages, this data structure is sometimes referred to as a hash map or associative array. +Dictionary type. Associative container, which contains values referenced by unique keys. Dictionaries are composed of pairs of keys (which must be unique) and values. Dictionaries will preserve the insertion order when adding elements. In other programming languages, this data structure is sometimes referred to as a hash map or associative array. You can define a dictionary by placing a comma-separated list of ``key: value`` pairs in curly braces ``{}``. @@ -262,6 +262,8 @@ Methods +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`erase` **(** :ref:`Variant` key **)** | +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`find_key` **(** :ref:`Variant` value **)** |const| | ++-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`get` **(** :ref:`Variant` key, :ref:`Variant` default=null **)** |const| | +-------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has` **(** :ref:`Variant` key **)** |const| | @@ -336,6 +338,16 @@ Erase a dictionary key/value pair by key. Returns ``true`` if the given key was ---- +.. _class_Dictionary_method_find_key: + +- :ref:`Variant` **find_key** **(** :ref:`Variant` value **)** |const| + +Returns the first key whose associated value is equal to ``value``, or ``null`` if no such value is found. + +\ **Note:** ``null`` is also a valid key. If you have it in your ``Dictionary``, the :ref:`find_key` method can give misleading results. + +---- + .. _class_Dictionary_method_get: - :ref:`Variant` **get** **(** :ref:`Variant` key, :ref:`Variant` default=null **)** |const| diff --git a/classes/class_displayserver.rst b/classes/class_displayserver.rst index 8ea9dd542..996f35c28 100644 --- a/classes/class_displayserver.rst +++ b/classes/class_displayserver.rst @@ -17,301 +17,311 @@ DisplayServer Methods ------- -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`clipboard_get` **(** **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`clipboard_get_primary` **(** **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`clipboard_has` **(** **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clipboard_set` **(** :ref:`String` clipboard **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clipboard_set_primary` **(** :ref:`String` clipboard_primary **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`create_sub_window` **(** :ref:`WindowMode` mode, :ref:`VSyncMode` vsync_mode, :ref:`int` flags, :ref:`Rect2i` rect=Rect2i(0, 0, 0, 0) **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`CursorShape` | :ref:`cursor_get_shape` **(** **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cursor_set_custom_image` **(** :ref:`Resource` cursor, :ref:`CursorShape` shape=0, :ref:`Vector2` hotspot=Vector2(0, 0) **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`cursor_set_shape` **(** :ref:`CursorShape` shape **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`delete_sub_window` **(** :ref:`int` window_id **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`dialog_input_text` **(** :ref:`String` title, :ref:`String` description, :ref:`String` existing_text, :ref:`Callable` callback **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`dialog_show` **(** :ref:`String` title, :ref:`String` description, :ref:`PackedStringArray` buttons, :ref:`Callable` callback **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`enable_for_stealing_focus` **(** :ref:`int` process_id **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`force_process_and_drop_events` **(** **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2[]` | :ref:`get_display_cutouts` **(** **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2i` | :ref:`get_display_safe_area` **(** **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_name` **(** **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_screen_count` **(** **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`get_swap_cancel_ok` **(** **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_window_at_screen_position` **(** :ref:`Vector2i` position **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedInt32Array` | :ref:`get_window_list` **(** **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`global_menu_add_check_item` **(** :ref:`String` menu_root, :ref:`String` label, :ref:`Callable` callback, :ref:`Variant` tag=null, :ref:`Key` accelerator=0, :ref:`int` index=-1 **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`global_menu_add_icon_check_item` **(** :ref:`String` menu_root, :ref:`Texture2D` icon, :ref:`String` label, :ref:`Callable` callback, :ref:`Variant` tag=null, :ref:`Key` accelerator=0, :ref:`int` index=-1 **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`global_menu_add_icon_item` **(** :ref:`String` menu_root, :ref:`Texture2D` icon, :ref:`String` label, :ref:`Callable` callback, :ref:`Variant` tag=null, :ref:`Key` accelerator=0, :ref:`int` index=-1 **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`global_menu_add_icon_radio_check_item` **(** :ref:`String` menu_root, :ref:`Texture2D` icon, :ref:`String` label, :ref:`Callable` callback, :ref:`Variant` tag=null, :ref:`Key` accelerator=0, :ref:`int` index=-1 **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`global_menu_add_item` **(** :ref:`String` menu_root, :ref:`String` label, :ref:`Callable` callback, :ref:`Variant` tag=null, :ref:`Key` accelerator=0, :ref:`int` index=-1 **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`global_menu_add_multistate_item` **(** :ref:`String` menu_root, :ref:`String` labe, :ref:`int` max_states, :ref:`int` default_state, :ref:`Callable` callback, :ref:`Variant` tag=null, :ref:`Key` accelerator=0, :ref:`int` index=-1 **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`global_menu_add_radio_check_item` **(** :ref:`String` menu_root, :ref:`String` label, :ref:`Callable` callback, :ref:`Variant` tag=null, :ref:`Key` accelerator=0, :ref:`int` index=-1 **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`global_menu_add_separator` **(** :ref:`String` menu_root, :ref:`int` index=-1 **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`global_menu_add_submenu_item` **(** :ref:`String` menu_root, :ref:`String` label, :ref:`String` submenu, :ref:`int` index=-1 **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`global_menu_clear` **(** :ref:`String` menu_root **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Key` | :ref:`global_menu_get_item_accelerator` **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Callable` | :ref:`global_menu_get_item_callback` **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture2D` | :ref:`global_menu_get_item_icon` **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`global_menu_get_item_indentation_level` **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`global_menu_get_item_index_from_tag` **(** :ref:`String` menu_root, :ref:`Variant` tag **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`global_menu_get_item_index_from_text` **(** :ref:`String` menu_root, :ref:`String` text **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`global_menu_get_item_max_states` **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`global_menu_get_item_state` **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`global_menu_get_item_submenu` **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`global_menu_get_item_tag` **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`global_menu_get_item_text` **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`global_menu_get_item_tooltip` **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`global_menu_is_item_checkable` **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`global_menu_is_item_checked` **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`global_menu_is_item_disabled` **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`global_menu_is_item_radio_checkable` **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`global_menu_remove_item` **(** :ref:`String` menu_root, :ref:`int` idx **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`global_menu_set_item_accelerator` **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`Key` keycode **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`global_menu_set_item_callback` **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`Callable` callback **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`global_menu_set_item_checkable` **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`bool` checkable **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`global_menu_set_item_checked` **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`bool` checked **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`global_menu_set_item_disabled` **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`bool` disabled **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`global_menu_set_item_icon` **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`Texture2D` icon **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`global_menu_set_item_indentation_level` **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`int` level **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`global_menu_set_item_max_states` **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`int` max_states **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`global_menu_set_item_radio_checkable` **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`bool` checkable **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`global_menu_set_item_state` **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`int` state **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`global_menu_set_item_submenu` **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`String` submenu **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`global_menu_set_item_tag` **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`Variant` tag **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`global_menu_set_item_text` **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`String` text **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`global_menu_set_item_tooltip` **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`String` tooltip **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_feature` **(** :ref:`Feature` feature **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2i` | :ref:`ime_get_selection` **(** **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`ime_get_text` **(** **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`keyboard_get_current_layout` **(** **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Key` | :ref:`keyboard_get_keycode_from_physical` **(** :ref:`Key` keycode **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`keyboard_get_layout_count` **(** **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`keyboard_get_layout_language` **(** :ref:`int` index **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`keyboard_get_layout_name` **(** :ref:`int` index **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`keyboard_set_current_layout` **(** :ref:`int` index **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`MouseButton` | :ref:`mouse_get_button_state` **(** **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`MouseMode` | :ref:`mouse_get_mode` **(** **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2i` | :ref:`mouse_get_position` **(** **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mouse_set_mode` **(** :ref:`MouseMode` mouse_mode **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`process_events` **(** **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`screen_get_dpi` **(** :ref:`int` screen=-1 **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`screen_get_max_scale` **(** **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ScreenOrientation` | :ref:`screen_get_orientation` **(** :ref:`int` screen=-1 **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2i` | :ref:`screen_get_position` **(** :ref:`int` screen=-1 **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`screen_get_refresh_rate` **(** :ref:`int` screen=-1 **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`screen_get_scale` **(** :ref:`int` screen=-1 **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2i` | :ref:`screen_get_size` **(** :ref:`int` screen=-1 **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2i` | :ref:`screen_get_usable_rect` **(** :ref:`int` screen=-1 **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`screen_is_kept_on` **(** **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`screen_is_touchscreen` **(** :ref:`int` screen=-1 **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`screen_set_keep_on` **(** :ref:`bool` enable **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`screen_set_orientation` **(** :ref:`ScreenOrientation` orientation, :ref:`int` screen=-1 **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_icon` **(** :ref:`Image` image **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_native_icon` **(** :ref:`String` filename **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`tablet_get_current_driver` **(** **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`tablet_get_driver_count` **(** **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`tablet_get_driver_name` **(** :ref:`int` idx **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tablet_set_current_driver` **(** :ref:`String` name **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary[]` | :ref:`tts_get_voices` **(** **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedStringArray` | :ref:`tts_get_voices_for_language` **(** :ref:`String` language **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`tts_is_paused` **(** **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`tts_is_speaking` **(** **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tts_pause` **(** **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tts_resume` **(** **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tts_set_utterance_callback` **(** :ref:`TTSUtteranceEvent` event, :ref:`Callable` callable **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tts_speak` **(** :ref:`String` text, :ref:`String` voice, :ref:`int` volume=50, :ref:`float` pitch=1.0, :ref:`float` rate=1.0, :ref:`int` utterance_id=0, :ref:`bool` interrupt=false **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`tts_stop` **(** **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`virtual_keyboard_get_height` **(** **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`virtual_keyboard_hide` **(** **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`virtual_keyboard_show` **(** :ref:`String` existing_text, :ref:`Rect2` position=Rect2(0, 0, 0, 0), :ref:`VirtualKeyboardType` type=0, :ref:`int` max_length=-1, :ref:`int` cursor_start=-1, :ref:`int` cursor_end=-1 **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`warp_mouse` **(** :ref:`Vector2i` position **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`window_attach_instance_id` **(** :ref:`int` instance_id, :ref:`int` window_id=0 **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`window_can_draw` **(** :ref:`int` window_id=0 **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`window_get_active_popup` **(** **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`window_get_attached_instance_id` **(** :ref:`int` window_id=0 **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`window_get_current_screen` **(** :ref:`int` window_id=0 **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`window_get_flag` **(** :ref:`WindowFlags` flag, :ref:`int` window_id=0 **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2i` | :ref:`window_get_max_size` **(** :ref:`int` window_id=0 **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2i` | :ref:`window_get_min_size` **(** :ref:`int` window_id=0 **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`WindowMode` | :ref:`window_get_mode` **(** :ref:`int` window_id=0 **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`window_get_native_handle` **(** :ref:`HandleType` handle_type, :ref:`int` window_id=0 **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2i` | :ref:`window_get_popup_safe_rect` **(** :ref:`int` window **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2i` | :ref:`window_get_position` **(** :ref:`int` window_id=0 **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2i` | :ref:`window_get_real_size` **(** :ref:`int` window_id=0 **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2i` | :ref:`window_get_safe_title_margins` **(** :ref:`int` window_id=0 **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2i` | :ref:`window_get_size` **(** :ref:`int` window_id=0 **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`VSyncMode` | :ref:`window_get_vsync_mode` **(** :ref:`int` window_id=0 **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`window_maximize_on_title_dbl_click` **(** **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`window_minimize_on_title_dbl_click` **(** **)** |const| | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`window_move_to_foreground` **(** :ref:`int` window_id=0 **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`window_request_attention` **(** :ref:`int` window_id=0 **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`window_set_current_screen` **(** :ref:`int` screen, :ref:`int` window_id=0 **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`window_set_drop_files_callback` **(** :ref:`Callable` callback, :ref:`int` window_id=0 **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`window_set_exclusive` **(** :ref:`int` window_id, :ref:`bool` exclusive **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`window_set_flag` **(** :ref:`WindowFlags` flag, :ref:`bool` enabled, :ref:`int` window_id=0 **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`window_set_ime_active` **(** :ref:`bool` active, :ref:`int` window_id=0 **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`window_set_ime_position` **(** :ref:`Vector2i` position, :ref:`int` window_id=0 **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`window_set_input_event_callback` **(** :ref:`Callable` callback, :ref:`int` window_id=0 **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`window_set_input_text_callback` **(** :ref:`Callable` callback, :ref:`int` window_id=0 **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`window_set_max_size` **(** :ref:`Vector2i` max_size, :ref:`int` window_id=0 **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`window_set_min_size` **(** :ref:`Vector2i` min_size, :ref:`int` window_id=0 **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`window_set_mode` **(** :ref:`WindowMode` mode, :ref:`int` window_id=0 **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`window_set_mouse_passthrough` **(** :ref:`PackedVector2Array` region, :ref:`int` window_id=0 **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`window_set_popup_safe_rect` **(** :ref:`int` window, :ref:`Rect2i` rect **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`window_set_position` **(** :ref:`Vector2i` position, :ref:`int` window_id=0 **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`window_set_rect_changed_callback` **(** :ref:`Callable` callback, :ref:`int` window_id=0 **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`window_set_size` **(** :ref:`Vector2i` size, :ref:`int` window_id=0 **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`window_set_title` **(** :ref:`String` title, :ref:`int` window_id=0 **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`window_set_transient` **(** :ref:`int` window_id, :ref:`int` parent_window_id **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`window_set_vsync_mode` **(** :ref:`VSyncMode` vsync_mode, :ref:`int` window_id=0 **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`window_set_window_event_callback` **(** :ref:`Callable` callback, :ref:`int` window_id=0 **)** | -+----------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`clipboard_get` **(** **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`clipboard_get_primary` **(** **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`clipboard_has` **(** **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clipboard_set` **(** :ref:`String` clipboard **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clipboard_set_primary` **(** :ref:`String` clipboard_primary **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`create_sub_window` **(** :ref:`WindowMode` mode, :ref:`VSyncMode` vsync_mode, :ref:`int` flags, :ref:`Rect2i` rect=Rect2i(0, 0, 0, 0) **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`CursorShape` | :ref:`cursor_get_shape` **(** **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`cursor_set_custom_image` **(** :ref:`Resource` cursor, :ref:`CursorShape` shape=0, :ref:`Vector2` hotspot=Vector2(0, 0) **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`cursor_set_shape` **(** :ref:`CursorShape` shape **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`delete_sub_window` **(** :ref:`int` window_id **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`dialog_input_text` **(** :ref:`String` title, :ref:`String` description, :ref:`String` existing_text, :ref:`Callable` callback **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`dialog_show` **(** :ref:`String` title, :ref:`String` description, :ref:`PackedStringArray` buttons, :ref:`Callable` callback **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`enable_for_stealing_focus` **(** :ref:`int` process_id **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`force_process_and_drop_events` **(** **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_accent_color` **(** **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2[]` | :ref:`get_display_cutouts` **(** **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2i` | :ref:`get_display_safe_area` **(** **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_name` **(** **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_screen_count` **(** **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_swap_cancel_ok` **(** **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_window_at_screen_position` **(** :ref:`Vector2i` position **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedInt32Array` | :ref:`get_window_list` **(** **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`global_menu_add_check_item` **(** :ref:`String` menu_root, :ref:`String` label, :ref:`Callable` callback, :ref:`Callable` key_callback, :ref:`Variant` tag=null, :ref:`Key` accelerator=0, :ref:`int` index=-1 **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`global_menu_add_icon_check_item` **(** :ref:`String` menu_root, :ref:`Texture2D` icon, :ref:`String` label, :ref:`Callable` callback, :ref:`Callable` key_callback, :ref:`Variant` tag=null, :ref:`Key` accelerator=0, :ref:`int` index=-1 **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`global_menu_add_icon_item` **(** :ref:`String` menu_root, :ref:`Texture2D` icon, :ref:`String` label, :ref:`Callable` callback, :ref:`Callable` key_callback, :ref:`Variant` tag=null, :ref:`Key` accelerator=0, :ref:`int` index=-1 **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`global_menu_add_icon_radio_check_item` **(** :ref:`String` menu_root, :ref:`Texture2D` icon, :ref:`String` label, :ref:`Callable` callback, :ref:`Callable` key_callback, :ref:`Variant` tag=null, :ref:`Key` accelerator=0, :ref:`int` index=-1 **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`global_menu_add_item` **(** :ref:`String` menu_root, :ref:`String` label, :ref:`Callable` callback, :ref:`Callable` key_callback, :ref:`Variant` tag=null, :ref:`Key` accelerator=0, :ref:`int` index=-1 **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`global_menu_add_multistate_item` **(** :ref:`String` menu_root, :ref:`String` labe, :ref:`int` max_states, :ref:`int` default_state, :ref:`Callable` callback, :ref:`Callable` key_callback, :ref:`Variant` tag=null, :ref:`Key` accelerator=0, :ref:`int` index=-1 **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`global_menu_add_radio_check_item` **(** :ref:`String` menu_root, :ref:`String` label, :ref:`Callable` callback, :ref:`Callable` key_callback, :ref:`Variant` tag=null, :ref:`Key` accelerator=0, :ref:`int` index=-1 **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`global_menu_add_separator` **(** :ref:`String` menu_root, :ref:`int` index=-1 **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`global_menu_add_submenu_item` **(** :ref:`String` menu_root, :ref:`String` label, :ref:`String` submenu, :ref:`int` index=-1 **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`global_menu_clear` **(** :ref:`String` menu_root **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Key` | :ref:`global_menu_get_item_accelerator` **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Callable` | :ref:`global_menu_get_item_callback` **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture2D` | :ref:`global_menu_get_item_icon` **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`global_menu_get_item_indentation_level` **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`global_menu_get_item_index_from_tag` **(** :ref:`String` menu_root, :ref:`Variant` tag **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`global_menu_get_item_index_from_text` **(** :ref:`String` menu_root, :ref:`String` text **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Callable` | :ref:`global_menu_get_item_key_callback` **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`global_menu_get_item_max_states` **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`global_menu_get_item_state` **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`global_menu_get_item_submenu` **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`global_menu_get_item_tag` **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`global_menu_get_item_text` **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`global_menu_get_item_tooltip` **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`global_menu_is_item_checkable` **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`global_menu_is_item_checked` **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`global_menu_is_item_disabled` **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`global_menu_is_item_radio_checkable` **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`global_menu_remove_item` **(** :ref:`String` menu_root, :ref:`int` idx **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`global_menu_set_item_accelerator` **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`Key` keycode **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`global_menu_set_item_callback` **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`Callable` callback **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`global_menu_set_item_checkable` **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`bool` checkable **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`global_menu_set_item_checked` **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`bool` checked **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`global_menu_set_item_disabled` **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`bool` disabled **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`global_menu_set_item_icon` **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`Texture2D` icon **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`global_menu_set_item_indentation_level` **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`int` level **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`global_menu_set_item_key_callback` **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`Callable` key_callback **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`global_menu_set_item_max_states` **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`int` max_states **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`global_menu_set_item_radio_checkable` **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`bool` checkable **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`global_menu_set_item_state` **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`int` state **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`global_menu_set_item_submenu` **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`String` submenu **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`global_menu_set_item_tag` **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`Variant` tag **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`global_menu_set_item_text` **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`String` text **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`global_menu_set_item_tooltip` **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`String` tooltip **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_feature` **(** :ref:`Feature` feature **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2i` | :ref:`ime_get_selection` **(** **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`ime_get_text` **(** **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_dark_mode` **(** **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_dark_mode_supported` **(** **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`keyboard_get_current_layout` **(** **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Key` | :ref:`keyboard_get_keycode_from_physical` **(** :ref:`Key` keycode **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`keyboard_get_layout_count` **(** **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`keyboard_get_layout_language` **(** :ref:`int` index **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`keyboard_get_layout_name` **(** :ref:`int` index **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`keyboard_set_current_layout` **(** :ref:`int` index **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`MouseButton` | :ref:`mouse_get_button_state` **(** **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`MouseMode` | :ref:`mouse_get_mode` **(** **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2i` | :ref:`mouse_get_position` **(** **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`mouse_set_mode` **(** :ref:`MouseMode` mouse_mode **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`process_events` **(** **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`screen_get_dpi` **(** :ref:`int` screen=-1 **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`screen_get_max_scale` **(** **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ScreenOrientation` | :ref:`screen_get_orientation` **(** :ref:`int` screen=-1 **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2i` | :ref:`screen_get_position` **(** :ref:`int` screen=-1 **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`screen_get_refresh_rate` **(** :ref:`int` screen=-1 **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`screen_get_scale` **(** :ref:`int` screen=-1 **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2i` | :ref:`screen_get_size` **(** :ref:`int` screen=-1 **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2i` | :ref:`screen_get_usable_rect` **(** :ref:`int` screen=-1 **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`screen_is_kept_on` **(** **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`screen_is_touchscreen` **(** :ref:`int` screen=-1 **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`screen_set_keep_on` **(** :ref:`bool` enable **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`screen_set_orientation` **(** :ref:`ScreenOrientation` orientation, :ref:`int` screen=-1 **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_icon` **(** :ref:`Image` image **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_native_icon` **(** :ref:`String` filename **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`tablet_get_current_driver` **(** **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`tablet_get_driver_count` **(** **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`tablet_get_driver_name` **(** :ref:`int` idx **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tablet_set_current_driver` **(** :ref:`String` name **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary[]` | :ref:`tts_get_voices` **(** **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`tts_get_voices_for_language` **(** :ref:`String` language **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`tts_is_paused` **(** **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`tts_is_speaking` **(** **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tts_pause` **(** **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tts_resume` **(** **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tts_set_utterance_callback` **(** :ref:`TTSUtteranceEvent` event, :ref:`Callable` callable **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tts_speak` **(** :ref:`String` text, :ref:`String` voice, :ref:`int` volume=50, :ref:`float` pitch=1.0, :ref:`float` rate=1.0, :ref:`int` utterance_id=0, :ref:`bool` interrupt=false **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`tts_stop` **(** **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`virtual_keyboard_get_height` **(** **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`virtual_keyboard_hide` **(** **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`virtual_keyboard_show` **(** :ref:`String` existing_text, :ref:`Rect2` position=Rect2(0, 0, 0, 0), :ref:`VirtualKeyboardType` type=0, :ref:`int` max_length=-1, :ref:`int` cursor_start=-1, :ref:`int` cursor_end=-1 **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`warp_mouse` **(** :ref:`Vector2i` position **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`window_attach_instance_id` **(** :ref:`int` instance_id, :ref:`int` window_id=0 **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`window_can_draw` **(** :ref:`int` window_id=0 **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`window_get_active_popup` **(** **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`window_get_attached_instance_id` **(** :ref:`int` window_id=0 **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`window_get_current_screen` **(** :ref:`int` window_id=0 **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`window_get_flag` **(** :ref:`WindowFlags` flag, :ref:`int` window_id=0 **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2i` | :ref:`window_get_max_size` **(** :ref:`int` window_id=0 **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2i` | :ref:`window_get_min_size` **(** :ref:`int` window_id=0 **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`WindowMode` | :ref:`window_get_mode` **(** :ref:`int` window_id=0 **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`window_get_native_handle` **(** :ref:`HandleType` handle_type, :ref:`int` window_id=0 **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2i` | :ref:`window_get_popup_safe_rect` **(** :ref:`int` window **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2i` | :ref:`window_get_position` **(** :ref:`int` window_id=0 **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2i` | :ref:`window_get_real_size` **(** :ref:`int` window_id=0 **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2i` | :ref:`window_get_safe_title_margins` **(** :ref:`int` window_id=0 **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2i` | :ref:`window_get_size` **(** :ref:`int` window_id=0 **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`VSyncMode` | :ref:`window_get_vsync_mode` **(** :ref:`int` window_id=0 **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`window_maximize_on_title_dbl_click` **(** **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`window_minimize_on_title_dbl_click` **(** **)** |const| | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`window_move_to_foreground` **(** :ref:`int` window_id=0 **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`window_request_attention` **(** :ref:`int` window_id=0 **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`window_set_current_screen` **(** :ref:`int` screen, :ref:`int` window_id=0 **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`window_set_drop_files_callback` **(** :ref:`Callable` callback, :ref:`int` window_id=0 **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`window_set_exclusive` **(** :ref:`int` window_id, :ref:`bool` exclusive **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`window_set_flag` **(** :ref:`WindowFlags` flag, :ref:`bool` enabled, :ref:`int` window_id=0 **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`window_set_ime_active` **(** :ref:`bool` active, :ref:`int` window_id=0 **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`window_set_ime_position` **(** :ref:`Vector2i` position, :ref:`int` window_id=0 **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`window_set_input_event_callback` **(** :ref:`Callable` callback, :ref:`int` window_id=0 **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`window_set_input_text_callback` **(** :ref:`Callable` callback, :ref:`int` window_id=0 **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`window_set_max_size` **(** :ref:`Vector2i` max_size, :ref:`int` window_id=0 **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`window_set_min_size` **(** :ref:`Vector2i` min_size, :ref:`int` window_id=0 **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`window_set_mode` **(** :ref:`WindowMode` mode, :ref:`int` window_id=0 **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`window_set_mouse_passthrough` **(** :ref:`PackedVector2Array` region, :ref:`int` window_id=0 **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`window_set_popup_safe_rect` **(** :ref:`int` window, :ref:`Rect2i` rect **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`window_set_position` **(** :ref:`Vector2i` position, :ref:`int` window_id=0 **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`window_set_rect_changed_callback` **(** :ref:`Callable` callback, :ref:`int` window_id=0 **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`window_set_size` **(** :ref:`Vector2i` size, :ref:`int` window_id=0 **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`window_set_title` **(** :ref:`String` title, :ref:`int` window_id=0 **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`window_set_transient` **(** :ref:`int` window_id, :ref:`int` parent_window_id **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`window_set_vsync_mode` **(** :ref:`VSyncMode` vsync_mode, :ref:`int` window_id=0 **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`window_set_window_event_callback` **(** :ref:`Callable` callback, :ref:`int` window_id=0 **)** | ++----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ @@ -882,6 +892,16 @@ Sets the user's primary clipboard content to the given string. ---- +.. _class_DisplayServer_method_get_accent_color: + +- :ref:`Color` **get_accent_color** **(** **)** |const| + +Returns OS theme accent color. Returns ``Color(0, 0, 0, 0)``, if accent color is unknown. + +\ **Note:** This method is implemented on macOS and Windows. + +---- + .. _class_DisplayServer_method_get_display_cutouts: - :ref:`Rect2[]` **get_display_cutouts** **(** **)** |const| @@ -932,7 +952,7 @@ Returns the unobscured area of the display where interactive controls should be .. _class_DisplayServer_method_global_menu_add_check_item: -- :ref:`int` **global_menu_add_check_item** **(** :ref:`String` menu_root, :ref:`String` label, :ref:`Callable` callback, :ref:`Variant` tag=null, :ref:`Key` accelerator=0, :ref:`int` index=-1 **)** +- :ref:`int` **global_menu_add_check_item** **(** :ref:`String` menu_root, :ref:`String` label, :ref:`Callable` callback, :ref:`Callable` key_callback, :ref:`Variant` tag=null, :ref:`Key` accelerator=0, :ref:`int` index=-1 **)** Adds a new checkable item with text ``label`` to the global menu with ID ``menu_root``. @@ -951,7 +971,7 @@ Returns index of the inserted item, it's not guaranteed to be the same as ``inde .. _class_DisplayServer_method_global_menu_add_icon_check_item: -- :ref:`int` **global_menu_add_icon_check_item** **(** :ref:`String` menu_root, :ref:`Texture2D` icon, :ref:`String` label, :ref:`Callable` callback, :ref:`Variant` tag=null, :ref:`Key` accelerator=0, :ref:`int` index=-1 **)** +- :ref:`int` **global_menu_add_icon_check_item** **(** :ref:`String` menu_root, :ref:`Texture2D` icon, :ref:`String` label, :ref:`Callable` callback, :ref:`Callable` key_callback, :ref:`Variant` tag=null, :ref:`Key` accelerator=0, :ref:`int` index=-1 **)** Adds a new checkable item with text ``label`` and icon ``icon`` to the global menu with ID ``menu_root``. @@ -970,7 +990,7 @@ Returns index of the inserted item, it's not guaranteed to be the same as ``inde .. _class_DisplayServer_method_global_menu_add_icon_item: -- :ref:`int` **global_menu_add_icon_item** **(** :ref:`String` menu_root, :ref:`Texture2D` icon, :ref:`String` label, :ref:`Callable` callback, :ref:`Variant` tag=null, :ref:`Key` accelerator=0, :ref:`int` index=-1 **)** +- :ref:`int` **global_menu_add_icon_item** **(** :ref:`String` menu_root, :ref:`Texture2D` icon, :ref:`String` label, :ref:`Callable` callback, :ref:`Callable` key_callback, :ref:`Variant` tag=null, :ref:`Key` accelerator=0, :ref:`int` index=-1 **)** Adds a new item with text ``label`` and icon ``icon`` to the global menu with ID ``menu_root``. @@ -989,7 +1009,7 @@ Returns index of the inserted item, it's not guaranteed to be the same as ``inde .. _class_DisplayServer_method_global_menu_add_icon_radio_check_item: -- :ref:`int` **global_menu_add_icon_radio_check_item** **(** :ref:`String` menu_root, :ref:`Texture2D` icon, :ref:`String` label, :ref:`Callable` callback, :ref:`Variant` tag=null, :ref:`Key` accelerator=0, :ref:`int` index=-1 **)** +- :ref:`int` **global_menu_add_icon_radio_check_item** **(** :ref:`String` menu_root, :ref:`Texture2D` icon, :ref:`String` label, :ref:`Callable` callback, :ref:`Callable` key_callback, :ref:`Variant` tag=null, :ref:`Key` accelerator=0, :ref:`int` index=-1 **)** Adds a new radio-checkable item with text ``label`` and icon ``icon`` to the global menu with ID ``menu_root``. @@ -1010,7 +1030,7 @@ Returns index of the inserted item, it's not guaranteed to be the same as ``inde .. _class_DisplayServer_method_global_menu_add_item: -- :ref:`int` **global_menu_add_item** **(** :ref:`String` menu_root, :ref:`String` label, :ref:`Callable` callback, :ref:`Variant` tag=null, :ref:`Key` accelerator=0, :ref:`int` index=-1 **)** +- :ref:`int` **global_menu_add_item** **(** :ref:`String` menu_root, :ref:`String` label, :ref:`Callable` callback, :ref:`Callable` key_callback, :ref:`Variant` tag=null, :ref:`Key` accelerator=0, :ref:`int` index=-1 **)** Adds a new item with text ``label`` to the global menu with ID ``menu_root``. @@ -1029,7 +1049,7 @@ Returns index of the inserted item, it's not guaranteed to be the same as ``inde .. _class_DisplayServer_method_global_menu_add_multistate_item: -- :ref:`int` **global_menu_add_multistate_item** **(** :ref:`String` menu_root, :ref:`String` labe, :ref:`int` max_states, :ref:`int` default_state, :ref:`Callable` callback, :ref:`Variant` tag=null, :ref:`Key` accelerator=0, :ref:`int` index=-1 **)** +- :ref:`int` **global_menu_add_multistate_item** **(** :ref:`String` menu_root, :ref:`String` labe, :ref:`int` max_states, :ref:`int` default_state, :ref:`Callable` callback, :ref:`Callable` key_callback, :ref:`Variant` tag=null, :ref:`Key` accelerator=0, :ref:`int` index=-1 **)** Adds a new item with text ``labe`` to the global menu with ID ``menu_root``. @@ -1052,7 +1072,7 @@ Returns index of the inserted item, it's not guaranteed to be the same as ``inde .. _class_DisplayServer_method_global_menu_add_radio_check_item: -- :ref:`int` **global_menu_add_radio_check_item** **(** :ref:`String` menu_root, :ref:`String` label, :ref:`Callable` callback, :ref:`Variant` tag=null, :ref:`Key` accelerator=0, :ref:`int` index=-1 **)** +- :ref:`int` **global_menu_add_radio_check_item** **(** :ref:`String` menu_root, :ref:`String` label, :ref:`Callable` callback, :ref:`Callable` key_callback, :ref:`Variant` tag=null, :ref:`Key` accelerator=0, :ref:`int` index=-1 **)** Adds a new radio-checkable item with text ``label`` to the global menu with ID ``menu_root``. @@ -1186,6 +1206,16 @@ Returns the index of the item with the specified ``text``. Index is automaticall ---- +.. _class_DisplayServer_method_global_menu_get_item_key_callback: + +- :ref:`Callable` **global_menu_get_item_key_callback** **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| + +Returns the callback of the item accelerator at index ``idx``. + +\ **Note:** This method is implemented on macOS. + +---- + .. _class_DisplayServer_method_global_menu_get_item_max_states: - :ref:`int` **global_menu_get_item_max_states** **(** :ref:`String` menu_root, :ref:`int` idx **)** |const| @@ -1316,7 +1346,7 @@ Sets the accelerator of the item at index ``idx``. - void **global_menu_set_item_callback** **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`Callable` callback **)** -Sets the callback of the item at index ``idx``. Callback is emitted when an item is pressed or its accelerator is activated. +Sets the callback of the item at index ``idx``. Callback is emitted when an item is pressed. \ **Note:** This method is implemented on macOS. @@ -1374,6 +1404,16 @@ Sets the horizontal offset of the item at the given ``idx``. ---- +.. _class_DisplayServer_method_global_menu_set_item_key_callback: + +- void **global_menu_set_item_key_callback** **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`Callable` key_callback **)** + +Sets the callback of the item at index ``idx``. Callback is emitted when its accelerator is activated. + +\ **Note:** This method is implemented on macOS. + +---- + .. _class_DisplayServer_method_global_menu_set_item_max_states: - void **global_menu_set_item_max_states** **(** :ref:`String` menu_root, :ref:`int` idx, :ref:`int` max_states **)** @@ -1464,6 +1504,26 @@ Sets the :ref:`String` tooltip of the item at the specified index ---- +.. _class_DisplayServer_method_is_dark_mode: + +- :ref:`bool` **is_dark_mode** **(** **)** |const| + +Returns ``true`` if OS is using dark mode. + +\ **Note:** This method is implemented on macOS, Windows and Linux. + +---- + +.. _class_DisplayServer_method_is_dark_mode_supported: + +- :ref:`bool` **is_dark_mode_supported** **(** **)** |const| + +Returns ``true`` if OS supports dark mode. + +\ **Note:** This method is implemented on macOS, Windows and Linux. + +---- + .. _class_DisplayServer_method_keyboard_get_current_layout: - :ref:`int` **keyboard_get_current_layout** **(** **)** |const| diff --git a/classes/class_visualshadernodetexture2darrayuniform.rst b/classes/class_editorexportplatform.rst similarity index 65% rename from classes/class_visualshadernodetexture2darrayuniform.rst rename to classes/class_editorexportplatform.rst index 61176d466..7b1de8df4 100644 --- a/classes/class_visualshadernodetexture2darrayuniform.rst +++ b/classes/class_editorexportplatform.rst @@ -3,14 +3,14 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeTexture2DArrayUniform.xml. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorExportPlatform.xml. -.. _class_VisualShaderNodeTexture2DArrayUniform: +.. _class_EditorExportPlatform: -VisualShaderNodeTexture2DArrayUniform -===================================== +EditorExportPlatform +==================== -**Inherits:** :ref:`VisualShaderNodeTextureUniform` **<** :ref:`VisualShaderNodeUniform` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +**Inherits:** :ref:`RefCounted` **<** :ref:`Object` diff --git a/classes/class_editorexportplugin.rst b/classes/class_editorexportplugin.rst index 376fb3797..237c426fc 100644 --- a/classes/class_editorexportplugin.rst +++ b/classes/class_editorexportplugin.rst @@ -24,39 +24,105 @@ To use ``EditorExportPlugin``, register it using the :ref:`EditorPlugin.add_expo Methods ------- -+------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_export_begin` **(** :ref:`PackedStringArray` features, :ref:`bool` is_debug, :ref:`String` path, :ref:`int` flags **)** |virtual| | -+------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_export_end` **(** **)** |virtual| | -+------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_export_file` **(** :ref:`String` path, :ref:`String` type, :ref:`PackedStringArray` features **)** |virtual| | -+------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_file` **(** :ref:`String` path, :ref:`PackedByteArray` file, :ref:`bool` remap **)** | -+------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_ios_bundle_file` **(** :ref:`String` path **)** | -+------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_ios_cpp_code` **(** :ref:`String` code **)** | -+------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_ios_embedded_framework` **(** :ref:`String` path **)** | -+------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_ios_framework` **(** :ref:`String` path **)** | -+------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_ios_linker_flags` **(** :ref:`String` flags **)** | -+------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_ios_plist_content` **(** :ref:`String` plist_content **)** | -+------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_ios_project_static_lib` **(** :ref:`String` path **)** | -+------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_macos_plugin_file` **(** :ref:`String` path **)** | -+------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_shared_object` **(** :ref:`String` path, :ref:`PackedStringArray` tags, :ref:`String` target **)** | -+------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`skip` **(** **)** | -+------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`_begin_customize_resources` **(** :ref:`EditorExportPlatform` platform, :ref:`PackedStringArray` features **)** |virtual| |const| | ++---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`_begin_customize_scenes` **(** :ref:`EditorExportPlatform` platform, :ref:`PackedStringArray` features **)** |virtual| |const| | ++---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Resource` | :ref:`_customize_resource` **(** :ref:`Resource` resource, :ref:`String` path **)** |virtual| | ++---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`_customize_scene` **(** :ref:`Node` scene, :ref:`String` path **)** |virtual| | ++---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_end_customize_resources` **(** **)** |virtual| | ++---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_end_customize_scenes` **(** **)** |virtual| | ++---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_export_begin` **(** :ref:`PackedStringArray` features, :ref:`bool` is_debug, :ref:`String` path, :ref:`int` flags **)** |virtual| | ++---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_export_end` **(** **)** |virtual| | ++---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_export_file` **(** :ref:`String` path, :ref:`String` type, :ref:`PackedStringArray` features **)** |virtual| | ++---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_customization_configuration_hash` **(** **)** |virtual| |const| | ++---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_get_name` **(** **)** |virtual| |const| | ++---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_file` **(** :ref:`String` path, :ref:`PackedByteArray` file, :ref:`bool` remap **)** | ++---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_ios_bundle_file` **(** :ref:`String` path **)** | ++---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_ios_cpp_code` **(** :ref:`String` code **)** | ++---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_ios_embedded_framework` **(** :ref:`String` path **)** | ++---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_ios_framework` **(** :ref:`String` path **)** | ++---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_ios_linker_flags` **(** :ref:`String` flags **)** | ++---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_ios_plist_content` **(** :ref:`String` plist_content **)** | ++---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_ios_project_static_lib` **(** :ref:`String` path **)** | ++---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_macos_plugin_file` **(** :ref:`String` path **)** | ++---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_shared_object` **(** :ref:`String` path, :ref:`PackedStringArray` tags, :ref:`String` target **)** | ++---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`skip` **(** **)** | ++---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- +.. _class_EditorExportPlugin_method__begin_customize_resources: + +- :ref:`bool` **_begin_customize_resources** **(** :ref:`EditorExportPlatform` platform, :ref:`PackedStringArray` features **)** |virtual| |const| + +Return true if this plugin will customize resources based on the platform and features used. + +---- + +.. _class_EditorExportPlugin_method__begin_customize_scenes: + +- :ref:`bool` **_begin_customize_scenes** **(** :ref:`EditorExportPlatform` platform, :ref:`PackedStringArray` features **)** |virtual| |const| + +Return true if this plugin will customize scenes based on the platform and features used. + +---- + +.. _class_EditorExportPlugin_method__customize_resource: + +- :ref:`Resource` **_customize_resource** **(** :ref:`Resource` resource, :ref:`String` path **)** |virtual| + +Customize a resource. If changes are made to it, return the same or a new resource. Otherwise, return ``null``. + +The *path* argument is only used when customizing an actual file, otherwise this means that this resource is part of another one and it will be empty. + +---- + +.. _class_EditorExportPlugin_method__customize_scene: + +- :ref:`Node` **_customize_scene** **(** :ref:`Node` scene, :ref:`String` path **)** |virtual| + +Customize a scene. If changes are made to it, return the same or a new scene. Otherwise, return ``null``. If a new scene is returned, it is up to you to dispose of the old one. + +---- + +.. _class_EditorExportPlugin_method__end_customize_resources: + +- void **_end_customize_resources** **(** **)** |virtual| + +This is called when the customization process for resources ends. + +---- + +.. _class_EditorExportPlugin_method__end_customize_scenes: + +- void **_end_customize_scenes** **(** **)** |virtual| + +This is called when the customization process for scenes ends. + +---- + .. _class_EditorExportPlugin_method__export_begin: - void **_export_begin** **(** :ref:`PackedStringArray` features, :ref:`bool` is_debug, :ref:`String` path, :ref:`int` flags **)** |virtual| @@ -83,6 +149,22 @@ Calling :ref:`skip` inside this callback w ---- +.. _class_EditorExportPlugin_method__get_customization_configuration_hash: + +- :ref:`int` **_get_customization_configuration_hash** **(** **)** |virtual| |const| + +Return a hash based on the configuration passed (for both scenes and resources). This helps keep separate caches for separate export configurations. + +---- + +.. _class_EditorExportPlugin_method__get_name: + +- :ref:`String` **_get_name** **(** **)** |virtual| |const| + +Return the name identifier of this plugin (for future identification by the exporter). + +---- + .. _class_EditorExportPlugin_method_add_file: - void **add_file** **(** :ref:`String` path, :ref:`PackedByteArray` file, :ref:`bool` remap **)** diff --git a/classes/class_editorimportplugin.rst b/classes/class_editorimportplugin.rst index d204bf1f1..fb6518a3c 100644 --- a/classes/class_editorimportplugin.rst +++ b/classes/class_editorimportplugin.rst @@ -139,31 +139,31 @@ Tutorials Methods ------- -+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary[]` | :ref:`_get_import_options` **(** :ref:`String` path, :ref:`int` preset_index **)** |virtual| |const| | -+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_import_order` **(** **)** |virtual| |const| | -+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_importer_name` **(** **)** |virtual| |const| | -+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`_get_option_visibility` **(** :ref:`String` path, :ref:`StringName` option_name, :ref:`Dictionary` options **)** |virtual| |const| | -+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_preset_count` **(** **)** |virtual| |const| | -+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_preset_name` **(** :ref:`int` preset_index **)** |virtual| |const| | -+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`_get_priority` **(** **)** |virtual| |const| | -+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedStringArray` | :ref:`_get_recognized_extensions` **(** **)** |virtual| |const| | -+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_resource_type` **(** **)** |virtual| |const| | -+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_save_extension` **(** **)** |virtual| |const| | -+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_visible_name` **(** **)** |virtual| |const| | -+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_import` **(** :ref:`String` source_file, :ref:`String` save_path, :ref:`Dictionary` options, :ref:`Array` platform_variants, :ref:`Array` gen_files **)** |virtual| |const| | -+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary[]` | :ref:`_get_import_options` **(** :ref:`String` path, :ref:`int` preset_index **)** |virtual| |const| | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_import_order` **(** **)** |virtual| |const| | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_get_importer_name` **(** **)** |virtual| |const| | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`_get_option_visibility` **(** :ref:`String` path, :ref:`StringName` option_name, :ref:`Dictionary` options **)** |virtual| |const| | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_preset_count` **(** **)** |virtual| |const| | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_get_preset_name` **(** :ref:`int` preset_index **)** |virtual| |const| | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`_get_priority` **(** **)** |virtual| |const| | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`_get_recognized_extensions` **(** **)** |virtual| |const| | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_get_resource_type` **(** **)** |virtual| |const| | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_get_save_extension` **(** **)** |virtual| |const| | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_get_visible_name` **(** **)** |virtual| |const| | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_import` **(** :ref:`String` source_file, :ref:`String` save_path, :ref:`Dictionary` options, :ref:`String[]` platform_variants, :ref:`String[]` gen_files **)** |virtual| |const| | ++---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- @@ -287,7 +287,7 @@ Gets the name to display in the import window. You should choose this name as a .. _class_EditorImportPlugin_method__import: -- :ref:`int` **_import** **(** :ref:`String` source_file, :ref:`String` save_path, :ref:`Dictionary` options, :ref:`Array` platform_variants, :ref:`Array` gen_files **)** |virtual| |const| +- :ref:`int` **_import** **(** :ref:`String` source_file, :ref:`String` save_path, :ref:`Dictionary` options, :ref:`String[]` platform_variants, :ref:`String[]` gen_files **)** |virtual| |const| Imports ``source_file`` into ``save_path`` with the import ``options`` specified. The ``platform_variants`` and ``gen_files`` arrays will be modified by this function. diff --git a/classes/class_editorinterface.rst b/classes/class_editorinterface.rst index 9847f6917..844168602 100644 --- a/classes/class_editorinterface.rst +++ b/classes/class_editorinterface.rst @@ -46,7 +46,7 @@ Methods +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Node` | :ref:`get_edited_scene_root` **(** **)** | +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Control` | :ref:`get_editor_main_control` **(** **)** | +| :ref:`VBoxContainer` | :ref:`get_editor_main_screen` **(** **)** | +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`EditorPaths` | :ref:`get_editor_paths` **(** **)** | +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -78,7 +78,7 @@ Methods +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_plugin_enabled` **(** :ref:`String` plugin **)** |const| | +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture2D[]` | :ref:`make_mesh_previews` **(** :ref:`Array` meshes, :ref:`int` preview_size **)** | +| :ref:`Texture2D[]` | :ref:`make_mesh_previews` **(** :ref:`Mesh[]` meshes, :ref:`int` preview_size **)** | +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`open_scene_from_path` **(** :ref:`String` scene_filepath **)** | +-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -183,13 +183,11 @@ Returns the edited (current) scene's root :ref:`Node`. ---- -.. _class_EditorInterface_method_get_editor_main_control: +.. _class_EditorInterface_method_get_editor_main_screen: -- :ref:`Control` **get_editor_main_control** **(** **)** +- :ref:`VBoxContainer` **get_editor_main_screen** **(** **)** -Returns the main editor control. Use this as a parent for main screens. - -\ **Note:** This returns the main editor control containing the whole editor, not the 2D or 3D viewports specifically. +Returns the editor control responsible for main screen plugins and tools. Use it with plugins that implement :ref:`EditorPlugin._has_main_screen`. \ **Warning:** Removing and freeing this node will render a part of the editor useless and may cause a crash. @@ -323,7 +321,7 @@ Returns ``true`` if the specified ``plugin`` is enabled. The plugin name is the .. _class_EditorInterface_method_make_mesh_previews: -- :ref:`Texture2D[]` **make_mesh_previews** **(** :ref:`Array` meshes, :ref:`int` preview_size **)** +- :ref:`Texture2D[]` **make_mesh_previews** **(** :ref:`Mesh[]` meshes, :ref:`int` preview_size **)** Returns mesh previews rendered at the given size as an :ref:`Array` of :ref:`Texture2D`\ s. diff --git a/classes/class_editorplugin.rst b/classes/class_editorplugin.rst index 4a1d739f5..23186ddc3 100644 --- a/classes/class_editorplugin.rst +++ b/classes/class_editorplugin.rst @@ -668,7 +668,7 @@ Use :ref:`_get_plugin_name` and :ref func _enter_tree(): plugin_control = preload("my_plugin_control.tscn").instantiate() - get_editor_interface().get_editor_main_control().add_child(plugin_control) + get_editor_interface().get_editor_main_screen().add_child(plugin_control) plugin_control.hide() func _has_main_screen(): @@ -785,6 +785,8 @@ You can use the virtual method :ref:`_handles` | :ref:`network/http_proxy/port` | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`network/ssl/editor_ssl_certificates` | +| :ref:`String` | :ref:`network/tls/editor_tls_certificates` | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`project_manager/sorting_order` | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -334,7 +334,7 @@ Properties +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`text_editor/appearance/caret/caret_blink` | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`text_editor/appearance/caret/caret_blink_speed` | +| :ref:`float` | :ref:`text_editor/appearance/caret/caret_blink_interval` | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`text_editor/appearance/caret/highlight_all_occurrences` | +-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -527,7 +527,7 @@ Methods +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`mark_setting_changed` **(** :ref:`String` setting **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_builtin_action_override` **(** :ref:`String` name, :ref:`Array` actions_list **)** | +| void | :ref:`set_builtin_action_override` **(** :ref:`String` name, :ref:`InputEvent[]` actions_list **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_favorites` **(** :ref:`PackedStringArray` dirs **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -1687,11 +1687,11 @@ The port number to use to contact the HTTP and HTTPS proxy in the editor (for th ---- -.. _class_EditorSettings_property_network/ssl/editor_ssl_certificates: +.. _class_EditorSettings_property_network/tls/editor_tls_certificates: -- :ref:`String` **network/ssl/editor_ssl_certificates** +- :ref:`String` **network/tls/editor_tls_certificates** -The SSL certificate bundle to use for HTTP requests made within the editor (e.g. from the AssetLib tab). If left empty, the `included Mozilla certificate bundle `__ will be used. +The TLS certificate bundle to use for HTTP requests made within the editor (e.g. from the AssetLib tab). If left empty, the `included Mozilla certificate bundle `__ will be used. ---- @@ -1771,13 +1771,13 @@ The monitor to display the project on when starting the project from the editor. - :ref:`bool` **text_editor/appearance/caret/caret_blink** -If ``true``, makes the caret blink according to :ref:`text_editor/appearance/caret/caret_blink_speed`. Disabling this setting can improve battery life on laptops if you spend long amounts of time in the script editor, since it will reduce the frequency at which the editor needs to be redrawn. +If ``true``, makes the caret blink according to :ref:`text_editor/appearance/caret/caret_blink_interval`. Disabling this setting can improve battery life on laptops if you spend long amounts of time in the script editor, since it will reduce the frequency at which the editor needs to be redrawn. ---- -.. _class_EditorSettings_property_text_editor/appearance/caret/caret_blink_speed: +.. _class_EditorSettings_property_text_editor/appearance/caret/caret_blink_interval: -- :ref:`float` **text_editor/appearance/caret/caret_blink_speed** +- :ref:`float` **text_editor/appearance/caret/caret_blink_interval** The interval at which to blink the caret (in seconds). See also :ref:`text_editor/appearance/caret/caret_blink`. @@ -2594,7 +2594,7 @@ Marks the passed editor setting as being changed, see :ref:`get_changed_settings .. _class_EditorSettings_method_set_builtin_action_override: -- void **set_builtin_action_override** **(** :ref:`String` name, :ref:`Array` actions_list **)** +- void **set_builtin_action_override** **(** :ref:`String` name, :ref:`InputEvent[]` actions_list **)** Overrides the built-in editor action ``name`` with the input actions defined in ``actions_list``. diff --git a/classes/class_editortranslationparserplugin.rst b/classes/class_editortranslationparserplugin.rst index 2d5398a2d..6592e80c5 100644 --- a/classes/class_editortranslationparserplugin.rst +++ b/classes/class_editortranslationparserplugin.rst @@ -139,11 +139,11 @@ To use ``EditorTranslationParserPlugin``, register it using the :ref:`EditorPlug Methods ------- -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedStringArray` | :ref:`_get_recognized_extensions` **(** **)** |virtual| |const| | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_parse_file` **(** :ref:`String` path, :ref:`Array` msgids, :ref:`Array` msgids_context_plural **)** |virtual| | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`_get_recognized_extensions` **(** **)** |virtual| |const| | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_parse_file` **(** :ref:`String` path, :ref:`String[]` msgids, :ref:`Array[]` msgids_context_plural **)** |virtual| | ++---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- @@ -158,7 +158,7 @@ Gets the list of file extensions to associate with this parser, e.g. ``["csv"]`` .. _class_EditorTranslationParserPlugin_method__parse_file: -- void **_parse_file** **(** :ref:`String` path, :ref:`Array` msgids, :ref:`Array` msgids_context_plural **)** |virtual| +- void **_parse_file** **(** :ref:`String` path, :ref:`String[]` msgids, :ref:`Array[]` msgids_context_plural **)** |virtual| Override this method to define a custom parsing logic to extract the translatable strings. diff --git a/classes/class_editorvcsinterface.rst b/classes/class_editorvcsinterface.rst index 640d010dc..49395ce91 100644 --- a/classes/class_editorvcsinterface.rst +++ b/classes/class_editorvcsinterface.rst @@ -35,19 +35,19 @@ Methods +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_fetch` **(** :ref:`String` remote **)** |virtual| | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`_get_branch_list` **(** **)** |virtual| | +| :ref:`Dictionary[]` | :ref:`_get_branch_list` **(** **)** |virtual| | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`_get_current_branch_name` **(** **)** |virtual| | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary[]` | :ref:`_get_diff` **(** :ref:`String` identifier, :ref:`int` area **)** |virtual| | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`_get_line_diff` **(** :ref:`String` file_path, :ref:`String` text **)** |virtual| | +| :ref:`Dictionary[]` | :ref:`_get_line_diff` **(** :ref:`String` file_path, :ref:`String` text **)** |virtual| | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`_get_modified_files_data` **(** **)** |virtual| | +| :ref:`Dictionary[]` | :ref:`_get_modified_files_data` **(** **)** |virtual| | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`_get_previous_commits` **(** :ref:`int` max_commits **)** |virtual| | +| :ref:`Dictionary[]` | :ref:`_get_previous_commits` **(** :ref:`int` max_commits **)** |virtual| | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`_get_remotes` **(** **)** |virtual| | +| :ref:`Dictionary[]` | :ref:`_get_remotes` **(** **)** |virtual| | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`_get_vcs_name` **(** **)** |virtual| | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -69,9 +69,9 @@ Methods +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_unstage_file` **(** :ref:`String` file_path **)** |virtual| | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`add_diff_hunks_into_diff_file` **(** :ref:`Dictionary` diff_file, :ref:`Array` diff_hunks **)** | +| :ref:`Dictionary` | :ref:`add_diff_hunks_into_diff_file` **(** :ref:`Dictionary` diff_file, :ref:`Dictionary[]` diff_hunks **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`add_line_diffs_into_diff_hunk` **(** :ref:`Dictionary` diff_hunk, :ref:`Array` line_diffs **)** | +| :ref:`Dictionary` | :ref:`add_line_diffs_into_diff_hunk` **(** :ref:`Dictionary` diff_hunk, :ref:`Dictionary[]` line_diffs **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`create_commit` **(** :ref:`String` msg, :ref:`String` author, :ref:`String` id, :ref:`int` unix_timestamp, :ref:`int` offset_minutes **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -188,7 +188,7 @@ Fetches new changes from the remote, but doesn't write changes to the current wo .. _class_EditorVCSInterface_method__get_branch_list: -- :ref:`Array` **_get_branch_list** **(** **)** |virtual| +- :ref:`Dictionary[]` **_get_branch_list** **(** **)** |virtual| Gets an instance of an :ref:`Array` of :ref:`String`\ s containing available branch names in the VCS. @@ -212,7 +212,7 @@ Returns an array of :ref:`Dictionary` items (see :ref:`create_ .. _class_EditorVCSInterface_method__get_line_diff: -- :ref:`Array` **_get_line_diff** **(** :ref:`String` file_path, :ref:`String` text **)** |virtual| +- :ref:`Dictionary[]` **_get_line_diff** **(** :ref:`String` file_path, :ref:`String` text **)** |virtual| Returns an :ref:`Array` of :ref:`Dictionary` items (see :ref:`create_diff_hunk`), each containing a line diff between a file at ``file_path`` and the ``text`` which is passed in. @@ -220,7 +220,7 @@ Returns an :ref:`Array` of :ref:`Dictionary` item .. _class_EditorVCSInterface_method__get_modified_files_data: -- :ref:`Array` **_get_modified_files_data** **(** **)** |virtual| +- :ref:`Dictionary[]` **_get_modified_files_data** **(** **)** |virtual| Returns an :ref:`Array` of :ref:`Dictionary` items (see :ref:`create_status_file`), each containing the status data of every modified file in the project folder. @@ -228,7 +228,7 @@ Returns an :ref:`Array` of :ref:`Dictionary` item .. _class_EditorVCSInterface_method__get_previous_commits: -- :ref:`Array` **_get_previous_commits** **(** :ref:`int` max_commits **)** |virtual| +- :ref:`Dictionary[]` **_get_previous_commits** **(** :ref:`int` max_commits **)** |virtual| Returns an :ref:`Array` of :ref:`Dictionary` items (see :ref:`create_commit`), each containing the data for a past commit. @@ -236,7 +236,7 @@ Returns an :ref:`Array` of :ref:`Dictionary` item .. _class_EditorVCSInterface_method__get_remotes: -- :ref:`Array` **_get_remotes** **(** **)** |virtual| +- :ref:`Dictionary[]` **_get_remotes** **(** **)** |virtual| Returns an :ref:`Array` of :ref:`String`\ s, each containing the name of a remote configured in the VCS. @@ -324,7 +324,7 @@ Unstages the file present at ``file_path`` from the staged area to the unstaged .. _class_EditorVCSInterface_method_add_diff_hunks_into_diff_file: -- :ref:`Dictionary` **add_diff_hunks_into_diff_file** **(** :ref:`Dictionary` diff_file, :ref:`Array` diff_hunks **)** +- :ref:`Dictionary` **add_diff_hunks_into_diff_file** **(** :ref:`Dictionary` diff_file, :ref:`Dictionary[]` diff_hunks **)** Helper function to add an array of ``diff_hunks`` into a ``diff_file``. @@ -332,7 +332,7 @@ Helper function to add an array of ``diff_hunks`` into a ``diff_file``. .. _class_EditorVCSInterface_method_add_line_diffs_into_diff_hunk: -- :ref:`Dictionary` **add_line_diffs_into_diff_hunk** **(** :ref:`Dictionary` diff_hunk, :ref:`Array` line_diffs **)** +- :ref:`Dictionary` **add_line_diffs_into_diff_hunk** **(** :ref:`Dictionary` diff_hunk, :ref:`Dictionary[]` line_diffs **)** Helper function to add an array of ``line_diffs`` into a ``diff_hunk``. diff --git a/classes/class_environment.rst b/classes/class_environment.rst index 49ea9e7c9..df37fe849 100644 --- a/classes/class_environment.rst +++ b/classes/class_environment.rst @@ -62,23 +62,15 @@ Properties +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`AmbientSource` | :ref:`ambient_light_source` | ``0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------------+ -| :ref:`bool` | :ref:`auto_exposure_enabled` | ``false`` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------------+ -| :ref:`float` | :ref:`auto_exposure_max_luma` | ``8.0`` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------------+ -| :ref:`float` | :ref:`auto_exposure_min_luma` | ``0.05`` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------------+ -| :ref:`float` | :ref:`auto_exposure_scale` | ``0.4`` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------------+ -| :ref:`float` | :ref:`auto_exposure_speed` | ``0.5`` | -+------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`int` | :ref:`background_camera_feed_id` | ``1`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`int` | :ref:`background_canvas_max_layer` | ``0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`Color` | :ref:`background_color` | ``Color(0, 0, 0, 1)`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------------+ -| :ref:`float` | :ref:`background_energy` | ``1.0`` | +| :ref:`float` | :ref:`background_energy_multiplier` | ``1.0`` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------------+ +| :ref:`float` | :ref:`background_intensity` | ``30000.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`BGMode` | :ref:`background_mode` | ``0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------------+ @@ -96,6 +88,8 @@ Properties +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`float` | :ref:`fog_light_energy` | ``1.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------------+ +| :ref:`float` | :ref:`fog_sky_affect` | ``1.0`` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`float` | :ref:`fog_sun_scatter` | ``0.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`GlowBlendMode` | :ref:`glow_blend_mode` | ``2`` | @@ -232,6 +226,8 @@ Properties +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`float` | :ref:`volumetric_fog_length` | ``64.0`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------------+ +| :ref:`float` | :ref:`volumetric_fog_sky_affect` | ``1.0`` | ++------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`float` | :ref:`volumetric_fog_temporal_reprojection_amount` | ``0.9`` | +------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`bool` | :ref:`volumetric_fog_temporal_reprojection_enabled` | ``true`` | @@ -536,86 +532,6 @@ The ambient light source to use for rendering materials and global illumination. ---- -.. _class_Environment_property_auto_exposure_enabled: - -- :ref:`bool` **auto_exposure_enabled** - -+-----------+------------------------------------------+ -| *Default* | ``false`` | -+-----------+------------------------------------------+ -| *Setter* | set_tonemap_auto_exposure_enabled(value) | -+-----------+------------------------------------------+ -| *Getter* | is_tonemap_auto_exposure_enabled() | -+-----------+------------------------------------------+ - -If ``true``, enables the tonemapping auto exposure mode of the scene renderer. If ``true``, the renderer will automatically determine the exposure setting to adapt to the scene's illumination and the observed light. - ----- - -.. _class_Environment_property_auto_exposure_max_luma: - -- :ref:`float` **auto_exposure_max_luma** - -+-----------+--------------------------------------+ -| *Default* | ``8.0`` | -+-----------+--------------------------------------+ -| *Setter* | set_tonemap_auto_exposure_max(value) | -+-----------+--------------------------------------+ -| *Getter* | get_tonemap_auto_exposure_max() | -+-----------+--------------------------------------+ - -The maximum luminance value for the auto exposure. - ----- - -.. _class_Environment_property_auto_exposure_min_luma: - -- :ref:`float` **auto_exposure_min_luma** - -+-----------+--------------------------------------+ -| *Default* | ``0.05`` | -+-----------+--------------------------------------+ -| *Setter* | set_tonemap_auto_exposure_min(value) | -+-----------+--------------------------------------+ -| *Getter* | get_tonemap_auto_exposure_min() | -+-----------+--------------------------------------+ - -The minimum luminance value for the auto exposure. - ----- - -.. _class_Environment_property_auto_exposure_scale: - -- :ref:`float` **auto_exposure_scale** - -+-----------+---------------------------------------+ -| *Default* | ``0.4`` | -+-----------+---------------------------------------+ -| *Setter* | set_tonemap_auto_exposure_grey(value) | -+-----------+---------------------------------------+ -| *Getter* | get_tonemap_auto_exposure_grey() | -+-----------+---------------------------------------+ - -The scale of the auto exposure effect. Affects the intensity of auto exposure. - ----- - -.. _class_Environment_property_auto_exposure_speed: - -- :ref:`float` **auto_exposure_speed** - -+-----------+----------------------------------------+ -| *Default* | ``0.5`` | -+-----------+----------------------------------------+ -| *Setter* | set_tonemap_auto_exposure_speed(value) | -+-----------+----------------------------------------+ -| *Getter* | get_tonemap_auto_exposure_speed() | -+-----------+----------------------------------------+ - -The speed of the auto exposure effect. Affects the time needed for the camera to perform auto exposure. - ----- - .. _class_Environment_property_background_camera_feed_id: - :ref:`int` **background_camera_feed_id** @@ -664,19 +580,35 @@ The :ref:`Color` displayed for clear areas of the scene. Only effec ---- -.. _class_Environment_property_background_energy: +.. _class_Environment_property_background_energy_multiplier: -- :ref:`float` **background_energy** +- :ref:`float` **background_energy_multiplier** -+-----------+----------------------+ -| *Default* | ``1.0`` | -+-----------+----------------------+ -| *Setter* | set_bg_energy(value) | -+-----------+----------------------+ -| *Getter* | get_bg_energy() | -+-----------+----------------------+ ++-----------+---------------------------------+ +| *Default* | ``1.0`` | ++-----------+---------------------------------+ +| *Setter* | set_bg_energy_multiplier(value) | ++-----------+---------------------------------+ +| *Getter* | get_bg_energy_multiplier() | ++-----------+---------------------------------+ -The power of the light emitted by the background. +Multiplier for background energy. Increase to make background brighter, decrease to make background dimmer. + +---- + +.. _class_Environment_property_background_intensity: + +- :ref:`float` **background_intensity** + ++-----------+-------------------------+ +| *Default* | ``30000.0`` | ++-----------+-------------------------+ +| *Setter* | set_bg_intensity(value) | ++-----------+-------------------------+ +| *Getter* | get_bg_intensity() | ++-----------+-------------------------+ + +Luminance of background measured in nits (candela per square meter). Only used when :ref:`ProjectSettings.rendering/lights_and_shadows/use_physical_light_units` is enabled. The default value is roughly equivalent to the sky at midday. ---- @@ -708,7 +640,7 @@ The background mode. See :ref:`BGMode` for possible val | *Getter* | get_fog_aerial_perspective() | +-----------+-----------------------------------+ -Blend factor between the fog's color and the color of the background :ref:`Sky`. Must have :ref:`background_mode` set to :ref:`BG_SKY`. +If set above ``0.0`` (exclusive), blends between the fog's color and the color of the background :ref:`Sky`. This has a small performance cost when set above ``0.0``. Must have :ref:`background_mode` set to :ref:`BG_SKY`. This is useful to simulate `aerial perspective `__ in large scenes with low density fog. However, it is not very useful for high-density fog, as the sky will shine through. When set to ``1.0``, the fog color comes completely from the :ref:`Sky`. If set to ``0.0``, aerial perspective is disabled. @@ -810,6 +742,24 @@ The fog's brightness. Higher values result in brighter fog. ---- +.. _class_Environment_property_fog_sky_affect: + +- :ref:`float` **fog_sky_affect** + ++-----------+---------------------------+ +| *Default* | ``1.0`` | ++-----------+---------------------------+ +| *Setter* | set_fog_sky_affect(value) | ++-----------+---------------------------+ +| *Getter* | get_fog_sky_affect() | ++-----------+---------------------------+ + +The factor to use when affecting the sky with non-volumetric fog. ``1.0`` means that fog can fully obscure the sky. Lower values reduce the impact of fog on sky rendering, with ``0.0`` not affecting sky rendering at all. + +\ **Note:** :ref:`fog_sky_affect` has no visual effect if :ref:`fog_aerial_perspective` is ``1.0``. + +---- + .. _class_Environment_property_fog_sun_scatter: - :ref:`float` **fog_sun_scatter** @@ -1910,6 +1860,22 @@ The distance over which the volumetric fog is computed. Increase to compute fog ---- +.. _class_Environment_property_volumetric_fog_sky_affect: + +- :ref:`float` **volumetric_fog_sky_affect** + ++-----------+--------------------------------------+ +| *Default* | ``1.0`` | ++-----------+--------------------------------------+ +| *Setter* | set_volumetric_fog_sky_affect(value) | ++-----------+--------------------------------------+ +| *Getter* | get_volumetric_fog_sky_affect() | ++-----------+--------------------------------------+ + +The factor to use when affecting the sky with volumetric fog. ``1.0`` means that volumetric fog can fully obscure the sky. Lower values reduce the impact of volumetric fog on sky rendering, with ``0.0`` not affecting sky rendering at all. + +---- + .. _class_Environment_property_volumetric_fog_temporal_reprojection_amount: - :ref:`float` **volumetric_fog_temporal_reprojection_amount** diff --git a/classes/class_filedialog.rst b/classes/class_filedialog.rst index 3246fd5d4..9cd70504d 100644 --- a/classes/class_filedialog.rst +++ b/classes/class_filedialog.rst @@ -66,27 +66,27 @@ Methods Theme Properties ---------------- -+-----------------------------------+--------------------------------------------------------------------------------+--------------------------+ -| :ref:`Color` | :ref:`file_icon_modulate` | ``Color(1, 1, 1, 1)`` | -+-----------------------------------+--------------------------------------------------------------------------------+--------------------------+ -| :ref:`Color` | :ref:`files_disabled` | ``Color(1, 1, 1, 0.25)`` | -+-----------------------------------+--------------------------------------------------------------------------------+--------------------------+ -| :ref:`Color` | :ref:`folder_icon_modulate` | ``Color(1, 1, 1, 1)`` | -+-----------------------------------+--------------------------------------------------------------------------------+--------------------------+ -| :ref:`Texture2D` | :ref:`back_folder` | | -+-----------------------------------+--------------------------------------------------------------------------------+--------------------------+ -| :ref:`Texture2D` | :ref:`file` | | -+-----------------------------------+--------------------------------------------------------------------------------+--------------------------+ -| :ref:`Texture2D` | :ref:`folder` | | -+-----------------------------------+--------------------------------------------------------------------------------+--------------------------+ -| :ref:`Texture2D` | :ref:`forward_folder` | | -+-----------------------------------+--------------------------------------------------------------------------------+--------------------------+ -| :ref:`Texture2D` | :ref:`parent_folder` | | -+-----------------------------------+--------------------------------------------------------------------------------+--------------------------+ -| :ref:`Texture2D` | :ref:`reload` | | -+-----------------------------------+--------------------------------------------------------------------------------+--------------------------+ -| :ref:`Texture2D` | :ref:`toggle_hidden` | | -+-----------------------------------+--------------------------------------------------------------------------------+--------------------------+ ++-----------------------------------+------------------------------------------------------------------------------+--------------------------+ +| :ref:`Color` | :ref:`file_disabled_color` | ``Color(1, 1, 1, 0.25)`` | ++-----------------------------------+------------------------------------------------------------------------------+--------------------------+ +| :ref:`Color` | :ref:`file_icon_color` | ``Color(1, 1, 1, 1)`` | ++-----------------------------------+------------------------------------------------------------------------------+--------------------------+ +| :ref:`Color` | :ref:`folder_icon_color` | ``Color(1, 1, 1, 1)`` | ++-----------------------------------+------------------------------------------------------------------------------+--------------------------+ +| :ref:`Texture2D` | :ref:`back_folder` | | ++-----------------------------------+------------------------------------------------------------------------------+--------------------------+ +| :ref:`Texture2D` | :ref:`file` | | ++-----------------------------------+------------------------------------------------------------------------------+--------------------------+ +| :ref:`Texture2D` | :ref:`folder` | | ++-----------------------------------+------------------------------------------------------------------------------+--------------------------+ +| :ref:`Texture2D` | :ref:`forward_folder` | | ++-----------------------------------+------------------------------------------------------------------------------+--------------------------+ +| :ref:`Texture2D` | :ref:`parent_folder` | | ++-----------------------------------+------------------------------------------------------------------------------+--------------------------+ +| :ref:`Texture2D` | :ref:`reload` | | ++-----------------------------------+------------------------------------------------------------------------------+--------------------------+ +| :ref:`Texture2D` | :ref:`toggle_hidden` | | ++-----------------------------------+------------------------------------------------------------------------------+--------------------------+ Signals ------- @@ -359,21 +359,9 @@ Invalidate and update the current dialog content list. Theme Property Descriptions --------------------------- -.. _class_FileDialog_theme_color_file_icon_modulate: +.. _class_FileDialog_theme_color_file_disabled_color: -- :ref:`Color` **file_icon_modulate** - -+-----------+-----------------------+ -| *Default* | ``Color(1, 1, 1, 1)`` | -+-----------+-----------------------+ - -The color modulation applied to the file icon. - ----- - -.. _class_FileDialog_theme_color_files_disabled: - -- :ref:`Color` **files_disabled** +- :ref:`Color` **file_disabled_color** +-----------+--------------------------+ | *Default* | ``Color(1, 1, 1, 0.25)`` | @@ -383,9 +371,21 @@ The color tint for disabled files (when the ``FileDialog`` is used in open folde ---- -.. _class_FileDialog_theme_color_folder_icon_modulate: +.. _class_FileDialog_theme_color_file_icon_color: -- :ref:`Color` **folder_icon_modulate** +- :ref:`Color` **file_icon_color** + ++-----------+-----------------------+ +| *Default* | ``Color(1, 1, 1, 1)`` | ++-----------+-----------------------+ + +The color modulation applied to the file icon. + +---- + +.. _class_FileDialog_theme_color_folder_icon_color: + +- :ref:`Color` **folder_icon_color** +-----------+-----------------------+ | *Default* | ``Color(1, 1, 1, 1)`` | diff --git a/classes/class_flowcontainer.rst b/classes/class_flowcontainer.rst index b7b61588c..99153a4b8 100644 --- a/classes/class_flowcontainer.rst +++ b/classes/class_flowcontainer.rst @@ -23,6 +23,13 @@ Arranges child :ref:`Control` nodes vertically or horizontally in A line is filled with :ref:`Control` nodes until no more fit on the same line, similar to text in an autowrapped label. +Properties +---------- + ++-------------------------+--------------------------------------------------------+-----------+ +| :ref:`bool` | :ref:`vertical` | ``false`` | ++-------------------------+--------------------------------------------------------+-----------+ + Methods ------- @@ -30,6 +37,34 @@ Methods | :ref:`int` | :ref:`get_line_count` **(** **)** |const| | +-----------------------+--------------------------------------------------------------------------------------+ +Theme Properties +---------------- + ++-----------------------+----------------------------------------------------------------------+-------+ +| :ref:`int` | :ref:`h_separation` | ``4`` | ++-----------------------+----------------------------------------------------------------------+-------+ +| :ref:`int` | :ref:`v_separation` | ``4`` | ++-----------------------+----------------------------------------------------------------------+-------+ + +Property Descriptions +--------------------- + +.. _class_FlowContainer_property_vertical: + +- :ref:`bool` **vertical** + ++-----------+---------------------+ +| *Default* | ``false`` | ++-----------+---------------------+ +| *Setter* | set_vertical(value) | ++-----------+---------------------+ +| *Getter* | is_vertical() | ++-----------+---------------------+ + +If ``true``, the ``FlowContainer`` will arrange its children vertically, rather than horizontally. + +Can't be changed when using :ref:`HFlowContainer` and :ref:`VFlowContainer`. + Method Descriptions ------------------- @@ -39,6 +74,31 @@ Method Descriptions Returns the current line count. +Theme Property Descriptions +--------------------------- + +.. _class_FlowContainer_theme_constant_h_separation: + +- :ref:`int` **h_separation** + ++-----------+-------+ +| *Default* | ``4`` | ++-----------+-------+ + +The horizontal separation of children nodes. + +---- + +.. _class_FlowContainer_theme_constant_v_separation: + +- :ref:`int` **v_separation** + ++-----------+-------+ +| *Default* | ``4`` | ++-----------+-------+ + +The vertical separation of children nodes. + .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_geometryinstance3d.rst b/classes/class_geometryinstance3d.rst index b05b6bff6..b424446a0 100644 --- a/classes/class_geometryinstance3d.rst +++ b/classes/class_geometryinstance3d.rst @@ -57,13 +57,13 @@ Properties Methods ------- -+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_instance_shader_uniform` **(** :ref:`StringName` uniform **)** |const| | -+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_custom_aabb` **(** :ref:`AABB` aabb **)** | -+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_instance_shader_uniform` **(** :ref:`StringName` uniform, :ref:`Variant` value **)** | -+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_instance_shader_parameter` **(** :ref:`StringName` name **)** |const| | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_custom_aabb` **(** :ref:`AABB` aabb **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_instance_shader_parameter` **(** :ref:`StringName` name, :ref:`Variant` value **)** | ++-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ @@ -366,9 +366,9 @@ Controls which instances will be faded when approaching the limits of the visibi Method Descriptions ------------------- -.. _class_GeometryInstance3D_method_get_instance_shader_uniform: +.. _class_GeometryInstance3D_method_get_instance_shader_parameter: -- :ref:`Variant` **get_instance_shader_uniform** **(** :ref:`StringName` uniform **)** |const| +- :ref:`Variant` **get_instance_shader_parameter** **(** :ref:`StringName` name **)** |const| ---- @@ -380,9 +380,9 @@ Overrides the bounding box of this node with a custom one. To remove it, set an ---- -.. _class_GeometryInstance3D_method_set_instance_shader_uniform: +.. _class_GeometryInstance3D_method_set_instance_shader_parameter: -- void **set_instance_shader_uniform** **(** :ref:`StringName` uniform, :ref:`Variant` value **)** +- void **set_instance_shader_parameter** **(** :ref:`StringName` name, :ref:`Variant` value **)** .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_gltfmesh.rst b/classes/class_gltfmesh.rst index 62c30f865..660b093dc 100644 --- a/classes/class_gltfmesh.rst +++ b/classes/class_gltfmesh.rst @@ -20,7 +20,7 @@ Properties +-----------------------------------------------------+-----------------------------------------------------------------------+--------------------------+ | :ref:`PackedFloat32Array` | :ref:`blend_weights` | ``PackedFloat32Array()`` | +-----------------------------------------------------+-----------------------------------------------------------------------+--------------------------+ -| :ref:`Array` | :ref:`instance_materials` | ``[]`` | +| :ref:`Material[]` | :ref:`instance_materials` | ``[]`` | +-----------------------------------------------------+-----------------------------------------------------------------------+--------------------------+ | :ref:`ImporterMesh` | :ref:`mesh` | | +-----------------------------------------------------+-----------------------------------------------------------------------+--------------------------+ @@ -44,7 +44,7 @@ Property Descriptions .. _class_GLTFMesh_property_instance_materials: -- :ref:`Array` **instance_materials** +- :ref:`Material[]` **instance_materials** +-----------+-------------------------------+ | *Default* | ``[]`` | diff --git a/classes/class_graphnode.rst b/classes/class_graphnode.rst index 53d8f2b0f..665c803d2 100644 --- a/classes/class_graphnode.rst +++ b/classes/class_graphnode.rst @@ -167,6 +167,14 @@ Emitted when the GraphNode is requested to be closed. Happens on clicking the cl ---- +.. _class_GraphNode_signal_deselected: + +- **deselected** **(** **)** + +Emitted when the GraphNode is deselected. + +---- + .. _class_GraphNode_signal_dragged: - **dragged** **(** :ref:`Vector2` from, :ref:`Vector2` to **)** @@ -199,6 +207,14 @@ Emitted when the GraphNode is requested to be resized. Happens on dragging the r ---- +.. _class_GraphNode_signal_selected: + +- **selected** **(** **)** + +Emitted when the GraphNode is selected. + +---- + .. _class_GraphNode_signal_slot_updated: - **slot_updated** **(** :ref:`int` idx **)** diff --git a/classes/class_gridmap.rst b/classes/class_gridmap.rst index 86b8e46be..6f0755c86 100644 --- a/classes/class_gridmap.rst +++ b/classes/class_gridmap.rst @@ -93,15 +93,19 @@ Methods +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_navigation_layer_value` **(** :ref:`int` layer_number **)** |const| | +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_navigation_map` **(** **)** |const| | ++-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_orthogonal_index_from_basis` **(** :ref:`Basis` basis **)** |const| | +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3i[]` | :ref:`get_used_cells` **(** **)** |const| | +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector3i[]` | :ref:`get_used_cells_by_item` **(** :ref:`int` item **)** |const| | +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3i` | :ref:`local_to_map` **(** :ref:`Vector3` local_position **)** |const| | ++-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`make_baked_meshes` **(** :ref:`bool` gen_lightmap_uv=false, :ref:`float` lightmap_uv_texel_size=0.1 **)** | +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`map_to_world` **(** :ref:`Vector3i` map_position **)** |const| | +| :ref:`Vector3` | :ref:`map_to_local` **(** :ref:`Vector3i` map_position **)** |const| | +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`resource_changed` **(** :ref:`Resource` resource **)** | +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -113,7 +117,7 @@ Methods +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_navigation_layer_value` **(** :ref:`int` layer_number, :ref:`bool` value **)** | +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3i` | :ref:`world_to_map` **(** :ref:`Vector3` world_position **)** |const| | +| void | :ref:`set_navigation_map` **(** :ref:`RID` navigation_map **)** | +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals @@ -410,7 +414,7 @@ Returns whether or not the specified layer of the :ref:`collision_mask` **get_meshes** **(** **)** |const| -Returns an array of :ref:`Transform3D` and :ref:`Mesh` references corresponding to the non-empty cells in the grid. The transforms are specified in world space. +Returns an array of :ref:`Transform3D` and :ref:`Mesh` references corresponding to the non-empty cells in the grid. The transforms are specified in local space. ---- @@ -422,6 +426,16 @@ Returns whether or not the specified layer of the :ref:`navigation_layers` **get_navigation_map** **(** **)** |const| + +Returns the :ref:`RID` of the navigation map this GridMap node uses for its cell baked navigation meshes. + +This function returns always the map set on the GridMap node and not the map on the NavigationServer. If the map is changed directly with the NavigationServer API the GridMap node will not be aware of the map change. + +---- + .. _class_GridMap_method_get_orthogonal_index_from_basis: - :ref:`int` **get_orthogonal_index_from_basis** **(** :ref:`Basis` basis **)** |const| @@ -446,17 +460,25 @@ Returns an array of all cells with the given item index specified in ``item``. ---- +.. _class_GridMap_method_local_to_map: + +- :ref:`Vector3i` **local_to_map** **(** :ref:`Vector3` local_position **)** |const| + +Returns the map coordinates of the cell containing the given ``local_position``. If ``local_position`` is in global coordinates, consider using :ref:`Node3D.to_local` before passing it to this method. See also :ref:`map_to_local`. + +---- + .. _class_GridMap_method_make_baked_meshes: - void **make_baked_meshes** **(** :ref:`bool` gen_lightmap_uv=false, :ref:`float` lightmap_uv_texel_size=0.1 **)** ---- -.. _class_GridMap_method_map_to_world: +.. _class_GridMap_method_map_to_local: -- :ref:`Vector3` **map_to_world** **(** :ref:`Vector3i` map_position **)** |const| +- :ref:`Vector3` **map_to_local** **(** :ref:`Vector3i` map_position **)** |const| -Returns the position of a grid cell in the GridMap's local coordinate space. +Returns the position of a grid cell in the GridMap's local coordinate space. To convert the returned value into global coordinates, use :ref:`Node3D.to_global`. See also :ref:`map_to_local`. ---- @@ -502,13 +524,11 @@ Based on ``value``, enables or disables the specified layer in the :ref:`navigat ---- -.. _class_GridMap_method_world_to_map: +.. _class_GridMap_method_set_navigation_map: -- :ref:`Vector3i` **world_to_map** **(** :ref:`Vector3` world_position **)** |const| +- void **set_navigation_map** **(** :ref:`RID` navigation_map **)** -Returns the coordinates of the grid cell containing the given point. - -\ ``pos`` should be in the GridMap's local coordinate space. +Sets the :ref:`RID` of the navigation map this GridMap node should use for its cell baked navigation meshes. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_hsplitcontainer.rst b/classes/class_hsplitcontainer.rst index d188bbb64..7173ab372 100644 --- a/classes/class_hsplitcontainer.rst +++ b/classes/class_hsplitcontainer.rst @@ -27,13 +27,15 @@ Tutorials Theme Properties ---------------- -+-----------------------------------+--------------------------------------------------------------------+--------+ -| :ref:`int` | :ref:`autohide` | ``1`` | -+-----------------------------------+--------------------------------------------------------------------+--------+ -| :ref:`int` | :ref:`separation` | ``12`` | -+-----------------------------------+--------------------------------------------------------------------+--------+ -| :ref:`Texture2D` | :ref:`grabber` | | -+-----------------------------------+--------------------------------------------------------------------+--------+ ++-----------------------------------+--------------------------------------------------------------------------------------------+--------+ +| :ref:`int` | :ref:`autohide` | ``1`` | ++-----------------------------------+--------------------------------------------------------------------------------------------+--------+ +| :ref:`int` | :ref:`minimum_grab_thickness` | ``6`` | ++-----------------------------------+--------------------------------------------------------------------------------------------+--------+ +| :ref:`int` | :ref:`separation` | ``12`` | ++-----------------------------------+--------------------------------------------------------------------------------------------+--------+ +| :ref:`Texture2D` | :ref:`grabber` | | ++-----------------------------------+--------------------------------------------------------------------------------------------+--------+ Theme Property Descriptions --------------------------- @@ -50,6 +52,18 @@ Boolean value. If 1 (``true``), the grabber will hide automatically when it isn' ---- +.. _class_HSplitContainer_theme_constant_minimum_grab_thickness: + +- :ref:`int` **minimum_grab_thickness** + ++-----------+-------+ +| *Default* | ``6`` | ++-----------+-------+ + +The minimum thickness of the area users can click on to grab the splitting line. If :ref:`separation` or :ref:`grabber`'s thickness are too small, this ensure that the splitting line can still be dragged. + +---- + .. _class_HSplitContainer_theme_constant_separation: - :ref:`int` **separation** diff --git a/classes/class_httpclient.rst b/classes/class_httpclient.rst index 5380d2424..bb012b3b6 100644 --- a/classes/class_httpclient.rst +++ b/classes/class_httpclient.rst @@ -23,26 +23,26 @@ See the :ref:`HTTPRequest` node for a higher-level alternativ \ **Note:** This client only needs to connect to a host once (see :ref:`connect_to_host`) to send multiple requests. Because of this, methods that take URLs usually take just the part after the host instead of the full URL, as the client is already connected to a host. See :ref:`request` for a full example and to get started. -A ``HTTPClient`` should be reused between multiple requests or to connect to different hosts instead of creating one client per request. Supports SSL and SSL server certificate verification. HTTP status codes in the 2xx range indicate success, 3xx redirection (i.e. "try again, but over here"), 4xx something was wrong with the request, and 5xx something went wrong on the server's side. +A ``HTTPClient`` should be reused between multiple requests or to connect to different hosts instead of creating one client per request. Supports Transport Layer Security (TLS), including server certificate verification. HTTP status codes in the 2xx range indicate success, 3xx redirection (i.e. "try again, but over here"), 4xx something was wrong with the request, and 5xx something went wrong on the server's side. For more information on HTTP, see https://developer.mozilla.org/en-US/docs/Web/HTTP (or read RFC 2616 to get it straight from the source: https://tools.ietf.org/html/rfc2616). \ **Note:** When exporting to Android, make sure to enable the ``INTERNET`` permission in the Android export preset before exporting the project or using one-click deploy. Otherwise, network communication of any kind will be blocked by Android. -\ **Note:** It's recommended to use transport encryption (SSL/TLS) and to avoid sending sensitive information (such as login credentials) in HTTP GET URL parameters. Consider using HTTP POST requests or HTTP headers for such information instead. +\ **Note:** It's recommended to use transport encryption (TLS) and to avoid sending sensitive information (such as login credentials) in HTTP GET URL parameters. Consider using HTTP POST requests or HTTP headers for such information instead. \ **Note:** When performing HTTP requests from a project exported to Web, keep in mind the remote server may not allow requests from foreign origins due to `CORS `__. If you host the server in question, you should modify its backend to allow requests from foreign origins by adding the ``Access-Control-Allow-Origin: *`` HTTP header. -\ **Note:** SSL/TLS support is currently limited to TLS 1.0, TLS 1.1, and TLS 1.2. Attempting to connect to a TLS 1.3-only server will return an error. +\ **Note:** TLS support is currently limited to TLS 1.0, TLS 1.1, and TLS 1.2. Attempting to connect to a TLS 1.3-only server will return an error. -\ **Warning:** SSL/TLS certificate revocation and certificate pinning are currently not supported. Revoked certificates are accepted as long as they are otherwise valid. If this is a concern, you may want to use automatically managed certificates with a short validity period. +\ **Warning:** TLS certificate revocation and certificate pinning are currently not supported. Revoked certificates are accepted as long as they are otherwise valid. If this is a concern, you may want to use automatically managed certificates with a short validity period. Tutorials --------- - :doc:`HTTP client class <../tutorials/networking/http_client_class>` -- :doc:`SSL certificates <../tutorials/networking/ssl_certificates>` +- :doc:`TLS certificates <../tutorials/networking/ssl_certificates>` Properties ---------- @@ -61,7 +61,7 @@ Methods +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`close` **(** **)** | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`connect_to_host` **(** :ref:`String` host, :ref:`int` port=-1, :ref:`bool` use_ssl=false, :ref:`bool` verify_host=true **)** | +| :ref:`Error` | :ref:`connect_to_host` **(** :ref:`String` host, :ref:`int` port=-1, :ref:`bool` use_tls=false, :ref:`bool` verify_host=true **)** | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_response_body_length` **(** **)** |const| | +---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -161,7 +161,7 @@ enum **Method**: .. _class_HTTPClient_constant_STATUS_CONNECTION_ERROR: -.. _class_HTTPClient_constant_STATUS_SSL_HANDSHAKE_ERROR: +.. _class_HTTPClient_constant_STATUS_TLS_HANDSHAKE_ERROR: enum **Status**: @@ -183,7 +183,7 @@ enum **Status**: - **STATUS_CONNECTION_ERROR** = **8** --- Status: Error in HTTP connection. -- **STATUS_SSL_HANDSHAKE_ERROR** = **9** --- Status: Error in SSL handshake. +- **STATUS_TLS_HANDSHAKE_ERROR** = **9** --- Status: Error in TLS handshake. ---- @@ -495,15 +495,15 @@ Closes the current connection, allowing reuse of this ``HTTPClient``. .. _class_HTTPClient_method_connect_to_host: -- :ref:`Error` **connect_to_host** **(** :ref:`String` host, :ref:`int` port=-1, :ref:`bool` use_ssl=false, :ref:`bool` verify_host=true **)** +- :ref:`Error` **connect_to_host** **(** :ref:`String` host, :ref:`int` port=-1, :ref:`bool` use_tls=false, :ref:`bool` verify_host=true **)** Connects to a host. This needs to be done before any requests are sent. The host should not have http:// prepended but will strip the protocol identifier if provided. -If no ``port`` is specified (or ``-1`` is used), it is automatically set to 80 for HTTP and 443 for HTTPS (if ``use_ssl`` is enabled). +If no ``port`` is specified (or ``-1`` is used), it is automatically set to 80 for HTTP and 443 for HTTPS (if ``use_tls`` is enabled). -``verify_host`` will check the SSL identity of the host if set to ``true``. +``verify_host`` will check the TLS identity of the host if set to ``true``. ---- diff --git a/classes/class_httprequest.rst b/classes/class_httprequest.rst index 142e35b9a..ea542f180 100644 --- a/classes/class_httprequest.rst +++ b/classes/class_httprequest.rst @@ -21,7 +21,7 @@ A node with the ability to send HTTP requests. Uses :ref:`HTTPClient` for limitations, especially regarding SSL security. +\ **Warning:** See the notes and warnings on :ref:`HTTPClient` for limitations, especially regarding TLS security. \ **Note:** When exporting to Android, make sure to enable the ``INTERNET`` permission in the Android export preset before exporting the project or using one-click deploy. Otherwise, network communication of any kind will be blocked by Android. @@ -189,7 +189,7 @@ Tutorials - :doc:`Making HTTP requests <../tutorials/networking/http_request_class>` -- :doc:`SSL certificates <../tutorials/networking/ssl_certificates>` +- :doc:`TLS certificates <../tutorials/networking/ssl_certificates>` Properties ---------- @@ -222,9 +222,9 @@ Methods +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Status` | :ref:`get_http_client_status` **(** **)** |const| | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`request` **(** :ref:`String` url, :ref:`PackedStringArray` custom_headers=PackedStringArray(), :ref:`bool` ssl_validate_domain=true, :ref:`Method` method=0, :ref:`String` request_data="" **)** | +| :ref:`Error` | :ref:`request` **(** :ref:`String` url, :ref:`PackedStringArray` custom_headers=PackedStringArray(), :ref:`bool` tls_validate_domain=true, :ref:`Method` method=0, :ref:`String` request_data="" **)** | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`request_raw` **(** :ref:`String` url, :ref:`PackedStringArray` custom_headers=PackedStringArray(), :ref:`bool` ssl_validate_domain=true, :ref:`Method` method=0, :ref:`PackedByteArray` request_data_raw=PackedByteArray() **)** | +| :ref:`Error` | :ref:`request_raw` **(** :ref:`String` url, :ref:`PackedStringArray` custom_headers=PackedStringArray(), :ref:`bool` tls_validate_domain=true, :ref:`Method` method=0, :ref:`PackedByteArray` request_data_raw=PackedByteArray() **)** | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_http_proxy` **(** :ref:`String` host, :ref:`int` port **)** | +---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -255,7 +255,7 @@ Enumerations .. _class_HTTPRequest_constant_RESULT_CONNECTION_ERROR: -.. _class_HTTPRequest_constant_RESULT_SSL_HANDSHAKE_ERROR: +.. _class_HTTPRequest_constant_RESULT_TLS_HANDSHAKE_ERROR: .. _class_HTTPRequest_constant_RESULT_NO_RESPONSE: @@ -285,7 +285,7 @@ enum **Result**: - **RESULT_CONNECTION_ERROR** = **4** --- Request failed due to connection (read/write) error. -- **RESULT_SSL_HANDSHAKE_ERROR** = **5** --- Request failed on SSL handshake. +- **RESULT_TLS_HANDSHAKE_ERROR** = **5** --- Request failed on TLS handshake. - **RESULT_NO_RESPONSE** = **6** --- Request does not have a response (yet). @@ -463,7 +463,7 @@ Returns the current status of the underlying :ref:`HTTPClient` .. _class_HTTPRequest_method_request: -- :ref:`Error` **request** **(** :ref:`String` url, :ref:`PackedStringArray` custom_headers=PackedStringArray(), :ref:`bool` ssl_validate_domain=true, :ref:`Method` method=0, :ref:`String` request_data="" **)** +- :ref:`Error` **request** **(** :ref:`String` url, :ref:`PackedStringArray` custom_headers=PackedStringArray(), :ref:`bool` tls_validate_domain=true, :ref:`Method` method=0, :ref:`String` request_data="" **)** Creates request on the underlying :ref:`HTTPClient`. If there is no configuration errors, it tries to connect using :ref:`HTTPClient.connect_to_host` and passes parameters onto :ref:`HTTPClient.request`. @@ -471,13 +471,13 @@ Returns :ref:`@GlobalScope.OK` if request is suc \ **Note:** When ``method`` is :ref:`HTTPClient.METHOD_GET`, the payload sent via ``request_data`` might be ignored by the server or even cause the server to reject the request (check `RFC 7231 section 4.3.1 `__ for more details). As a workaround, you can send data as a query string in the URL (see :ref:`String.uri_encode` for an example). -\ **Note:** It's recommended to use transport encryption (SSL/TLS) and to avoid sending sensitive information (such as login credentials) in HTTP GET URL parameters. Consider using HTTP POST requests or HTTP headers for such information instead. +\ **Note:** It's recommended to use transport encryption (TLS) and to avoid sending sensitive information (such as login credentials) in HTTP GET URL parameters. Consider using HTTP POST requests or HTTP headers for such information instead. ---- .. _class_HTTPRequest_method_request_raw: -- :ref:`Error` **request_raw** **(** :ref:`String` url, :ref:`PackedStringArray` custom_headers=PackedStringArray(), :ref:`bool` ssl_validate_domain=true, :ref:`Method` method=0, :ref:`PackedByteArray` request_data_raw=PackedByteArray() **)** +- :ref:`Error` **request_raw** **(** :ref:`String` url, :ref:`PackedStringArray` custom_headers=PackedStringArray(), :ref:`bool` tls_validate_domain=true, :ref:`Method` method=0, :ref:`PackedByteArray` request_data_raw=PackedByteArray() **)** Creates request on the underlying :ref:`HTTPClient` using a raw array of bytes for the request body. If there is no configuration errors, it tries to connect using :ref:`HTTPClient.connect_to_host` and passes parameters onto :ref:`HTTPClient.request`. diff --git a/classes/class_imagetexturelayered.rst b/classes/class_imagetexturelayered.rst index debe31e6d..862100f19 100644 --- a/classes/class_imagetexturelayered.rst +++ b/classes/class_imagetexturelayered.rst @@ -20,7 +20,7 @@ Methods ------- +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`create_from_images` **(** :ref:`Array` images **)** | +| :ref:`Error` | :ref:`create_from_images` **(** :ref:`Image[]` images **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`update_layer` **(** :ref:`Image` image, :ref:`int` layer **)** | +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ @@ -30,7 +30,7 @@ Method Descriptions .. _class_ImageTextureLayered_method_create_from_images: -- :ref:`Error` **create_from_images** **(** :ref:`Array` images **)** +- :ref:`Error` **create_from_images** **(** :ref:`Image[]` images **)** ---- diff --git a/classes/class_importermesh.rst b/classes/class_importermesh.rst index 9b6c718de..0d1773c9a 100644 --- a/classes/class_importermesh.rst +++ b/classes/class_importermesh.rst @@ -33,53 +33,53 @@ Properties Methods ------- -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_blend_shape` **(** :ref:`String` name **)** | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_surface` **(** :ref:`PrimitiveType` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[], :ref:`Dictionary` lods={}, :ref:`Material` material=null, :ref:`String` name="", :ref:`int` flags=0 **)** | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`clear` **(** **)** | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`generate_lods` **(** :ref:`float` normal_merge_angle, :ref:`float` normal_split_angle **)** | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_blend_shape_count` **(** **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`BlendShapeMode` | :ref:`get_blend_shape_mode` **(** **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_blend_shape_name` **(** :ref:`int` blend_shape_idx **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2i` | :ref:`get_lightmap_size_hint` **(** **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`ArrayMesh` | :ref:`get_mesh` **(** :ref:`ArrayMesh` base_mesh=null **)** | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_surface_arrays` **(** :ref:`int` surface_idx **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`get_surface_blend_shape_arrays` **(** :ref:`int` surface_idx, :ref:`int` blend_shape_idx **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_surface_count` **(** **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_surface_format` **(** :ref:`int` surface_idx **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_surface_lod_count` **(** :ref:`int` surface_idx **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedInt32Array` | :ref:`get_surface_lod_indices` **(** :ref:`int` surface_idx, :ref:`int` lod_idx **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_surface_lod_size` **(** :ref:`int` surface_idx, :ref:`int` lod_idx **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Material` | :ref:`get_surface_material` **(** :ref:`int` surface_idx **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_surface_name` **(** :ref:`int` surface_idx **)** |const| | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PrimitiveType` | :ref:`get_surface_primitive_type` **(** :ref:`int` surface_idx **)** | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_blend_shape_mode` **(** :ref:`BlendShapeMode` mode **)** | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_lightmap_size_hint` **(** :ref:`Vector2i` size **)** | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_surface_material` **(** :ref:`int` surface_idx, :ref:`Material` material **)** | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_surface_name` **(** :ref:`int` surface_idx, :ref:`String` name **)** | -+-------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_blend_shape` **(** :ref:`String` name **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`add_surface` **(** :ref:`PrimitiveType` primitive, :ref:`Array` arrays, :ref:`Array[]` blend_shapes=[], :ref:`Dictionary` lods={}, :ref:`Material` material=null, :ref:`String` name="", :ref:`int` flags=0 **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`clear` **(** **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`generate_lods` **(** :ref:`float` normal_merge_angle, :ref:`float` normal_split_angle **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_blend_shape_count` **(** **)** |const| | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`BlendShapeMode` | :ref:`get_blend_shape_mode` **(** **)** |const| | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_blend_shape_name` **(** :ref:`int` blend_shape_idx **)** |const| | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2i` | :ref:`get_lightmap_size_hint` **(** **)** |const| | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ArrayMesh` | :ref:`get_mesh` **(** :ref:`ArrayMesh` base_mesh=null **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_surface_arrays` **(** :ref:`int` surface_idx **)** |const| | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`get_surface_blend_shape_arrays` **(** :ref:`int` surface_idx, :ref:`int` blend_shape_idx **)** |const| | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_surface_count` **(** **)** |const| | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_surface_format` **(** :ref:`int` surface_idx **)** |const| | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_surface_lod_count` **(** :ref:`int` surface_idx **)** |const| | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedInt32Array` | :ref:`get_surface_lod_indices` **(** :ref:`int` surface_idx, :ref:`int` lod_idx **)** |const| | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_surface_lod_size` **(** :ref:`int` surface_idx, :ref:`int` lod_idx **)** |const| | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Material` | :ref:`get_surface_material` **(** :ref:`int` surface_idx **)** |const| | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_surface_name` **(** :ref:`int` surface_idx **)** |const| | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PrimitiveType` | :ref:`get_surface_primitive_type` **(** :ref:`int` surface_idx **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_blend_shape_mode` **(** :ref:`BlendShapeMode` mode **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_lightmap_size_hint` **(** :ref:`Vector2i` size **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_surface_material` **(** :ref:`int` surface_idx, :ref:`Material` material **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_surface_name` **(** :ref:`int` surface_idx, :ref:`String` name **)** | ++-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- @@ -105,7 +105,7 @@ Adds name for a blend shape that will be added with :ref:`add_surface` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[], :ref:`Dictionary` lods={}, :ref:`Material` material=null, :ref:`String` name="", :ref:`int` flags=0 **)** +- void **add_surface** **(** :ref:`PrimitiveType` primitive, :ref:`Array` arrays, :ref:`Array[]` blend_shapes=[], :ref:`Dictionary` lods={}, :ref:`Material` material=null, :ref:`String` name="", :ref:`int` flags=0 **)** Creates a new surface, analogous to :ref:`ArrayMesh.add_surface_from_arrays`. diff --git a/classes/class_inputeventwithmodifiers.rst b/classes/class_inputeventwithmodifiers.rst index f1b9e3790..a3250aafe 100644 --- a/classes/class_inputeventwithmodifiers.rst +++ b/classes/class_inputeventwithmodifiers.rst @@ -29,19 +29,24 @@ Tutorials Properties ---------- -+-------------------------+--------------------------------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`alt_pressed` | ``false`` | -+-------------------------+--------------------------------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`command_pressed` | ``false`` | -+-------------------------+--------------------------------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`ctrl_pressed` | ``false`` | -+-------------------------+--------------------------------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`meta_pressed` | ``false`` | -+-------------------------+--------------------------------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`shift_pressed` | ``false`` | -+-------------------------+--------------------------------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`store_command` | ``true`` | -+-------------------------+--------------------------------------------------------------------------------+-----------+ ++-------------------------+----------------------------------------------------------------------------------------------------------+-----------+ +| :ref:`bool` | :ref:`alt_pressed` | ``false`` | ++-------------------------+----------------------------------------------------------------------------------------------------------+-----------+ +| :ref:`bool` | :ref:`command_or_control_autoremap` | ``false`` | ++-------------------------+----------------------------------------------------------------------------------------------------------+-----------+ +| :ref:`bool` | :ref:`ctrl_pressed` | ``false`` | ++-------------------------+----------------------------------------------------------------------------------------------------------+-----------+ +| :ref:`bool` | :ref:`meta_pressed` | ``false`` | ++-------------------------+----------------------------------------------------------------------------------------------------------+-----------+ +| :ref:`bool` | :ref:`shift_pressed` | ``false`` | ++-------------------------+----------------------------------------------------------------------------------------------------------+-----------+ + +Methods +------- + ++-------------------------+------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_command_or_control_pressed` **(** **)** |const| | ++-------------------------+------------------------------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- @@ -62,21 +67,19 @@ State of the :kbd:`Alt` modifier. ---- -.. _class_InputEventWithModifiers_property_command_pressed: +.. _class_InputEventWithModifiers_property_command_or_control_autoremap: -- :ref:`bool` **command_pressed** +- :ref:`bool` **command_or_control_autoremap** -+-----------+----------------------------+ -| *Default* | ``false`` | -+-----------+----------------------------+ -| *Setter* | set_command_pressed(value) | -+-----------+----------------------------+ -| *Getter* | is_command_pressed() | -+-----------+----------------------------+ ++-----------+-----------------------------------------+ +| *Default* | ``false`` | ++-----------+-----------------------------------------+ +| *Setter* | set_command_or_control_autoremap(value) | ++-----------+-----------------------------------------+ +| *Getter* | is_command_or_control_autoremap() | ++-----------+-----------------------------------------+ -State of the :kbd:`Cmd` modifier. On macOS, this is equivalent to :ref:`meta_pressed`. On other platforms, this is equivalent to :ref:`ctrl_pressed`. - -This modifier should be preferred to :ref:`ctrl_pressed` or :ref:`meta_pressed` for system shortcuts, as it maintains better cross-platform compatibility. +Automaticaly use :kbd:`Meta` (:kbd:`Command`) on macOS and :kbd:`Ctrl` on other platforms. If ``true``, :ref:`ctrl_pressed` and :ref:`meta_pressed` cannot be set. ---- @@ -108,9 +111,7 @@ State of the :kbd:`Ctrl` modifier. | *Getter* | is_meta_pressed() | +-----------+-------------------------+ -State of the :kbd:`Meta` modifier. On Windows and Linux, this represents the Windows key (sometimes called "meta" or "super" on Linux). On macOS, this represents the Command key, and is equivalent to :ref:`command_pressed`. - -For better cross-system compatibility, use :ref:`command_pressed` instead. +State of the :kbd:`Meta` modifier. On Windows and Linux, this represents the Windows key (sometimes called "meta" or "super" on Linux). On macOS, this represents the Command key. ---- @@ -128,23 +129,16 @@ For better cross-system compatibility, use :ref:`command_pressed` **store_command** +- :ref:`bool` **is_command_or_control_pressed** **(** **)** |const| -+-----------+--------------------------+ -| *Default* | ``true`` | -+-----------+--------------------------+ -| *Setter* | set_store_command(value) | -+-----------+--------------------------+ -| *Getter* | is_storing_command() | -+-----------+--------------------------+ +On macOS, returns ``true`` if :kbd:`Meta` (:kbd:`Command`) is pressed. -If ``true``, pressing :kbd:`Cmd` on macOS or :kbd:`Ctrl` on all other platforms will both be serialized as :ref:`command_pressed`. If ``false``, those same keys will be serialized as :ref:`meta_pressed` on macOS and :ref:`ctrl_pressed` on all other platforms. - -This aids with cross-platform compatibility when developing e.g. on Windows for macOS, or vice-versa. +On other platforms, returns ``true`` if :kbd:`Ctrl` is pressed. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_itemlist.rst b/classes/class_itemlist.rst index dd697554d..dd75f90dd 100644 --- a/classes/class_itemlist.rst +++ b/classes/class_itemlist.rst @@ -41,7 +41,7 @@ Properties +---------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`int` | :ref:`fixed_column_width` | ``0`` | +---------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`fixed_icon_size` | ``Vector2(0, 0)`` | +| :ref:`Vector2i` | :ref:`fixed_icon_size` | ``Vector2i(0, 0)`` | +---------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------+ | :ref:`FocusMode` | focus_mode | ``2`` (overrides :ref:`Control`) | +---------------------------------------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------+ @@ -179,14 +179,14 @@ Theme Properties +---------------------------------+----------------------------------------------------------------------------+--------------------------------+ | :ref:`int` | :ref:`font_size` | | +---------------------------------+----------------------------------------------------------------------------+--------------------------------+ -| :ref:`StyleBox` | :ref:`bg` | | -+---------------------------------+----------------------------------------------------------------------------+--------------------------------+ -| :ref:`StyleBox` | :ref:`bg_focus` | | -+---------------------------------+----------------------------------------------------------------------------+--------------------------------+ | :ref:`StyleBox` | :ref:`cursor` | | +---------------------------------+----------------------------------------------------------------------------+--------------------------------+ | :ref:`StyleBox` | :ref:`cursor_unfocused` | | +---------------------------------+----------------------------------------------------------------------------+--------------------------------+ +| :ref:`StyleBox` | :ref:`focus` | | ++---------------------------------+----------------------------------------------------------------------------+--------------------------------+ +| :ref:`StyleBox` | :ref:`panel` | | ++---------------------------------+----------------------------------------------------------------------------+--------------------------------+ | :ref:`StyleBox` | :ref:`selected` | | +---------------------------------+----------------------------------------------------------------------------+--------------------------------+ | :ref:`StyleBox` | :ref:`selected_focus` | | @@ -337,10 +337,10 @@ A value of zero disables the adjustment, each item will have a width equal to th .. _class_ItemList_property_fixed_icon_size: -- :ref:`Vector2` **fixed_icon_size** +- :ref:`Vector2i` **fixed_icon_size** +-----------+----------------------------+ -| *Default* | ``Vector2(0, 0)`` | +| *Default* | ``Vector2i(0, 0)`` | +-----------+----------------------------+ | *Setter* | set_fixed_icon_size(value) | +-----------+----------------------------+ @@ -971,22 +971,6 @@ Font size of the item's text. ---- -.. _class_ItemList_theme_style_bg: - -- :ref:`StyleBox` **bg** - -Default :ref:`StyleBox` for the ``ItemList``, i.e. used when the control is not being focused. - ----- - -.. _class_ItemList_theme_style_bg_focus: - -- :ref:`StyleBox` **bg_focus** - -:ref:`StyleBox` used when the ``ItemList`` is being focused. - ----- - .. _class_ItemList_theme_style_cursor: - :ref:`StyleBox` **cursor** @@ -1003,6 +987,22 @@ Default :ref:`StyleBox` for the ``ItemList``, i.e. used when the ---- +.. _class_ItemList_theme_style_focus: + +- :ref:`StyleBox` **focus** + +The focused style for the ``ItemList``, drawn on top of the background, but below everything else. + +---- + +.. _class_ItemList_theme_style_panel: + +- :ref:`StyleBox` **panel** + +The background style for the ``ItemList``. + +---- + .. _class_ItemList_theme_style_selected: - :ref:`StyleBox` **selected** diff --git a/classes/class_javascript.rst b/classes/class_javascriptbridge.rst similarity index 73% rename from classes/class_javascript.rst rename to classes/class_javascriptbridge.rst index 45bc6d49c..68d8eb82a 100644 --- a/classes/class_javascript.rst +++ b/classes/class_javascriptbridge.rst @@ -3,12 +3,12 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/JavaScript.xml. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/JavaScriptBridge.xml. -.. _class_JavaScript: +.. _class_JavaScriptBridge: -JavaScript -========== +JavaScriptBridge +================ **Inherits:** :ref:`Object` @@ -17,9 +17,9 @@ Singleton that connects the engine with the browser's JavaScript context in Web Description ----------- -The JavaScript singleton is implemented only in the Web export. It's used to access the browser's JavaScript context. This allows interaction with embedding pages or calling third-party JavaScript APIs. +The JavaScriptBridge singleton is implemented only in the Web export. It's used to access the browser's JavaScript context. This allows interaction with embedding pages or calling third-party JavaScript APIs. -\ **Note:** This singleton can be disabled at build-time to improve security. By default, the JavaScript singleton is enabled. Official export templates also have the JavaScript singleton enabled. See :doc:`Compiling for the Web <../development/compiling/compiling_for_web>` in the documentation for more information. +\ **Note:** This singleton can be disabled at build-time to improve security. By default, the JavaScriptBridge singleton is enabled. Official export templates also have the JavaScriptBridge singleton enabled. See :doc:`Compiling for the Web <../development/compiling/compiling_for_web>` in the documentation for more information. Tutorials --------- @@ -29,35 +29,35 @@ Tutorials Methods ------- -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`JavaScriptObject` | :ref:`create_callback` **(** :ref:`Callable` callable **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`create_object` **(** :ref:`String` object, ... **)** |vararg| | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`download_buffer` **(** :ref:`PackedByteArray` buffer, :ref:`String` name, :ref:`String` mime="application/octet-stream" **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`eval` **(** :ref:`String` code, :ref:`bool` use_global_execution_context=false **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`JavaScriptObject` | :ref:`get_interface` **(** :ref:`String` interface **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`pwa_needs_update` **(** **)** |const| | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`pwa_update` **(** **)** | -+-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`JavaScriptObject` | :ref:`create_callback` **(** :ref:`Callable` callable **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`create_object` **(** :ref:`String` object, ... **)** |vararg| | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`download_buffer` **(** :ref:`PackedByteArray` buffer, :ref:`String` name, :ref:`String` mime="application/octet-stream" **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`eval` **(** :ref:`String` code, :ref:`bool` use_global_execution_context=false **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`JavaScriptObject` | :ref:`get_interface` **(** :ref:`String` interface **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`pwa_needs_update` **(** **)** |const| | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`pwa_update` **(** **)** | ++-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- -.. _class_JavaScript_signal_pwa_update_available: +.. _class_JavaScriptBridge_signal_pwa_update_available: - **pwa_update_available** **(** **)** -Emitted when an update for this progressive web app has been detected but is waiting to be activated because a previous version is active. See :ref:`pwa_update` to force the update to take place immediately. +Emitted when an update for this progressive web app has been detected but is waiting to be activated because a previous version is active. See :ref:`pwa_update` to force the update to take place immediately. Method Descriptions ------------------- -.. _class_JavaScript_method_create_callback: +.. _class_JavaScriptBridge_method_create_callback: - :ref:`JavaScriptObject` **create_callback** **(** :ref:`Callable` callable **)** @@ -65,7 +65,7 @@ Creates a reference to a :ref:`Callable` that can be used as a c ---- -.. _class_JavaScript_method_create_object: +.. _class_JavaScriptBridge_method_create_object: - :ref:`Variant` **create_object** **(** :ref:`String` object, ... **)** |vararg| @@ -73,7 +73,7 @@ Creates a new JavaScript object using the ``new`` constructor. The ``object`` mu ---- -.. _class_JavaScript_method_download_buffer: +.. _class_JavaScriptBridge_method_download_buffer: - void **download_buffer** **(** :ref:`PackedByteArray` buffer, :ref:`String` name, :ref:`String` mime="application/octet-stream" **)** @@ -81,13 +81,13 @@ Prompts the user to download a file containing the specified ``buffer``. The fil \ **Note:** The browser may override the `MIME type `__ provided based on the file ``name``'s extension. -\ **Note:** Browsers might block the download if :ref:`download_buffer` is not being called from a user interaction (e.g. button click). +\ **Note:** Browsers might block the download if :ref:`download_buffer` is not being called from a user interaction (e.g. button click). \ **Note:** Browsers might ask the user for permission or block the download if multiple download requests are made in a quick succession. ---- -.. _class_JavaScript_method_eval: +.. _class_JavaScriptBridge_method_eval: - :ref:`Variant` **eval** **(** :ref:`String` code, :ref:`bool` use_global_execution_context=false **)** @@ -97,7 +97,7 @@ If ``use_global_execution_context`` is ``true``, the code will be evaluated in t ---- -.. _class_JavaScript_method_get_interface: +.. _class_JavaScriptBridge_method_get_interface: - :ref:`JavaScriptObject` **get_interface** **(** :ref:`String` interface **)** @@ -105,7 +105,7 @@ Returns an interface to a JavaScript object that can be used by scripts. The ``i ---- -.. _class_JavaScript_method_pwa_needs_update: +.. _class_JavaScriptBridge_method_pwa_needs_update: - :ref:`bool` **pwa_needs_update** **(** **)** |const| @@ -115,7 +115,7 @@ Returns ``true`` if a new version of the progressive web app is waiting to be ac ---- -.. _class_JavaScript_method_pwa_update: +.. _class_JavaScriptBridge_method_pwa_update: - :ref:`Error` **pwa_update** **(** **)** @@ -123,7 +123,7 @@ Performs the live update of the progressive web app. Forcing the new version to \ **Note:** Your application will be **reloaded in all browser tabs**. -\ **Note:** Only relevant when exported as a Progressive Web App and :ref:`pwa_needs_update` returns ``true``. +\ **Note:** Only relevant when exported as a Progressive Web App and :ref:`pwa_needs_update` returns ``true``. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_javascriptobject.rst b/classes/class_javascriptobject.rst index 218ecd7d0..a5335a8c9 100644 --- a/classes/class_javascriptobject.rst +++ b/classes/class_javascriptobject.rst @@ -12,12 +12,12 @@ JavaScriptObject **Inherits:** :ref:`RefCounted` **<** :ref:`Object` -A wrapper class for native JavaScript objects. +A wrapper class for web native JavaScript objects. Description ----------- -JavaScriptObject is used to interact with JavaScript objects retrieved or created via :ref:`JavaScript.get_interface`, :ref:`JavaScript.create_object`, or :ref:`JavaScript.create_callback`. +JavaScriptObject is used to interact with JavaScript objects retrieved or created via :ref:`JavaScriptBridge.get_interface`, :ref:`JavaScriptBridge.create_object`, or :ref:`JavaScriptBridge.create_callback`. Example: @@ -25,19 +25,19 @@ Example: extends Node - var _my_js_callback = JavaScript.create_callback(self, "myCallback") # This reference must be kept - var console = JavaScript.get_interface("console") + var _my_js_callback = JavaScriptBridge.create_callback(self, "myCallback") # This reference must be kept + var console = JavaScriptBridge.get_interface("console") func _init(): - var buf = JavaScript.create_object("ArrayBuffer", 10) # new ArrayBuffer(10) + var buf = JavaScriptBridge.create_object("ArrayBuffer", 10) # new ArrayBuffer(10) print(buf) # prints [JavaScriptObject:OBJECT_ID] - var uint8arr = JavaScript.create_object("Uint8Array", buf) # new Uint8Array(buf) + var uint8arr = JavaScriptBridge.create_object("Uint8Array", buf) # new Uint8Array(buf) uint8arr[1] = 255 prints(uint8arr[1], uint8arr.byteLength) # prints 255 10 console.log(uint8arr) # prints in browser console "Uint8Array(10) [ 0, 255, 0, 0, 0, 0, 0, 0, 0, 0 ]" - # Equivalent of JavaScript: Array.from(uint8arr).forEach(myCallback) - JavaScript.get_interface("Array").from(uint8arr).forEach(_my_js_callback) + # Equivalent of JavaScriptBridge: Array.from(uint8arr).forEach(myCallback) + JavaScriptBridge.get_interface("Array").from(uint8arr).forEach(_my_js_callback) func myCallback(args): # Will be called with the parameters passed to the "forEach" callback diff --git a/classes/class_light3d.rst b/classes/class_light3d.rst index 962918cf9..35d7aa3f4 100644 --- a/classes/class_light3d.rst +++ b/classes/class_light3d.rst @@ -54,6 +54,10 @@ Properties +----------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`light_indirect_energy` | ``1.0`` | +----------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`light_intensity_lumens` | | ++----------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`light_intensity_lux` | | ++----------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`light_negative` | ``false`` | +----------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ | :ref:`Texture2D` | :ref:`light_projector` | | @@ -62,6 +66,8 @@ Properties +----------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`light_specular` | ``0.5`` | +----------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ +| :ref:`float` | :ref:`light_temperature` | | ++----------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`light_volumetric_fog_energy` | ``1.0`` | +----------------------------------------+----------------------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`shadow_bias` | ``0.1`` | @@ -82,6 +88,8 @@ Properties Methods ------- ++---------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`get_correlated_color` **(** **)** |const| | +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`get_param` **(** :ref:`Param` param **)** |const| | +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ @@ -133,6 +141,8 @@ Enumerations .. _class_Light3D_constant_PARAM_TRANSMITTANCE_BIAS: +.. _class_Light3D_constant_PARAM_INTENSITY: + .. _class_Light3D_constant_PARAM_MAX: enum **Param**: @@ -177,7 +187,9 @@ enum **Param**: - **PARAM_TRANSMITTANCE_BIAS** = **19** --- Constant for accessing :ref:`shadow_transmittance_bias`. -- **PARAM_MAX** = **20** --- Represents the size of the :ref:`Param` enum. +- **PARAM_INTENSITY** = **20** --- Constant for accessing :ref:`light_intensity_lumens` and :ref:`light_intensity_lux`. Only used when :ref:`ProjectSettings.rendering/lights_and_shadows/use_physical_light_units` is ``true``. + +- **PARAM_MAX** = **21** --- Represents the size of the :ref:`Param` enum. ---- @@ -390,6 +402,40 @@ Secondary multiplier used with indirect light (light bounces). Used with :ref:`V ---- +.. _class_Light3D_property_light_intensity_lumens: + +- :ref:`float` **light_intensity_lumens** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +Used by positional lights (:ref:`OmniLight3D` and :ref:`SpotLight3D`) when :ref:`ProjectSettings.rendering/lights_and_shadows/use_physical_light_units` is ``true``. Sets the intensity of the light source measured in Lumens. Lumens are a measure of luminous flux, which is the total amount of visible light emitted by a light source per unit of time. + +For :ref:`SpotLight3D`\ s, we assume that the area outside the visible cone is surrounded by a perfect light absorbing material. Accordingly, the apparent brightness of the cone area does not change as the cone increases and decreases in size. + +A typical household lightbulb can range from around 600 lumens to 1,200 lumens, a candle is about 13 lumens, while a streetlight can be approximately 60,000 lumens. + +---- + +.. _class_Light3D_property_light_intensity_lux: + +- :ref:`float` **light_intensity_lux** + ++----------+------------------+ +| *Setter* | set_param(value) | ++----------+------------------+ +| *Getter* | get_param() | ++----------+------------------+ + +Used by :ref:`DirectionalLight3D`\ s when :ref:`ProjectSettings.rendering/lights_and_shadows/use_physical_light_units` is ``true``. Sets the intensity of the light source measured in Lux. Lux is a measure pf luminous flux per unit area, it is equal to one lumen per square metre. Lux is the measure of how much light hits a surface at a given time. + +On a clear sunny day a surface in direct sunlight may be approximately 100,000 lux, a typical room in a home may be approximately 50 lux, while the moonlit ground may be approximately 0.1 lux. + +---- + .. _class_Light3D_property_light_negative: - :ref:`bool` **light_negative** @@ -454,6 +500,22 @@ The intensity of the specular blob in objects affected by the light. At ``0``, t ---- +.. _class_Light3D_property_light_temperature: + +- :ref:`float` **light_temperature** + ++----------+------------------------+ +| *Setter* | set_temperature(value) | ++----------+------------------------+ +| *Getter* | get_temperature() | ++----------+------------------------+ + +Sets the color temperature of the light source, measured in Kelvin. This is used to calculate a correlated color temperature which tints the :ref:`light_color`. + +The sun on a cloudy day is approximately 6500 Kelvin, on a clear day it is between 5500 to 6000 Kelvin, and on a clear day at sunrise or sunset it ranges to around 1850 Kelvin. + +---- + .. _class_Light3D_property_light_volumetric_fog_energy: - :ref:`float` **light_volumetric_fog_energy** @@ -583,6 +645,14 @@ If ``true``, reverses the backface culling of the mesh. This can be useful when Method Descriptions ------------------- +.. _class_Light3D_method_get_correlated_color: + +- :ref:`Color` **get_correlated_color** **(** **)** |const| + +Returns the :ref:`Color` of an idealized blackbody at the given :ref:`light_temperature`. This value is calculated internally based on the :ref:`light_temperature`. This :ref:`Color` is multiplied by :ref:`light_color` before being sent to the :ref:`RenderingServer`. + +---- + .. _class_Light3D_method_get_param: - :ref:`float` **get_param** **(** :ref:`Param` param **)** |const| diff --git a/classes/class_lightmapgi.rst b/classes/class_lightmapgi.rst index fd5b0175a..46af26aba 100644 --- a/classes/class_lightmapgi.rst +++ b/classes/class_lightmapgi.rst @@ -37,6 +37,8 @@ Properties +---------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ | :ref:`int` | :ref:`bounces` | ``1`` | +---------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ +| :ref:`CameraAttributes` | :ref:`camera_attributes` | | ++---------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ | :ref:`bool` | :ref:`directional` | ``false`` | +---------------------------------------------------------+---------------------------------------------------------------------------------------+------------+ | :ref:`Color` | :ref:`environment_custom_color` | | @@ -202,6 +204,20 @@ Number of light bounces that are taken into account during baking. Higher values ---- +.. _class_LightmapGI_property_camera_attributes: + +- :ref:`CameraAttributes` **camera_attributes** + ++----------+------------------------------+ +| *Setter* | set_camera_attributes(value) | ++----------+------------------------------+ +| *Getter* | get_camera_attributes() | ++----------+------------------------------+ + +The :ref:`CameraAttributes` resource that specifies exposure levels to bake at. Auto-exposure and non exposure properties will be ignored. Exposure settings should be used to reduce the dynamic range present when baking. If exposure is too high, the ``LightmapGI`` will have banding artifacts or may have over-exposure artifacts. + +---- + .. _class_LightmapGI_property_directional: - :ref:`bool` **directional** diff --git a/classes/class_lineedit.rst b/classes/class_lineedit.rst index 4b167d70a..cf051e480 100644 --- a/classes/class_lineedit.rst +++ b/classes/class_lineedit.rst @@ -71,7 +71,7 @@ Properties +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`caret_blink` | ``false`` | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`caret_blink_speed` | ``0.65`` | +| :ref:`float` | :ref:`caret_blink_interval` | ``0.65`` | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`caret_column` | ``0`` | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ @@ -427,17 +427,17 @@ If ``true``, the caret (text cursor) blinks. ---- -.. _class_LineEdit_property_caret_blink_speed: +.. _class_LineEdit_property_caret_blink_interval: -- :ref:`float` **caret_blink_speed** +- :ref:`float` **caret_blink_interval** -+-----------+------------------------------+ -| *Default* | ``0.65`` | -+-----------+------------------------------+ -| *Setter* | set_caret_blink_speed(value) | -+-----------+------------------------------+ -| *Getter* | get_caret_blink_speed() | -+-----------+------------------------------+ ++-----------+---------------------------------+ +| *Default* | ``0.65`` | ++-----------+---------------------------------+ +| *Setter* | set_caret_blink_interval(value) | ++-----------+---------------------------------+ +| *Getter* | get_caret_blink_interval() | ++-----------+---------------------------------+ Duration (in seconds) of a caret's blinking cycle. diff --git a/classes/class_multiplayerpeerextension.rst b/classes/class_multiplayerpeerextension.rst index 8ec3f64fa..6952d942a 100644 --- a/classes/class_multiplayerpeerextension.rst +++ b/classes/class_multiplayerpeerextension.rst @@ -22,43 +22,43 @@ This class is designed to be inherited from a GDExtension plugin to implement cu Methods ------- -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_available_packet_count` **(** **)** |virtual| |const| | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_connection_status` **(** **)** |virtual| |const| | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_max_packet_size` **(** **)** |virtual| |const| | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_packet` **(** const uint8_t ** r_buffer, int32_t* r_buffer_size **)** |virtual| | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_packet_peer` **(** **)** |virtual| |const| | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedByteArray` | :ref:`_get_packet_script` **(** **)** |virtual| | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_transfer_channel` **(** **)** |virtual| |const| | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_transfer_mode` **(** **)** |virtual| |const| | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_unique_id` **(** **)** |virtual| |const| | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`_is_refusing_new_connections` **(** **)** |virtual| |const| | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`_is_server` **(** **)** |virtual| |const| | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_poll` **(** **)** |virtual| | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_put_packet` **(** const uint8_t* p_buffer, :ref:`int` p_buffer_size **)** |virtual| | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_put_packet_script` **(** :ref:`PackedByteArray` p_buffer **)** |virtual| | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_set_refuse_new_connections` **(** :ref:`bool` p_enable **)** |virtual| | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_set_target_peer` **(** :ref:`int` p_peer **)** |virtual| | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_set_transfer_channel` **(** :ref:`int` p_channel **)** |virtual| | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_set_transfer_mode` **(** :ref:`int` p_mode **)** |virtual| | -+-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_available_packet_count` **(** **)** |virtual| |const| | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ConnectionStatus` | :ref:`_get_connection_status` **(** **)** |virtual| |const| | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_max_packet_size` **(** **)** |virtual| |const| | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`_get_packet` **(** const uint8_t ** r_buffer, int32_t* r_buffer_size **)** |virtual| | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_packet_peer` **(** **)** |virtual| |const| | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedByteArray` | :ref:`_get_packet_script` **(** **)** |virtual| | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_transfer_channel` **(** **)** |virtual| |const| | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`TransferMode` | :ref:`_get_transfer_mode` **(** **)** |virtual| |const| | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_unique_id` **(** **)** |virtual| |const| | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`_is_refusing_new_connections` **(** **)** |virtual| |const| | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`_is_server` **(** **)** |virtual| |const| | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_poll` **(** **)** |virtual| | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`_put_packet` **(** const uint8_t* p_buffer, :ref:`int` p_buffer_size **)** |virtual| | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`_put_packet_script` **(** :ref:`PackedByteArray` p_buffer **)** |virtual| | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_set_refuse_new_connections` **(** :ref:`bool` p_enable **)** |virtual| | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_set_target_peer` **(** :ref:`int` p_peer **)** |virtual| | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_set_transfer_channel` **(** :ref:`int` p_channel **)** |virtual| | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_set_transfer_mode` **(** :ref:`TransferMode` p_mode **)** |virtual| | ++----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- @@ -73,7 +73,7 @@ Called when the available packet count is internally requested by the :ref:`Mult .. _class_MultiplayerPeerExtension_method__get_connection_status: -- :ref:`int` **_get_connection_status** **(** **)** |virtual| |const| +- :ref:`ConnectionStatus` **_get_connection_status** **(** **)** |virtual| |const| Called when the connection status is requested on the :ref:`MultiplayerPeer` (see :ref:`MultiplayerPeer.get_connection_status`). @@ -89,7 +89,7 @@ Called when the maximum allowed packet size (in bytes) is requested by the :ref: .. _class_MultiplayerPeerExtension_method__get_packet: -- :ref:`int` **_get_packet** **(** const uint8_t ** r_buffer, int32_t* r_buffer_size **)** |virtual| +- :ref:`Error` **_get_packet** **(** const uint8_t ** r_buffer, int32_t* r_buffer_size **)** |virtual| Called when a packet needs to be received by the :ref:`MultiplayerAPI`, with ``r_buffer_size`` being the size of the binary ``r_buffer`` in bytes. @@ -121,7 +121,7 @@ Called when the transfer channel to use is read on this :ref:`MultiplayerPeer` **_get_transfer_mode** **(** **)** |virtual| |const| +- :ref:`TransferMode` **_get_transfer_mode** **(** **)** |virtual| |const| Called when the transfer mode to use is read on this :ref:`MultiplayerPeer` (see :ref:`MultiplayerPeer.transfer_mode`). @@ -153,7 +153,7 @@ Called when the "is server" status is requested on the :ref:`MultiplayerAPI` **_poll** **(** **)** |virtual| +- void **_poll** **(** **)** |virtual| Called when the :ref:`MultiplayerAPI` is polled. See :ref:`MultiplayerAPI.poll`. @@ -161,7 +161,7 @@ Called when the :ref:`MultiplayerAPI` is polled. See :ref: .. _class_MultiplayerPeerExtension_method__put_packet: -- :ref:`int` **_put_packet** **(** const uint8_t* p_buffer, :ref:`int` p_buffer_size **)** |virtual| +- :ref:`Error` **_put_packet** **(** const uint8_t* p_buffer, :ref:`int` p_buffer_size **)** |virtual| Called when a packet needs to be sent by the :ref:`MultiplayerAPI`, with ``p_buffer_size`` being the size of the binary ``p_buffer`` in bytes. @@ -169,7 +169,7 @@ Called when a packet needs to be sent by the :ref:`MultiplayerAPI` **_put_packet_script** **(** :ref:`PackedByteArray` p_buffer **)** |virtual| +- :ref:`Error` **_put_packet_script** **(** :ref:`PackedByteArray` p_buffer **)** |virtual| Called when a packet needs to be sent by the :ref:`MultiplayerAPI`, if :ref:`_put_packet` isn't implemented. Use this when extending this class via GDScript. @@ -201,7 +201,7 @@ Called when the channel to use is set for this :ref:`MultiplayerPeer` p_mode **)** |virtual| +- void **_set_transfer_mode** **(** :ref:`TransferMode` p_mode **)** |virtual| Called when the transfer mode is set on this :ref:`MultiplayerPeer` (see :ref:`MultiplayerPeer.transfer_mode`). diff --git a/classes/class_navigationagent2d.rst b/classes/class_navigationagent2d.rst index 7cc0a9f3a..4733e6a85 100644 --- a/classes/class_navigationagent2d.rst +++ b/classes/class_navigationagent2d.rst @@ -114,7 +114,7 @@ Notifies when the player defined target, set with :ref:`set_target_location` safe_velocity **)** -Notifies when the collision avoidance velocity is calculated. Emitted by :ref:`set_velocity`. +Notifies when the collision avoidance velocity is calculated. Emitted by :ref:`set_velocity`. Only emitted when :ref:`avoidance_enabled` is true. Property Descriptions --------------------- diff --git a/classes/class_navigationagent3d.rst b/classes/class_navigationagent3d.rst index f1b70ca52..8c1bc21d2 100644 --- a/classes/class_navigationagent3d.rst +++ b/classes/class_navigationagent3d.rst @@ -118,7 +118,7 @@ Notifies when the player defined target, set with :ref:`set_target_location` safe_velocity **)** -Notifies when the collision avoidance velocity is calculated. Emitted by :ref:`set_velocity`. +Notifies when the collision avoidance velocity is calculated. Emitted by :ref:`set_velocity`. Only emitted when :ref:`avoidance_enabled` is true. Property Descriptions --------------------- diff --git a/classes/class_navigationlink2d.rst b/classes/class_navigationlink2d.rst new file mode 100644 index 000000000..cd3197e66 --- /dev/null +++ b/classes/class_navigationlink2d.rst @@ -0,0 +1,193 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/NavigationLink2D.xml. + +.. _class_NavigationLink2D: + +NavigationLink2D +================ + +**Inherits:** :ref:`Node2D` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` + +Creates a link between two locations that :ref:`NavigationServer2D` can route agents through. + +Description +----------- + +Creates a link between two locations that :ref:`NavigationServer2D` can route agents through. Links can be used to express navigation methods that aren't just traveling along the surface of the navigation mesh, like zip-lines, teleporters, or jumping across gaps. + +Properties +---------- + ++-------------------------------+-----------------------------------------------------------------------------+-------------------+ +| :ref:`bool` | :ref:`bidirectional` | ``true`` | ++-------------------------------+-----------------------------------------------------------------------------+-------------------+ +| :ref:`bool` | :ref:`enabled` | ``true`` | ++-------------------------------+-----------------------------------------------------------------------------+-------------------+ +| :ref:`Vector2` | :ref:`end_location` | ``Vector2(0, 0)`` | ++-------------------------------+-----------------------------------------------------------------------------+-------------------+ +| :ref:`float` | :ref:`enter_cost` | ``0.0`` | ++-------------------------------+-----------------------------------------------------------------------------+-------------------+ +| :ref:`int` | :ref:`navigation_layers` | ``1`` | ++-------------------------------+-----------------------------------------------------------------------------+-------------------+ +| :ref:`Vector2` | :ref:`start_location` | ``Vector2(0, 0)`` | ++-------------------------------+-----------------------------------------------------------------------------+-------------------+ +| :ref:`float` | :ref:`travel_cost` | ``1.0`` | ++-------------------------------+-----------------------------------------------------------------------------+-------------------+ + +Methods +------- + ++-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_navigation_layer_value` **(** :ref:`int` layer_number **)** |const| | ++-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_navigation_layer_value` **(** :ref:`int` layer_number, :ref:`bool` value **)** | ++-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Property Descriptions +--------------------- + +.. _class_NavigationLink2D_property_bidirectional: + +- :ref:`bool` **bidirectional** + ++-----------+--------------------------+ +| *Default* | ``true`` | ++-----------+--------------------------+ +| *Setter* | set_bidirectional(value) | ++-----------+--------------------------+ +| *Getter* | is_bidirectional() | ++-----------+--------------------------+ + +Whether this link can be traveled in both directions or only from :ref:`start_location` to :ref:`end_location`. + +---- + +.. _class_NavigationLink2D_property_enabled: + +- :ref:`bool` **enabled** + ++-----------+--------------------+ +| *Default* | ``true`` | ++-----------+--------------------+ +| *Setter* | set_enabled(value) | ++-----------+--------------------+ +| *Getter* | is_enabled() | ++-----------+--------------------+ + +Whether this link is currently active. If ``false``, :ref:`NavigationServer2D.map_get_path` will ignore this link. + +---- + +.. _class_NavigationLink2D_property_end_location: + +- :ref:`Vector2` **end_location** + ++-----------+-------------------------+ +| *Default* | ``Vector2(0, 0)`` | ++-----------+-------------------------+ +| *Setter* | set_end_location(value) | ++-----------+-------------------------+ +| *Getter* | get_end_location() | ++-----------+-------------------------+ + +Ending position of the link. + +This position will search out the nearest polygon in the navigation mesh to attach to. + +The distance the link will search is controlled by :ref:`NavigationServer2D.map_set_link_connection_radius`. + +---- + +.. _class_NavigationLink2D_property_enter_cost: + +- :ref:`float` **enter_cost** + ++-----------+-----------------------+ +| *Default* | ``0.0`` | ++-----------+-----------------------+ +| *Setter* | set_enter_cost(value) | ++-----------+-----------------------+ +| *Getter* | get_enter_cost() | ++-----------+-----------------------+ + +When pathfinding enters this link from another regions navmesh the ``enter_cost`` value is added to the path distance for determining the shortest path. + +---- + +.. _class_NavigationLink2D_property_navigation_layers: + +- :ref:`int` **navigation_layers** + ++-----------+------------------------------+ +| *Default* | ``1`` | ++-----------+------------------------------+ +| *Setter* | set_navigation_layers(value) | ++-----------+------------------------------+ +| *Getter* | get_navigation_layers() | ++-----------+------------------------------+ + +A bitfield determining all navigation layers the link belongs to. These navigation layers will be checked when requesting a path with :ref:`NavigationServer2D.map_get_path`. + +---- + +.. _class_NavigationLink2D_property_start_location: + +- :ref:`Vector2` **start_location** + ++-----------+---------------------------+ +| *Default* | ``Vector2(0, 0)`` | ++-----------+---------------------------+ +| *Setter* | set_start_location(value) | ++-----------+---------------------------+ +| *Getter* | get_start_location() | ++-----------+---------------------------+ + +Starting position of the link. + +This position will search out the nearest polygon in the navigation mesh to attach to. + +The distance the link will search is controlled by :ref:`NavigationServer2D.map_set_link_connection_radius`. + +---- + +.. _class_NavigationLink2D_property_travel_cost: + +- :ref:`float` **travel_cost** + ++-----------+------------------------+ +| *Default* | ``1.0`` | ++-----------+------------------------+ +| *Setter* | set_travel_cost(value) | ++-----------+------------------------+ +| *Getter* | get_travel_cost() | ++-----------+------------------------+ + +When pathfinding moves along the link the traveled distance is multiplied with ``travel_cost`` for determining the shortest path. + +Method Descriptions +------------------- + +.. _class_NavigationLink2D_method_get_navigation_layer_value: + +- :ref:`bool` **get_navigation_layer_value** **(** :ref:`int` layer_number **)** |const| + +Returns whether or not the specified layer of the :ref:`navigation_layers` bitmask is enabled, given a ``layer_number`` between 1 and 32. + +---- + +.. _class_NavigationLink2D_method_set_navigation_layer_value: + +- void **set_navigation_layer_value** **(** :ref:`int` layer_number, :ref:`bool` value **)** + +Based on ``value``, enables or disables the specified layer in the :ref:`navigation_layers` bitmask, given a ``layer_number`` between 1 and 32. + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` diff --git a/classes/class_navigationlink3d.rst b/classes/class_navigationlink3d.rst new file mode 100644 index 000000000..c09cc9e97 --- /dev/null +++ b/classes/class_navigationlink3d.rst @@ -0,0 +1,193 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/NavigationLink3D.xml. + +.. _class_NavigationLink3D: + +NavigationLink3D +================ + +**Inherits:** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` + +Creates a link between two locations that :ref:`NavigationServer3D` can route agents through. + +Description +----------- + +Creates a link between two locations that :ref:`NavigationServer3D` can route agents through. Links can be used to express navigation methods that aren't just traveling along the surface of the navigation mesh, like zip-lines, teleporters, or jumping across gaps. + +Properties +---------- + ++-------------------------------+-----------------------------------------------------------------------------+----------------------+ +| :ref:`bool` | :ref:`bidirectional` | ``true`` | ++-------------------------------+-----------------------------------------------------------------------------+----------------------+ +| :ref:`bool` | :ref:`enabled` | ``true`` | ++-------------------------------+-----------------------------------------------------------------------------+----------------------+ +| :ref:`Vector3` | :ref:`end_location` | ``Vector3(0, 0, 0)`` | ++-------------------------------+-----------------------------------------------------------------------------+----------------------+ +| :ref:`float` | :ref:`enter_cost` | ``0.0`` | ++-------------------------------+-----------------------------------------------------------------------------+----------------------+ +| :ref:`int` | :ref:`navigation_layers` | ``1`` | ++-------------------------------+-----------------------------------------------------------------------------+----------------------+ +| :ref:`Vector3` | :ref:`start_location` | ``Vector3(0, 0, 0)`` | ++-------------------------------+-----------------------------------------------------------------------------+----------------------+ +| :ref:`float` | :ref:`travel_cost` | ``1.0`` | ++-------------------------------+-----------------------------------------------------------------------------+----------------------+ + +Methods +------- + ++-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`get_navigation_layer_value` **(** :ref:`int` layer_number **)** |const| | ++-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_navigation_layer_value` **(** :ref:`int` layer_number, :ref:`bool` value **)** | ++-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Property Descriptions +--------------------- + +.. _class_NavigationLink3D_property_bidirectional: + +- :ref:`bool` **bidirectional** + ++-----------+--------------------------+ +| *Default* | ``true`` | ++-----------+--------------------------+ +| *Setter* | set_bidirectional(value) | ++-----------+--------------------------+ +| *Getter* | is_bidirectional() | ++-----------+--------------------------+ + +Whether this link can be traveled in both directions or only from :ref:`start_location` to :ref:`end_location`. + +---- + +.. _class_NavigationLink3D_property_enabled: + +- :ref:`bool` **enabled** + ++-----------+--------------------+ +| *Default* | ``true`` | ++-----------+--------------------+ +| *Setter* | set_enabled(value) | ++-----------+--------------------+ +| *Getter* | is_enabled() | ++-----------+--------------------+ + +Whether this link is currently active. If ``false``, :ref:`NavigationServer3D.map_get_path` will ignore this link. + +---- + +.. _class_NavigationLink3D_property_end_location: + +- :ref:`Vector3` **end_location** + ++-----------+-------------------------+ +| *Default* | ``Vector3(0, 0, 0)`` | ++-----------+-------------------------+ +| *Setter* | set_end_location(value) | ++-----------+-------------------------+ +| *Getter* | get_end_location() | ++-----------+-------------------------+ + +Ending position of the link. + +This position will search out the nearest polygon in the navigation mesh to attach to. + +The distance the link will search is controlled by :ref:`NavigationServer3D.map_set_link_connection_radius`. + +---- + +.. _class_NavigationLink3D_property_enter_cost: + +- :ref:`float` **enter_cost** + ++-----------+-----------------------+ +| *Default* | ``0.0`` | ++-----------+-----------------------+ +| *Setter* | set_enter_cost(value) | ++-----------+-----------------------+ +| *Getter* | get_enter_cost() | ++-----------+-----------------------+ + +When pathfinding enters this link from another regions navmesh the ``enter_cost`` value is added to the path distance for determining the shortest path. + +---- + +.. _class_NavigationLink3D_property_navigation_layers: + +- :ref:`int` **navigation_layers** + ++-----------+------------------------------+ +| *Default* | ``1`` | ++-----------+------------------------------+ +| *Setter* | set_navigation_layers(value) | ++-----------+------------------------------+ +| *Getter* | get_navigation_layers() | ++-----------+------------------------------+ + +A bitfield determining all navigation layers the link belongs to. These navigation layers will be checked when requesting a path with :ref:`NavigationServer3D.map_get_path`. + +---- + +.. _class_NavigationLink3D_property_start_location: + +- :ref:`Vector3` **start_location** + ++-----------+---------------------------+ +| *Default* | ``Vector3(0, 0, 0)`` | ++-----------+---------------------------+ +| *Setter* | set_start_location(value) | ++-----------+---------------------------+ +| *Getter* | get_start_location() | ++-----------+---------------------------+ + +Starting position of the link. + +This position will search out the nearest polygon in the navigation mesh to attach to. + +The distance the link will search is controlled by :ref:`NavigationServer3D.map_set_link_connection_radius`. + +---- + +.. _class_NavigationLink3D_property_travel_cost: + +- :ref:`float` **travel_cost** + ++-----------+------------------------+ +| *Default* | ``1.0`` | ++-----------+------------------------+ +| *Setter* | set_travel_cost(value) | ++-----------+------------------------+ +| *Getter* | get_travel_cost() | ++-----------+------------------------+ + +When pathfinding moves along the link the traveled distance is multiplied with ``travel_cost`` for determining the shortest path. + +Method Descriptions +------------------- + +.. _class_NavigationLink3D_method_get_navigation_layer_value: + +- :ref:`bool` **get_navigation_layer_value** **(** :ref:`int` layer_number **)** |const| + +Returns whether or not the specified layer of the :ref:`navigation_layers` bitmask is enabled, given a ``layer_number`` between 1 and 32. + +---- + +.. _class_NavigationLink3D_method_set_navigation_layer_value: + +- void **set_navigation_layer_value** **(** :ref:`int` layer_number, :ref:`bool` value **)** + +Based on ``value``, enables or disables the specified layer in the :ref:`navigation_layers` bitmask, given a ``layer_number`` between 1 and 32. + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` diff --git a/classes/class_navigationserver2d.rst b/classes/class_navigationserver2d.rst index 161d46c7b..cedec8806 100644 --- a/classes/class_navigationserver2d.rst +++ b/classes/class_navigationserver2d.rst @@ -72,6 +72,36 @@ Methods +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID[]` | :ref:`get_maps` **(** **)** |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`link_create` **(** **)** |const| | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`link_get_end_location` **(** :ref:`RID` link **)** |const| | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`link_get_enter_cost` **(** :ref:`RID` link **)** |const| | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`link_get_map` **(** :ref:`RID` link **)** |const| | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`link_get_navigation_layers` **(** :ref:`RID` link **)** |const| | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`link_get_start_location` **(** :ref:`RID` link **)** |const| | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`link_get_travel_cost` **(** :ref:`RID` link **)** |const| | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`link_is_bidirectional` **(** :ref:`RID` link **)** |const| | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`link_set_bidirectional` **(** :ref:`RID` link, :ref:`bool` bidirectional **)** |const| | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`link_set_end_location` **(** :ref:`RID` link, :ref:`Vector2` location **)** |const| | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`link_set_enter_cost` **(** :ref:`RID` link, :ref:`float` enter_cost **)** |const| | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`link_set_map` **(** :ref:`RID` link, :ref:`RID` map **)** |const| | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`link_set_navigation_layers` **(** :ref:`RID` link, :ref:`int` navigation_layers **)** |const| | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`link_set_start_location` **(** :ref:`RID` link, :ref:`Vector2` location **)** |const| | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`link_set_travel_cost` **(** :ref:`RID` link, :ref:`float` travel_cost **)** |const| | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`map_create` **(** **)** |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`map_force_update` **(** :ref:`RID` map **)** | @@ -86,6 +116,10 @@ Methods +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`map_get_edge_connection_margin` **(** :ref:`RID` map **)** |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`map_get_link_connection_radius` **(** :ref:`RID` map **)** |const| | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID[]` | :ref:`map_get_links` **(** :ref:`RID` map **)** |const| | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedVector2Array` | :ref:`map_get_path` **(** :ref:`RID` map, :ref:`Vector2` origin, :ref:`Vector2` destination, :ref:`bool` optimize, :ref:`int` navigation_layers=1 **)** |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID[]` | :ref:`map_get_regions` **(** :ref:`RID` map **)** |const| | @@ -98,6 +132,8 @@ Methods +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`map_set_edge_connection_margin` **(** :ref:`RID` map, :ref:`float` margin **)** |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`map_set_link_connection_radius` **(** :ref:`RID` map, :ref:`float` radius **)** |const| | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`region_create` **(** **)** |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`region_get_connection_pathway_end` **(** :ref:`RID` region, :ref:`int` connection **)** |const| | @@ -263,6 +299,126 @@ Returns all created navigation map :ref:`RID`\ s on the NavigationSer ---- +.. _class_NavigationServer2D_method_link_create: + +- :ref:`RID` **link_create** **(** **)** |const| + +Create a new link between two locations on a map. + +---- + +.. _class_NavigationServer2D_method_link_get_end_location: + +- :ref:`Vector2` **link_get_end_location** **(** :ref:`RID` link **)** |const| + +Returns the ending location of this ``link``. + +---- + +.. _class_NavigationServer2D_method_link_get_enter_cost: + +- :ref:`float` **link_get_enter_cost** **(** :ref:`RID` link **)** |const| + +Returns the ``enter_cost`` of this ``link``. + +---- + +.. _class_NavigationServer2D_method_link_get_map: + +- :ref:`RID` **link_get_map** **(** :ref:`RID` link **)** |const| + +Returns the navigation map :ref:`RID` the requested ``link`` is currently assigned to. + +---- + +.. _class_NavigationServer2D_method_link_get_navigation_layers: + +- :ref:`int` **link_get_navigation_layers** **(** :ref:`RID` link **)** |const| + +Returns the navigation layers for this ``link``. + +---- + +.. _class_NavigationServer2D_method_link_get_start_location: + +- :ref:`Vector2` **link_get_start_location** **(** :ref:`RID` link **)** |const| + +Returns the starting location of this ``link``. + +---- + +.. _class_NavigationServer2D_method_link_get_travel_cost: + +- :ref:`float` **link_get_travel_cost** **(** :ref:`RID` link **)** |const| + +Returns the ``travel_cost`` of this ``link``. + +---- + +.. _class_NavigationServer2D_method_link_is_bidirectional: + +- :ref:`bool` **link_is_bidirectional** **(** :ref:`RID` link **)** |const| + +Returns whether this ``link`` can be travelled in both directions. + +---- + +.. _class_NavigationServer2D_method_link_set_bidirectional: + +- void **link_set_bidirectional** **(** :ref:`RID` link, :ref:`bool` bidirectional **)** |const| + +Sets whether this ``link`` can be travelled in both directions. + +---- + +.. _class_NavigationServer2D_method_link_set_end_location: + +- void **link_set_end_location** **(** :ref:`RID` link, :ref:`Vector2` location **)** |const| + +Sets the exit location for the ``link``. + +---- + +.. _class_NavigationServer2D_method_link_set_enter_cost: + +- void **link_set_enter_cost** **(** :ref:`RID` link, :ref:`float` enter_cost **)** |const| + +Sets the ``enter_cost`` for this ``link``. + +---- + +.. _class_NavigationServer2D_method_link_set_map: + +- void **link_set_map** **(** :ref:`RID` link, :ref:`RID` map **)** |const| + +Sets the navigation map :ref:`RID` for the link. + +---- + +.. _class_NavigationServer2D_method_link_set_navigation_layers: + +- void **link_set_navigation_layers** **(** :ref:`RID` link, :ref:`int` navigation_layers **)** |const| + +Set the links's navigation layers. This allows selecting links from a path request (when using :ref:`map_get_path`). + +---- + +.. _class_NavigationServer2D_method_link_set_start_location: + +- void **link_set_start_location** **(** :ref:`RID` link, :ref:`Vector2` location **)** |const| + +Sets the entry location for this ``link``. + +---- + +.. _class_NavigationServer2D_method_link_set_travel_cost: + +- void **link_set_travel_cost** **(** :ref:`RID` link, :ref:`float` travel_cost **)** |const| + +Sets the ``travel_cost`` for this ``link``. + +---- + .. _class_NavigationServer2D_method_map_create: - :ref:`RID` **map_create** **(** **)** |const| @@ -325,6 +481,22 @@ Returns the edge connection margin of the map. The edge connection margin is a d ---- +.. _class_NavigationServer2D_method_map_get_link_connection_radius: + +- :ref:`float` **map_get_link_connection_radius** **(** :ref:`RID` map **)** |const| + +Returns the link connection radius of the map. This distance is the maximum range any link will search for navigation mesh polygons to connect to. + +---- + +.. _class_NavigationServer2D_method_map_get_links: + +- :ref:`RID[]` **map_get_links** **(** :ref:`RID` map **)** |const| + +Returns all navigation link :ref:`RID`\ s that are currently assigned to the requested navigation ``map``. + +---- + .. _class_NavigationServer2D_method_map_get_path: - :ref:`PackedVector2Array` **map_get_path** **(** :ref:`RID` map, :ref:`Vector2` origin, :ref:`Vector2` destination, :ref:`bool` optimize, :ref:`int` navigation_layers=1 **)** |const| @@ -373,6 +545,14 @@ Set the map edge connection margin used to weld the compatible region edges. ---- +.. _class_NavigationServer2D_method_map_set_link_connection_radius: + +- void **map_set_link_connection_radius** **(** :ref:`RID` map, :ref:`float` radius **)** |const| + +Set the map's link connection radius used to connect links to navigation polygons. + +---- + .. _class_NavigationServer2D_method_region_create: - :ref:`RID` **region_create** **(** **)** |const| diff --git a/classes/class_navigationserver3d.rst b/classes/class_navigationserver3d.rst index d55dd4e7e..6087dd167 100644 --- a/classes/class_navigationserver3d.rst +++ b/classes/class_navigationserver3d.rst @@ -72,6 +72,36 @@ Methods +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID[]` | :ref:`get_maps` **(** **)** |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`link_create` **(** **)** |const| | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`link_get_end_location` **(** :ref:`RID` link **)** |const| | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`link_get_enter_cost` **(** :ref:`RID` link **)** |const| | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`link_get_map` **(** :ref:`RID` link **)** |const| | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`link_get_navigation_layers` **(** :ref:`RID` link **)** |const| | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`link_get_start_location` **(** :ref:`RID` link **)** |const| | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`link_get_travel_cost` **(** :ref:`RID` link **)** |const| | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`link_is_bidirectional` **(** :ref:`RID` link **)** |const| | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`link_set_bidirectional` **(** :ref:`RID` link, :ref:`bool` bidirectional **)** |const| | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`link_set_end_location` **(** :ref:`RID` link, :ref:`Vector3` location **)** |const| | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`link_set_enter_cost` **(** :ref:`RID` link, :ref:`float` enter_cost **)** |const| | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`link_set_map` **(** :ref:`RID` link, :ref:`RID` map **)** |const| | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`link_set_navigation_layers` **(** :ref:`RID` link, :ref:`int` navigation_layers **)** |const| | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`link_set_start_location` **(** :ref:`RID` link, :ref:`Vector3` location **)** |const| | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`link_set_travel_cost` **(** :ref:`RID` link, :ref:`float` travel_cost **)** |const| | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`map_create` **(** **)** |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`map_force_update` **(** :ref:`RID` map **)** | @@ -90,6 +120,10 @@ Methods +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`map_get_edge_connection_margin` **(** :ref:`RID` map **)** |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`map_get_link_connection_radius` **(** :ref:`RID` map **)** |const| | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID[]` | :ref:`map_get_links` **(** :ref:`RID` map **)** |const| | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedVector3Array` | :ref:`map_get_path` **(** :ref:`RID` map, :ref:`Vector3` origin, :ref:`Vector3` destination, :ref:`bool` optimize, :ref:`int` navigation_layers=1 **)** |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID[]` | :ref:`map_get_regions` **(** :ref:`RID` map **)** |const| | @@ -104,6 +138,8 @@ Methods +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`map_set_edge_connection_margin` **(** :ref:`RID` map, :ref:`float` margin **)** |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`map_set_link_connection_radius` **(** :ref:`RID` map, :ref:`float` radius **)** |const| | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`map_set_up` **(** :ref:`RID` map, :ref:`Vector3` up **)** |const| | +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`process` **(** :ref:`float` delta_time **)** | @@ -285,6 +321,126 @@ Returns all created navigation map :ref:`RID`\ s on the NavigationSer ---- +.. _class_NavigationServer3D_method_link_create: + +- :ref:`RID` **link_create** **(** **)** |const| + +Create a new link between two locations on a map. + +---- + +.. _class_NavigationServer3D_method_link_get_end_location: + +- :ref:`Vector3` **link_get_end_location** **(** :ref:`RID` link **)** |const| + +Returns the ending location of this ``link``. + +---- + +.. _class_NavigationServer3D_method_link_get_enter_cost: + +- :ref:`float` **link_get_enter_cost** **(** :ref:`RID` link **)** |const| + +Returns the ``enter_cost`` of this ``link``. + +---- + +.. _class_NavigationServer3D_method_link_get_map: + +- :ref:`RID` **link_get_map** **(** :ref:`RID` link **)** |const| + +Returns the navigation map :ref:`RID` the requested ``link`` is currently assigned to. + +---- + +.. _class_NavigationServer3D_method_link_get_navigation_layers: + +- :ref:`int` **link_get_navigation_layers** **(** :ref:`RID` link **)** |const| + +Returns the navigation layers for this ``link``. + +---- + +.. _class_NavigationServer3D_method_link_get_start_location: + +- :ref:`Vector3` **link_get_start_location** **(** :ref:`RID` link **)** |const| + +Returns the starting location of this ``link``. + +---- + +.. _class_NavigationServer3D_method_link_get_travel_cost: + +- :ref:`float` **link_get_travel_cost** **(** :ref:`RID` link **)** |const| + +Returns the ``travel_cost`` of this ``link``. + +---- + +.. _class_NavigationServer3D_method_link_is_bidirectional: + +- :ref:`bool` **link_is_bidirectional** **(** :ref:`RID` link **)** |const| + +Returns whether this ``link`` can be travelled in both directions. + +---- + +.. _class_NavigationServer3D_method_link_set_bidirectional: + +- void **link_set_bidirectional** **(** :ref:`RID` link, :ref:`bool` bidirectional **)** |const| + +Sets whether this ``link`` can be travelled in both directions. + +---- + +.. _class_NavigationServer3D_method_link_set_end_location: + +- void **link_set_end_location** **(** :ref:`RID` link, :ref:`Vector3` location **)** |const| + +Sets the exit location for the ``link``. + +---- + +.. _class_NavigationServer3D_method_link_set_enter_cost: + +- void **link_set_enter_cost** **(** :ref:`RID` link, :ref:`float` enter_cost **)** |const| + +Sets the ``enter_cost`` for this ``link``. + +---- + +.. _class_NavigationServer3D_method_link_set_map: + +- void **link_set_map** **(** :ref:`RID` link, :ref:`RID` map **)** |const| + +Sets the navigation map :ref:`RID` for the link. + +---- + +.. _class_NavigationServer3D_method_link_set_navigation_layers: + +- void **link_set_navigation_layers** **(** :ref:`RID` link, :ref:`int` navigation_layers **)** |const| + +Set the links's navigation layers. This allows selecting links from a path request (when using :ref:`map_get_path`). + +---- + +.. _class_NavigationServer3D_method_link_set_start_location: + +- void **link_set_start_location** **(** :ref:`RID` link, :ref:`Vector3` location **)** |const| + +Sets the entry location for this ``link``. + +---- + +.. _class_NavigationServer3D_method_link_set_travel_cost: + +- void **link_set_travel_cost** **(** :ref:`RID` link, :ref:`float` travel_cost **)** |const| + +Sets the ``travel_cost`` for this ``link``. + +---- + .. _class_NavigationServer3D_method_map_create: - :ref:`RID` **map_create** **(** **)** |const| @@ -363,6 +519,22 @@ Returns the edge connection margin of the map. This distance is the minimum vert ---- +.. _class_NavigationServer3D_method_map_get_link_connection_radius: + +- :ref:`float` **map_get_link_connection_radius** **(** :ref:`RID` map **)** |const| + +Returns the link connection radius of the map. This distance is the maximum range any link will search for navigation mesh polygons to connect to. + +---- + +.. _class_NavigationServer3D_method_map_get_links: + +- :ref:`RID[]` **map_get_links** **(** :ref:`RID` map **)** |const| + +Returns all navigation link :ref:`RID`\ s that are currently assigned to the requested navigation ``map``. + +---- + .. _class_NavigationServer3D_method_map_get_path: - :ref:`PackedVector3Array` **map_get_path** **(** :ref:`RID` map, :ref:`Vector3` origin, :ref:`Vector3` destination, :ref:`bool` optimize, :ref:`int` navigation_layers=1 **)** |const| @@ -419,6 +591,14 @@ Set the map edge connection margin used to weld the compatible region edges. ---- +.. _class_NavigationServer3D_method_map_set_link_connection_radius: + +- void **map_set_link_connection_radius** **(** :ref:`RID` map, :ref:`float` radius **)** |const| + +Set the map's link connection radius used to connect links to navigation polygons. + +---- + .. _class_NavigationServer3D_method_map_set_up: - void **map_set_up** **(** :ref:`RID` map, :ref:`Vector3` up **)** |const| diff --git a/classes/class_node.rst b/classes/class_node.rst index c1d68c663..ea6b9fe72 100644 --- a/classes/class_node.rst +++ b/classes/class_node.rst @@ -95,9 +95,9 @@ Methods +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_unhandled_key_input` **(** :ref:`InputEvent` event **)** |virtual| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_child` **(** :ref:`Node` node, :ref:`bool` legible_unique_name=false, :ref:`InternalMode` internal=0 **)** | +| void | :ref:`add_child` **(** :ref:`Node` node, :ref:`bool` force_readable_name=false, :ref:`InternalMode` internal=0 **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`add_sibling` **(** :ref:`Node` sibling, :ref:`bool` legible_unique_name=false **)** | +| void | :ref:`add_sibling` **(** :ref:`Node` sibling, :ref:`bool` force_readable_name=false **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`add_to_group` **(** :ref:`StringName` group, :ref:`bool` persistent=false **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -195,8 +195,6 @@ Methods +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`queue_free` **(** **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`raise` **(** **)** | -+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_and_skip` **(** **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_child` **(** :ref:`Node` node **)** | @@ -847,11 +845,11 @@ For gameplay input, this and :ref:`_unhandled_input` node, :ref:`bool` legible_unique_name=false, :ref:`InternalMode` internal=0 **)** +- void **add_child** **(** :ref:`Node` node, :ref:`bool` force_readable_name=false, :ref:`InternalMode` internal=0 **)** -Adds a child node. Nodes can have any number of children, but every child must have a unique name. Child nodes are automatically deleted when the parent node is deleted, so an entire scene can be removed by deleting its topmost node. +Adds a child ``node``. Nodes can have any number of children, but every child must have a unique name. Child nodes are automatically deleted when the parent node is deleted, so an entire scene can be removed by deleting its topmost node. -If ``legible_unique_name`` is ``true``, the child node will have a human-readable name based on the name of the node being instantiated instead of its type. +If ``force_readable_name`` is ``true``, improves the readability of the added ``node``. If not named, the ``node`` is renamed to its type, and if it shares :ref:`name` with a sibling, a number is suffixed more appropriately. This operation is very slow. As such, it is recommended leaving this to ``false``, which assigns a dummy name featuring ``@`` in both situations. If ``internal`` is different than :ref:`INTERNAL_MODE_DISABLED`, the child will be added as internal node. Such nodes are ignored by methods like :ref:`get_children`, unless their parameter ``include_internal`` is ``true``.The intended usage is to hide the internal nodes from the user, so the user won't accidentally delete or modify them. Used by some GUI nodes, e.g. :ref:`ColorPicker`. See :ref:`InternalMode` for available modes. @@ -886,11 +884,11 @@ If you need the child node to be added below a specific node in the list of chil .. _class_Node_method_add_sibling: -- void **add_sibling** **(** :ref:`Node` sibling, :ref:`bool` legible_unique_name=false **)** +- void **add_sibling** **(** :ref:`Node` sibling, :ref:`bool` force_readable_name=false **)** Adds a ``sibling`` node to current's node parent, at the same level as that node, right below it. -If ``legible_unique_name`` is ``true``, the child node will have a human-readable name based on the name of the node being instantiated instead of its type. +If ``force_readable_name`` is ``true``, improves the readability of the added ``sibling``. If not named, the ``sibling`` is renamed to its type, and if it shares :ref:`name` with a sibling, a number is suffixed more appropriately. This operation is very slow. As such, it is recommended leaving this to ``false``, which assigns a dummy name featuring ``@`` in both situations. Use :ref:`add_child` instead of this method if you don't need the child node to be added below a specific node in the list of children. @@ -1431,14 +1429,6 @@ Queues a node for deletion at the end of the current frame. When deleted, all of ---- -.. _class_Node_method_raise: - -- void **raise** **(** **)** - -Moves this node to the bottom of parent node's children hierarchy. This is often useful in GUIs (:ref:`Control` nodes), because their order of drawing depends on their order in the tree. The top Node is drawn first, then any siblings below the top Node in the hierarchy are successively drawn on top of it. After using ``raise``, a Control will be drawn on top of its siblings. - ----- - .. _class_Node_method_remove_and_skip: - void **remove_and_skip** **(** **)** diff --git a/classes/class_node2d.rst b/classes/class_node2d.rst index cb69f01ad..7db6e0297 100644 --- a/classes/class_node2d.rst +++ b/classes/class_node2d.rst @@ -12,7 +12,7 @@ Node2D **Inherits:** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`AnimatedSprite2D`, :ref:`AudioListener2D`, :ref:`AudioStreamPlayer2D`, :ref:`BackBufferCopy`, :ref:`Bone2D`, :ref:`CPUParticles2D`, :ref:`Camera2D`, :ref:`CanvasGroup`, :ref:`CanvasModulate`, :ref:`CollisionObject2D`, :ref:`CollisionPolygon2D`, :ref:`CollisionShape2D`, :ref:`GPUParticles2D`, :ref:`Joint2D`, :ref:`Light2D`, :ref:`LightOccluder2D`, :ref:`Line2D`, :ref:`Marker2D`, :ref:`MeshInstance2D`, :ref:`MultiMeshInstance2D`, :ref:`NavigationRegion2D`, :ref:`ParallaxLayer`, :ref:`Path2D`, :ref:`PathFollow2D`, :ref:`Polygon2D`, :ref:`RayCast2D`, :ref:`RemoteTransform2D`, :ref:`ShapeCast2D`, :ref:`Skeleton2D`, :ref:`Sprite2D`, :ref:`TileMap`, :ref:`TouchScreenButton`, :ref:`VisibleOnScreenNotifier2D` +**Inherited By:** :ref:`AnimatedSprite2D`, :ref:`AudioListener2D`, :ref:`AudioStreamPlayer2D`, :ref:`BackBufferCopy`, :ref:`Bone2D`, :ref:`CPUParticles2D`, :ref:`Camera2D`, :ref:`CanvasGroup`, :ref:`CanvasModulate`, :ref:`CollisionObject2D`, :ref:`CollisionPolygon2D`, :ref:`CollisionShape2D`, :ref:`GPUParticles2D`, :ref:`Joint2D`, :ref:`Light2D`, :ref:`LightOccluder2D`, :ref:`Line2D`, :ref:`Marker2D`, :ref:`MeshInstance2D`, :ref:`MultiMeshInstance2D`, :ref:`NavigationLink2D`, :ref:`NavigationRegion2D`, :ref:`ParallaxLayer`, :ref:`Path2D`, :ref:`PathFollow2D`, :ref:`Polygon2D`, :ref:`RayCast2D`, :ref:`RemoteTransform2D`, :ref:`ShapeCast2D`, :ref:`Skeleton2D`, :ref:`Sprite2D`, :ref:`TileMap`, :ref:`TouchScreenButton`, :ref:`VisibleOnScreenNotifier2D` A 2D game object, inherited by all 2D-related nodes. Has a position, rotation, scale, and Z index. diff --git a/classes/class_node3d.rst b/classes/class_node3d.rst index a0b4eb629..9c188ed11 100644 --- a/classes/class_node3d.rst +++ b/classes/class_node3d.rst @@ -12,7 +12,7 @@ Node3D **Inherits:** :ref:`Node` **<** :ref:`Object` -**Inherited By:** :ref:`AudioListener3D`, :ref:`AudioStreamPlayer3D`, :ref:`BoneAttachment3D`, :ref:`Camera3D`, :ref:`CollisionObject3D`, :ref:`CollisionPolygon3D`, :ref:`CollisionShape3D`, :ref:`GridMap`, :ref:`ImporterMeshInstance3D`, :ref:`Joint3D`, :ref:`LightmapProbe`, :ref:`Marker3D`, :ref:`NavigationRegion3D`, :ref:`OccluderInstance3D`, :ref:`Path3D`, :ref:`PathFollow3D`, :ref:`RayCast3D`, :ref:`RemoteTransform3D`, :ref:`ShapeCast3D`, :ref:`Skeleton3D`, :ref:`SpringArm3D`, :ref:`VehicleWheel3D`, :ref:`VisualInstance3D`, :ref:`XRNode3D`, :ref:`XROrigin3D` +**Inherited By:** :ref:`AudioListener3D`, :ref:`AudioStreamPlayer3D`, :ref:`BoneAttachment3D`, :ref:`Camera3D`, :ref:`CollisionObject3D`, :ref:`CollisionPolygon3D`, :ref:`CollisionShape3D`, :ref:`GridMap`, :ref:`ImporterMeshInstance3D`, :ref:`Joint3D`, :ref:`LightmapProbe`, :ref:`Marker3D`, :ref:`NavigationLink3D`, :ref:`NavigationRegion3D`, :ref:`OccluderInstance3D`, :ref:`Path3D`, :ref:`PathFollow3D`, :ref:`RayCast3D`, :ref:`RemoteTransform3D`, :ref:`ShapeCast3D`, :ref:`Skeleton3D`, :ref:`SpringArm3D`, :ref:`VehicleWheel3D`, :ref:`VisualInstance3D`, :ref:`XRNode3D`, :ref:`XROrigin3D` Most basic 3D game object, parent of all 3D-related nodes. diff --git a/classes/class_object.rst b/classes/class_object.rst index 1b23885eb..95b2a17b8 100644 --- a/classes/class_object.rst +++ b/classes/class_object.rst @@ -10,7 +10,7 @@ Object ====== -**Inherited By:** :ref:`AudioServer`, :ref:`CameraServer`, :ref:`ClassDB`, :ref:`DisplayServer`, :ref:`EditorFileSystemDirectory`, :ref:`EditorPaths`, :ref:`EditorSelection`, :ref:`EditorVCSInterface`, :ref:`Engine`, :ref:`EngineDebugger`, :ref:`Geometry2D`, :ref:`Geometry3D`, :ref:`GodotSharp`, :ref:`IP`, :ref:`Input`, :ref:`InputMap`, :ref:`JNISingleton`, :ref:`JSONRPC`, :ref:`JavaClassWrapper`, :ref:`JavaScript`, :ref:`MainLoop`, :ref:`Marshalls`, :ref:`MovieWriter`, :ref:`NativeExtensionManager`, :ref:`NavigationMeshGenerator`, :ref:`NavigationServer2D`, :ref:`NavigationServer3D`, :ref:`Node`, :ref:`OS`, :ref:`Performance`, :ref:`PhysicsDirectBodyState2D`, :ref:`PhysicsDirectBodyState3D`, :ref:`PhysicsDirectSpaceState2D`, :ref:`PhysicsDirectSpaceState3D`, :ref:`PhysicsServer2D`, :ref:`PhysicsServer3D`, :ref:`PhysicsServer3DRenderingServerHandler`, :ref:`ProjectSettings`, :ref:`RefCounted`, :ref:`RenderingDevice`, :ref:`RenderingServer`, :ref:`ResourceLoader`, :ref:`ResourceSaver`, :ref:`ResourceUID`, :ref:`ScriptLanguage`, :ref:`TextServerManager`, :ref:`ThemeDB`, :ref:`TileData`, :ref:`Time`, :ref:`TranslationServer`, :ref:`TreeItem`, :ref:`UndoRedo`, :ref:`WorkerThreadPool`, :ref:`XRServer` +**Inherited By:** :ref:`AudioServer`, :ref:`CameraServer`, :ref:`ClassDB`, :ref:`DisplayServer`, :ref:`EditorFileSystemDirectory`, :ref:`EditorPaths`, :ref:`EditorSelection`, :ref:`EditorVCSInterface`, :ref:`Engine`, :ref:`EngineDebugger`, :ref:`Geometry2D`, :ref:`Geometry3D`, :ref:`GodotSharp`, :ref:`IP`, :ref:`Input`, :ref:`InputMap`, :ref:`JNISingleton`, :ref:`JSONRPC`, :ref:`JavaClassWrapper`, :ref:`JavaScriptBridge`, :ref:`MainLoop`, :ref:`Marshalls`, :ref:`MovieWriter`, :ref:`NativeExtensionManager`, :ref:`NavigationMeshGenerator`, :ref:`NavigationServer2D`, :ref:`NavigationServer3D`, :ref:`Node`, :ref:`OS`, :ref:`Performance`, :ref:`PhysicsDirectBodyState2D`, :ref:`PhysicsDirectBodyState3D`, :ref:`PhysicsDirectSpaceState2D`, :ref:`PhysicsDirectSpaceState3D`, :ref:`PhysicsServer2D`, :ref:`PhysicsServer2DManager`, :ref:`PhysicsServer3D`, :ref:`PhysicsServer3DManager`, :ref:`PhysicsServer3DRenderingServerHandler`, :ref:`ProjectSettings`, :ref:`RefCounted`, :ref:`RenderingDevice`, :ref:`RenderingServer`, :ref:`ResourceLoader`, :ref:`ResourceSaver`, :ref:`ResourceUID`, :ref:`ScriptLanguage`, :ref:`TextServerManager`, :ref:`ThemeDB`, :ref:`TileData`, :ref:`Time`, :ref:`TranslationServer`, :ref:`TreeItem`, :ref:`UndoRedo`, :ref:`WorkerThreadPool`, :ref:`XRServer` Base class for all non-built-in types. @@ -192,7 +192,7 @@ Enumerations .. _class_Object_constant_CONNECT_PERSIST: -.. _class_Object_constant_CONNECT_ONESHOT: +.. _class_Object_constant_CONNECT_ONE_SHOT: .. _class_Object_constant_CONNECT_REFERENCE_COUNTED: @@ -202,7 +202,7 @@ enum **ConnectFlags**: - **CONNECT_PERSIST** = **2** --- Persisting connections are saved when the object is serialized to file. -- **CONNECT_ONESHOT** = **4** --- One-shot connections disconnect themselves after emission. +- **CONNECT_ONE_SHOT** = **4** --- One-shot connections disconnect themselves after emission. - **CONNECT_REFERENCE_COUNTED** = **8** --- Connect a signal as reference-counted. This means that a given signal can be connected several times to the same target, and will only be fully disconnected once no references are left. diff --git a/classes/class_oggpacketsequence.rst b/classes/class_oggpacketsequence.rst index 3efdb7887..5b81edf07 100644 --- a/classes/class_oggpacketsequence.rst +++ b/classes/class_oggpacketsequence.rst @@ -22,13 +22,13 @@ A sequence of Ogg packets. Properties ---------- -+---------------------------+------------------------------------------------------------------------------+---------+ -| :ref:`Array` | :ref:`granule_positions` | ``[]`` | -+---------------------------+------------------------------------------------------------------------------+---------+ -| :ref:`Array` | :ref:`packet_data` | ``[]`` | -+---------------------------+------------------------------------------------------------------------------+---------+ -| :ref:`float` | :ref:`sampling_rate` | ``0.0`` | -+---------------------------+------------------------------------------------------------------------------+---------+ ++-------------------------------------------------+------------------------------------------------------------------------------+------------------------+ +| :ref:`PackedInt64Array` | :ref:`granule_positions` | ``PackedInt64Array()`` | ++-------------------------------------------------+------------------------------------------------------------------------------+------------------------+ +| :ref:`Array[]` | :ref:`packet_data` | ``[]`` | ++-------------------------------------------------+------------------------------------------------------------------------------+------------------------+ +| :ref:`float` | :ref:`sampling_rate` | ``0.0`` | ++-------------------------------------------------+------------------------------------------------------------------------------+------------------------+ Methods ------- @@ -42,10 +42,10 @@ Property Descriptions .. _class_OggPacketSequence_property_granule_positions: -- :ref:`Array` **granule_positions** +- :ref:`PackedInt64Array` **granule_positions** +-----------+-------------------------------------+ -| *Default* | ``[]`` | +| *Default* | ``PackedInt64Array()`` | +-----------+-------------------------------------+ | *Setter* | set_packet_granule_positions(value) | +-----------+-------------------------------------+ @@ -58,7 +58,7 @@ Contains the granule positions for each page in this packet sequence. .. _class_OggPacketSequence_property_packet_data: -- :ref:`Array` **packet_data** +- :ref:`Array[]` **packet_data** +-----------+------------------------+ | *Default* | ``[]`` | diff --git a/classes/class_packetpeerdtls.rst b/classes/class_packetpeerdtls.rst index a82a3f844..b03b6a41e 100644 --- a/classes/class_packetpeerdtls.rst +++ b/classes/class_packetpeerdtls.rst @@ -21,7 +21,7 @@ This class represents a DTLS peer connection. It can be used to connect to a DTL \ **Note:** When exporting to Android, make sure to enable the ``INTERNET`` permission in the Android export preset before exporting the project or using one-click deploy. Otherwise, network communication of any kind will be blocked by Android. -\ **Warning:** SSL/TLS certificate revocation and certificate pinning are currently not supported. Revoked certificates are accepted as long as they are otherwise valid. If this is a concern, you may want to use automatically managed certificates with a short validity period. +\ **Warning:** TLS certificate revocation and certificate pinning are currently not supported. Revoked certificates are accepted as long as they are otherwise valid. If this is a concern, you may want to use automatically managed certificates with a short validity period. Methods ------- diff --git a/classes/class_packetpeerextension.rst b/classes/class_packetpeerextension.rst index 0a4766157..48009987d 100644 --- a/classes/class_packetpeerextension.rst +++ b/classes/class_packetpeerextension.rst @@ -17,15 +17,15 @@ PacketPeerExtension Methods ------- -+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_available_packet_count` **(** **)** |virtual| |const| | -+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_max_packet_size` **(** **)** |virtual| |const| | -+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_packet` **(** const uint8_t ** r_buffer, int32_t* r_buffer_size **)** |virtual| | -+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_put_packet` **(** const uint8_t* p_buffer, :ref:`int` p_buffer_size **)** |virtual| | -+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_available_packet_count` **(** **)** |virtual| |const| | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_max_packet_size` **(** **)** |virtual| |const| | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`_get_packet` **(** const uint8_t ** r_buffer, int32_t* r_buffer_size **)** |virtual| | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`_put_packet` **(** const uint8_t* p_buffer, :ref:`int` p_buffer_size **)** |virtual| | ++---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- @@ -44,13 +44,13 @@ Method Descriptions .. _class_PacketPeerExtension_method__get_packet: -- :ref:`int` **_get_packet** **(** const uint8_t ** r_buffer, int32_t* r_buffer_size **)** |virtual| +- :ref:`Error` **_get_packet** **(** const uint8_t ** r_buffer, int32_t* r_buffer_size **)** |virtual| ---- .. _class_PacketPeerExtension_method__put_packet: -- :ref:`int` **_put_packet** **(** const uint8_t* p_buffer, :ref:`int` p_buffer_size **)** |virtual| +- :ref:`Error` **_put_packet** **(** const uint8_t* p_buffer, :ref:`int` p_buffer_size **)** |virtual| .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_packetpeerudp.rst b/classes/class_packetpeerudp.rst index 7b7bafff5..df37dd372 100644 --- a/classes/class_packetpeerudp.rst +++ b/classes/class_packetpeerudp.rst @@ -83,7 +83,7 @@ Closes the ``PacketPeerUDP``'s underlying UDP socket. Calling this method connects this UDP peer to the given ``host``/``port`` pair. UDP is in reality connectionless, so this option only means that incoming packets from different addresses are automatically discarded, and that outgoing packets are always sent to the connected address (future calls to :ref:`set_dest_address` are not allowed). This method does not send any data to the remote peer, to do that, use :ref:`PacketPeer.put_var` or :ref:`PacketPeer.put_packet` as usual. See also :ref:`UDPServer`. -\ **Note:** Connecting to the remote peer does not help to protect from malicious attacks like IP spoofing, etc. Think about using an encryption technique like SSL or DTLS if you feel like your application is transferring sensitive information. +\ **Note:** Connecting to the remote peer does not help to protect from malicious attacks like IP spoofing, etc. Think about using an encryption technique like TLS or DTLS if you feel like your application is transferring sensitive information. ---- diff --git a/classes/class_panel.rst b/classes/class_panel.rst index 6f0b3c1c1..553cfb277 100644 --- a/classes/class_panel.rst +++ b/classes/class_panel.rst @@ -31,11 +31,9 @@ Tutorials Theme Properties ---------------- -+---------------------------------+---------------------------------------------------+ -| :ref:`StyleBox` | :ref:`panel` | -+---------------------------------+---------------------------------------------------+ -| :ref:`StyleBox` | :ref:`panel_fg` | -+---------------------------------+---------------------------------------------------+ ++---------------------------------+---------------------------------------------+ +| :ref:`StyleBox` | :ref:`panel` | ++---------------------------------+---------------------------------------------+ Theme Property Descriptions --------------------------- @@ -46,12 +44,6 @@ Theme Property Descriptions The style of this ``Panel``. ----- - -.. _class_Panel_theme_style_panel_fg: - -- :ref:`StyleBox` **panel_fg** - .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_parallaxlayer.rst b/classes/class_parallaxlayer.rst index b3fd8b29c..50fad40ba 100644 --- a/classes/class_parallaxlayer.rst +++ b/classes/class_parallaxlayer.rst @@ -51,6 +51,8 @@ Property Descriptions The ParallaxLayer's :ref:`Texture2D` mirroring. Useful for creating an infinite scrolling background. If an axis is set to ``0``, the :ref:`Texture2D` will not be mirrored. +If the length of the viewport axis is bigger than twice the mirrored axis size, it will not repeat infinitely, as the parallax layer only draws 2 instances of the texture at any one time. + ---- .. _class_ParallaxLayer_property_motion_offset: diff --git a/classes/class_physicalskymaterial.rst b/classes/class_physicalskymaterial.rst index 6d8e64eb5..5d12add66 100644 --- a/classes/class_physicalskymaterial.rst +++ b/classes/class_physicalskymaterial.rst @@ -27,7 +27,7 @@ Properties ---------- +-----------------------------------+--------------------------------------------------------------------------------------+----------------------------------+ -| :ref:`float` | :ref:`exposure` | ``0.1`` | +| :ref:`float` | :ref:`energy_multiplier` | ``1.0`` | +-----------------------------------+--------------------------------------------------------------------------------------+----------------------------------+ | :ref:`Color` | :ref:`ground_color` | ``Color(0.1, 0.07, 0.034, 1)`` | +-----------------------------------+--------------------------------------------------------------------------------------+----------------------------------+ @@ -53,19 +53,17 @@ Properties Property Descriptions --------------------- -.. _class_PhysicalSkyMaterial_property_exposure: +.. _class_PhysicalSkyMaterial_property_energy_multiplier: -- :ref:`float` **exposure** +- :ref:`float` **energy_multiplier** -+-----------+---------------------+ -| *Default* | ``0.1`` | -+-----------+---------------------+ -| *Setter* | set_exposure(value) | -+-----------+---------------------+ -| *Getter* | get_exposure() | -+-----------+---------------------+ - -Sets the exposure of the sky. Higher exposure values make the entire sky brighter. ++-----------+------------------------------+ +| *Default* | ``1.0`` | ++-----------+------------------------------+ +| *Setter* | set_energy_multiplier(value) | ++-----------+------------------------------+ +| *Getter* | get_energy_multiplier() | ++-----------+------------------------------+ ---- diff --git a/classes/class_physicsdirectbodystate2d.rst b/classes/class_physicsdirectbodystate2d.rst index 8148bb74c..dfd035748 100644 --- a/classes/class_physicsdirectbodystate2d.rst +++ b/classes/class_physicsdirectbodystate2d.rst @@ -12,6 +12,8 @@ PhysicsDirectBodyState2D **Inherits:** :ref:`Object` +**Inherited By:** :ref:`PhysicsDirectBodyState2DExtension` + Direct access object to a physics body in the :ref:`PhysicsServer2D`. Description diff --git a/classes/class_physicsdirectbodystate2dextension.rst b/classes/class_physicsdirectbodystate2dextension.rst new file mode 100644 index 000000000..a983246c3 --- /dev/null +++ b/classes/class_physicsdirectbodystate2dextension.rst @@ -0,0 +1,364 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsDirectBodyState2DExtension.xml. + +.. _class_PhysicsDirectBodyState2DExtension: + +PhysicsDirectBodyState2DExtension +================================= + +**Inherits:** :ref:`PhysicsDirectBodyState2D` **<** :ref:`Object` + + + +Methods +------- + ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_add_constant_central_force` **(** :ref:`Vector2` force **)** |virtual| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_add_constant_force` **(** :ref:`Vector2` force, :ref:`Vector2` position **)** |virtual| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_add_constant_torque` **(** :ref:`float` torque **)** |virtual| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_apply_central_force` **(** :ref:`Vector2` force **)** |virtual| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_apply_central_impulse` **(** :ref:`Vector2` impulse **)** |virtual| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_apply_force` **(** :ref:`Vector2` force, :ref:`Vector2` position **)** |virtual| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_apply_impulse` **(** :ref:`Vector2` impulse, :ref:`Vector2` position **)** |virtual| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_apply_torque` **(** :ref:`float` torque **)** |virtual| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_apply_torque_impulse` **(** :ref:`float` impulse **)** |virtual| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`_get_angular_velocity` **(** **)** |virtual| |const| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`_get_center_of_mass` **(** **)** |virtual| |const| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`_get_center_of_mass_local` **(** **)** |virtual| |const| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`_get_constant_force` **(** **)** |virtual| |const| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`_get_constant_torque` **(** **)** |virtual| |const| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`_get_contact_collider` **(** :ref:`int` contact_idx **)** |virtual| |const| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_contact_collider_id` **(** :ref:`int` contact_idx **)** |virtual| |const| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`_get_contact_collider_object` **(** :ref:`int` contact_idx **)** |virtual| |const| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`_get_contact_collider_position` **(** :ref:`int` contact_idx **)** |virtual| |const| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_contact_collider_shape` **(** :ref:`int` contact_idx **)** |virtual| |const| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`_get_contact_collider_velocity_at_position` **(** :ref:`int` contact_idx **)** |virtual| |const| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_contact_count` **(** **)** |virtual| |const| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`_get_contact_local_normal` **(** :ref:`int` contact_idx **)** |virtual| |const| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`_get_contact_local_position` **(** :ref:`int` contact_idx **)** |virtual| |const| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_contact_local_shape` **(** :ref:`int` contact_idx **)** |virtual| |const| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`_get_inverse_inertia` **(** **)** |virtual| |const| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`_get_inverse_mass` **(** **)** |virtual| |const| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`_get_linear_velocity` **(** **)** |virtual| |const| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PhysicsDirectSpaceState2D` | :ref:`_get_space_state` **(** **)** |virtual| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`_get_step` **(** **)** |virtual| |const| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`_get_total_angular_damp` **(** **)** |virtual| |const| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`_get_total_gravity` **(** **)** |virtual| |const| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`_get_total_linear_damp` **(** **)** |virtual| |const| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`_get_transform` **(** **)** |virtual| |const| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`_get_velocity_at_local_position` **(** :ref:`Vector2` local_position **)** |virtual| |const| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_integrate_forces` **(** **)** |virtual| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`_is_sleeping` **(** **)** |virtual| |const| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_set_angular_velocity` **(** :ref:`float` velocity **)** |virtual| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_set_constant_force` **(** :ref:`Vector2` force **)** |virtual| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_set_constant_torque` **(** :ref:`float` torque **)** |virtual| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_set_linear_velocity` **(** :ref:`Vector2` velocity **)** |virtual| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_set_sleep_state` **(** :ref:`bool` enabled **)** |virtual| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_set_transform` **(** :ref:`Transform2D` transform **)** |virtual| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Method Descriptions +------------------- + +.. _class_PhysicsDirectBodyState2DExtension_method__add_constant_central_force: + +- void **_add_constant_central_force** **(** :ref:`Vector2` force **)** |virtual| + +---- + +.. _class_PhysicsDirectBodyState2DExtension_method__add_constant_force: + +- void **_add_constant_force** **(** :ref:`Vector2` force, :ref:`Vector2` position **)** |virtual| + +---- + +.. _class_PhysicsDirectBodyState2DExtension_method__add_constant_torque: + +- void **_add_constant_torque** **(** :ref:`float` torque **)** |virtual| + +---- + +.. _class_PhysicsDirectBodyState2DExtension_method__apply_central_force: + +- void **_apply_central_force** **(** :ref:`Vector2` force **)** |virtual| + +---- + +.. _class_PhysicsDirectBodyState2DExtension_method__apply_central_impulse: + +- void **_apply_central_impulse** **(** :ref:`Vector2` impulse **)** |virtual| + +---- + +.. _class_PhysicsDirectBodyState2DExtension_method__apply_force: + +- void **_apply_force** **(** :ref:`Vector2` force, :ref:`Vector2` position **)** |virtual| + +---- + +.. _class_PhysicsDirectBodyState2DExtension_method__apply_impulse: + +- void **_apply_impulse** **(** :ref:`Vector2` impulse, :ref:`Vector2` position **)** |virtual| + +---- + +.. _class_PhysicsDirectBodyState2DExtension_method__apply_torque: + +- void **_apply_torque** **(** :ref:`float` torque **)** |virtual| + +---- + +.. _class_PhysicsDirectBodyState2DExtension_method__apply_torque_impulse: + +- void **_apply_torque_impulse** **(** :ref:`float` impulse **)** |virtual| + +---- + +.. _class_PhysicsDirectBodyState2DExtension_method__get_angular_velocity: + +- :ref:`float` **_get_angular_velocity** **(** **)** |virtual| |const| + +---- + +.. _class_PhysicsDirectBodyState2DExtension_method__get_center_of_mass: + +- :ref:`Vector2` **_get_center_of_mass** **(** **)** |virtual| |const| + +---- + +.. _class_PhysicsDirectBodyState2DExtension_method__get_center_of_mass_local: + +- :ref:`Vector2` **_get_center_of_mass_local** **(** **)** |virtual| |const| + +---- + +.. _class_PhysicsDirectBodyState2DExtension_method__get_constant_force: + +- :ref:`Vector2` **_get_constant_force** **(** **)** |virtual| |const| + +---- + +.. _class_PhysicsDirectBodyState2DExtension_method__get_constant_torque: + +- :ref:`float` **_get_constant_torque** **(** **)** |virtual| |const| + +---- + +.. _class_PhysicsDirectBodyState2DExtension_method__get_contact_collider: + +- :ref:`RID` **_get_contact_collider** **(** :ref:`int` contact_idx **)** |virtual| |const| + +---- + +.. _class_PhysicsDirectBodyState2DExtension_method__get_contact_collider_id: + +- :ref:`int` **_get_contact_collider_id** **(** :ref:`int` contact_idx **)** |virtual| |const| + +---- + +.. _class_PhysicsDirectBodyState2DExtension_method__get_contact_collider_object: + +- :ref:`Object` **_get_contact_collider_object** **(** :ref:`int` contact_idx **)** |virtual| |const| + +---- + +.. _class_PhysicsDirectBodyState2DExtension_method__get_contact_collider_position: + +- :ref:`Vector2` **_get_contact_collider_position** **(** :ref:`int` contact_idx **)** |virtual| |const| + +---- + +.. _class_PhysicsDirectBodyState2DExtension_method__get_contact_collider_shape: + +- :ref:`int` **_get_contact_collider_shape** **(** :ref:`int` contact_idx **)** |virtual| |const| + +---- + +.. _class_PhysicsDirectBodyState2DExtension_method__get_contact_collider_velocity_at_position: + +- :ref:`Vector2` **_get_contact_collider_velocity_at_position** **(** :ref:`int` contact_idx **)** |virtual| |const| + +---- + +.. _class_PhysicsDirectBodyState2DExtension_method__get_contact_count: + +- :ref:`int` **_get_contact_count** **(** **)** |virtual| |const| + +---- + +.. _class_PhysicsDirectBodyState2DExtension_method__get_contact_local_normal: + +- :ref:`Vector2` **_get_contact_local_normal** **(** :ref:`int` contact_idx **)** |virtual| |const| + +---- + +.. _class_PhysicsDirectBodyState2DExtension_method__get_contact_local_position: + +- :ref:`Vector2` **_get_contact_local_position** **(** :ref:`int` contact_idx **)** |virtual| |const| + +---- + +.. _class_PhysicsDirectBodyState2DExtension_method__get_contact_local_shape: + +- :ref:`int` **_get_contact_local_shape** **(** :ref:`int` contact_idx **)** |virtual| |const| + +---- + +.. _class_PhysicsDirectBodyState2DExtension_method__get_inverse_inertia: + +- :ref:`float` **_get_inverse_inertia** **(** **)** |virtual| |const| + +---- + +.. _class_PhysicsDirectBodyState2DExtension_method__get_inverse_mass: + +- :ref:`float` **_get_inverse_mass** **(** **)** |virtual| |const| + +---- + +.. _class_PhysicsDirectBodyState2DExtension_method__get_linear_velocity: + +- :ref:`Vector2` **_get_linear_velocity** **(** **)** |virtual| |const| + +---- + +.. _class_PhysicsDirectBodyState2DExtension_method__get_space_state: + +- :ref:`PhysicsDirectSpaceState2D` **_get_space_state** **(** **)** |virtual| + +---- + +.. _class_PhysicsDirectBodyState2DExtension_method__get_step: + +- :ref:`float` **_get_step** **(** **)** |virtual| |const| + +---- + +.. _class_PhysicsDirectBodyState2DExtension_method__get_total_angular_damp: + +- :ref:`float` **_get_total_angular_damp** **(** **)** |virtual| |const| + +---- + +.. _class_PhysicsDirectBodyState2DExtension_method__get_total_gravity: + +- :ref:`Vector2` **_get_total_gravity** **(** **)** |virtual| |const| + +---- + +.. _class_PhysicsDirectBodyState2DExtension_method__get_total_linear_damp: + +- :ref:`float` **_get_total_linear_damp** **(** **)** |virtual| |const| + +---- + +.. _class_PhysicsDirectBodyState2DExtension_method__get_transform: + +- :ref:`Transform2D` **_get_transform** **(** **)** |virtual| |const| + +---- + +.. _class_PhysicsDirectBodyState2DExtension_method__get_velocity_at_local_position: + +- :ref:`Vector2` **_get_velocity_at_local_position** **(** :ref:`Vector2` local_position **)** |virtual| |const| + +---- + +.. _class_PhysicsDirectBodyState2DExtension_method__integrate_forces: + +- void **_integrate_forces** **(** **)** |virtual| + +---- + +.. _class_PhysicsDirectBodyState2DExtension_method__is_sleeping: + +- :ref:`bool` **_is_sleeping** **(** **)** |virtual| |const| + +---- + +.. _class_PhysicsDirectBodyState2DExtension_method__set_angular_velocity: + +- void **_set_angular_velocity** **(** :ref:`float` velocity **)** |virtual| + +---- + +.. _class_PhysicsDirectBodyState2DExtension_method__set_constant_force: + +- void **_set_constant_force** **(** :ref:`Vector2` force **)** |virtual| + +---- + +.. _class_PhysicsDirectBodyState2DExtension_method__set_constant_torque: + +- void **_set_constant_torque** **(** :ref:`float` torque **)** |virtual| + +---- + +.. _class_PhysicsDirectBodyState2DExtension_method__set_linear_velocity: + +- void **_set_linear_velocity** **(** :ref:`Vector2` velocity **)** |virtual| + +---- + +.. _class_PhysicsDirectBodyState2DExtension_method__set_sleep_state: + +- void **_set_sleep_state** **(** :ref:`bool` enabled **)** |virtual| + +---- + +.. _class_PhysicsDirectBodyState2DExtension_method__set_transform: + +- void **_set_transform** **(** :ref:`Transform2D` transform **)** |virtual| + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` diff --git a/classes/class_physicsdirectspacestate2d.rst b/classes/class_physicsdirectspacestate2d.rst index f2a427d8b..2b948dff0 100644 --- a/classes/class_physicsdirectspacestate2d.rst +++ b/classes/class_physicsdirectspacestate2d.rst @@ -12,6 +12,8 @@ PhysicsDirectSpaceState2D **Inherits:** :ref:`Object` +**Inherited By:** :ref:`PhysicsDirectSpaceState2DExtension` + Direct access object to a space in the :ref:`PhysicsServer2D`. Description diff --git a/classes/class_physicsdirectspacestate2dextension.rst b/classes/class_physicsdirectspacestate2dextension.rst new file mode 100644 index 000000000..17024292a --- /dev/null +++ b/classes/class_physicsdirectspacestate2dextension.rst @@ -0,0 +1,76 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsDirectSpaceState2DExtension.xml. + +.. _class_PhysicsDirectSpaceState2DExtension: + +PhysicsDirectSpaceState2DExtension +================================== + +**Inherits:** :ref:`PhysicsDirectSpaceState2D` **<** :ref:`Object` + + + +Methods +------- + ++-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`_cast_motion` **(** :ref:`RID` shape_rid, :ref:`Transform2D` transform, :ref:`Vector2` motion, :ref:`float` margin, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, float* closest_safe, float* closest_unsafe **)** |virtual| | ++-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`_collide_shape` **(** :ref:`RID` shape_rid, :ref:`Transform2D` transform, :ref:`Vector2` motion, :ref:`float` margin, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, void* results, :ref:`int` max_results, int32_t* result_count **)** |virtual| | ++-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_intersect_point` **(** :ref:`Vector2` position, :ref:`int` canvas_instance_id, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, PhysicsServer2DExtensionShapeResult* results, :ref:`int` max_results **)** |virtual| | ++-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`_intersect_ray` **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, :ref:`bool` hit_from_inside, PhysicsServer2DExtensionRayResult* result **)** |virtual| | ++-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_intersect_shape` **(** :ref:`RID` shape_rid, :ref:`Transform2D` transform, :ref:`Vector2` motion, :ref:`float` margin, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, PhysicsServer2DExtensionShapeResult* result, :ref:`int` max_results **)** |virtual| | ++-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`_rest_info` **(** :ref:`RID` shape_rid, :ref:`Transform2D` transform, :ref:`Vector2` motion, :ref:`float` margin, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, PhysicsServer2DExtensionShapeRestInfo* rest_info **)** |virtual| | ++-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Method Descriptions +------------------- + +.. _class_PhysicsDirectSpaceState2DExtension_method__cast_motion: + +- :ref:`bool` **_cast_motion** **(** :ref:`RID` shape_rid, :ref:`Transform2D` transform, :ref:`Vector2` motion, :ref:`float` margin, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, float* closest_safe, float* closest_unsafe **)** |virtual| + +---- + +.. _class_PhysicsDirectSpaceState2DExtension_method__collide_shape: + +- :ref:`bool` **_collide_shape** **(** :ref:`RID` shape_rid, :ref:`Transform2D` transform, :ref:`Vector2` motion, :ref:`float` margin, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, void* results, :ref:`int` max_results, int32_t* result_count **)** |virtual| + +---- + +.. _class_PhysicsDirectSpaceState2DExtension_method__intersect_point: + +- :ref:`int` **_intersect_point** **(** :ref:`Vector2` position, :ref:`int` canvas_instance_id, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, PhysicsServer2DExtensionShapeResult* results, :ref:`int` max_results **)** |virtual| + +---- + +.. _class_PhysicsDirectSpaceState2DExtension_method__intersect_ray: + +- :ref:`bool` **_intersect_ray** **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, :ref:`bool` hit_from_inside, PhysicsServer2DExtensionRayResult* result **)** |virtual| + +---- + +.. _class_PhysicsDirectSpaceState2DExtension_method__intersect_shape: + +- :ref:`int` **_intersect_shape** **(** :ref:`RID` shape_rid, :ref:`Transform2D` transform, :ref:`Vector2` motion, :ref:`float` margin, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, PhysicsServer2DExtensionShapeResult* result, :ref:`int` max_results **)** |virtual| + +---- + +.. _class_PhysicsDirectSpaceState2DExtension_method__rest_info: + +- :ref:`bool` **_rest_info** **(** :ref:`RID` shape_rid, :ref:`Transform2D` transform, :ref:`Vector2` motion, :ref:`float` margin, :ref:`int` collision_mask, :ref:`bool` collide_with_bodies, :ref:`bool` collide_with_areas, PhysicsServer2DExtensionShapeRestInfo* rest_info **)** |virtual| + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` diff --git a/classes/class_physicspointqueryparameters2d.rst b/classes/class_physicspointqueryparameters2d.rst index 9a004ae26..671a978d2 100644 --- a/classes/class_physicspointqueryparameters2d.rst +++ b/classes/class_physicspointqueryparameters2d.rst @@ -31,7 +31,7 @@ Properties +-------------------------------+----------------------------------------------------------------------------------------------+-------------------+ | :ref:`int` | :ref:`collision_mask` | ``4294967295`` | +-------------------------------+----------------------------------------------------------------------------------------------+-------------------+ -| :ref:`Array` | :ref:`exclude` | ``[]`` | +| :ref:`RID[]` | :ref:`exclude` | ``[]`` | +-------------------------------+----------------------------------------------------------------------------------------------+-------------------+ | :ref:`Vector2` | :ref:`position` | ``Vector2(0, 0)`` | +-------------------------------+----------------------------------------------------------------------------------------------+-------------------+ @@ -105,7 +105,7 @@ The physics layers the query will detect (as a bitmask). By default, all collisi .. _class_PhysicsPointQueryParameters2D_property_exclude: -- :ref:`Array` **exclude** +- :ref:`RID[]` **exclude** +-----------+--------------------+ | *Default* | ``[]`` | diff --git a/classes/class_physicsrayqueryparameters2d.rst b/classes/class_physicsrayqueryparameters2d.rst index 6d316b05d..08b5c6454 100644 --- a/classes/class_physicsrayqueryparameters2d.rst +++ b/classes/class_physicsrayqueryparameters2d.rst @@ -29,7 +29,7 @@ Properties +-------------------------------+--------------------------------------------------------------------------------------------+-------------------+ | :ref:`int` | :ref:`collision_mask` | ``4294967295`` | +-------------------------------+--------------------------------------------------------------------------------------------+-------------------+ -| :ref:`Array` | :ref:`exclude` | ``[]`` | +| :ref:`RID[]` | :ref:`exclude` | ``[]`` | +-------------------------------+--------------------------------------------------------------------------------------------+-------------------+ | :ref:`Vector2` | :ref:`from` | ``Vector2(0, 0)`` | +-------------------------------+--------------------------------------------------------------------------------------------+-------------------+ @@ -41,9 +41,9 @@ Properties Methods ------- -+-----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PhysicsRayQueryParameters2D` | :ref:`create` **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`int` collision_mask=4294967295, :ref:`Array` exclude=[] **)** |static| | -+-----------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PhysicsRayQueryParameters2D` | :ref:`create` **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`int` collision_mask=4294967295, :ref:`RID[]` exclude=[] **)** |static| | ++-----------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- @@ -98,7 +98,7 @@ The physics layers the query will detect (as a bitmask). By default, all collisi .. _class_PhysicsRayQueryParameters2D_property_exclude: -- :ref:`Array` **exclude** +- :ref:`RID[]` **exclude** +-----------+--------------------+ | *Default* | ``[]`` | @@ -163,7 +163,7 @@ Method Descriptions .. _class_PhysicsRayQueryParameters2D_method_create: -- :ref:`PhysicsRayQueryParameters2D` **create** **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`int` collision_mask=4294967295, :ref:`Array` exclude=[] **)** |static| +- :ref:`PhysicsRayQueryParameters2D` **create** **(** :ref:`Vector2` from, :ref:`Vector2` to, :ref:`int` collision_mask=4294967295, :ref:`RID[]` exclude=[] **)** |static| Returns a new, pre-configured ``PhysicsRayQueryParameters2D`` object. Use it to quickly create query parameters using the most common options. diff --git a/classes/class_physicsserver2d.rst b/classes/class_physicsserver2d.rst index e1136ee1d..ba0c945f2 100644 --- a/classes/class_physicsserver2d.rst +++ b/classes/class_physicsserver2d.rst @@ -12,6 +12,8 @@ PhysicsServer2D **Inherits:** :ref:`Object` +**Inherited By:** :ref:`PhysicsServer2DExtension` + Server interface for low-level 2D physics access. Description @@ -559,6 +561,16 @@ enum **JointParam**: ---- +.. _enum_PhysicsServer2D_PinJointParam: + +.. _class_PhysicsServer2D_constant_PIN_JOINT_SOFTNESS: + +enum **PinJointParam**: + +- **PIN_JOINT_SOFTNESS** = **0** + +---- + .. _enum_PhysicsServer2D_DampedSpringParam: .. _class_PhysicsServer2D_constant_DAMPED_SPRING_REST_LENGTH: diff --git a/classes/class_physicsserver2dextension.rst b/classes/class_physicsserver2dextension.rst new file mode 100644 index 000000000..5d65dcc0c --- /dev/null +++ b/classes/class_physicsserver2dextension.rst @@ -0,0 +1,980 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsServer2DExtension.xml. + +.. _class_PhysicsServer2DExtension: + +PhysicsServer2DExtension +======================== + +**Inherits:** :ref:`PhysicsServer2D` **<** :ref:`Object` + + + +Methods +------- + ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_area_add_shape` **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform2D` transform, :ref:`bool` disabled **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_area_attach_canvas_instance_id` **(** :ref:`RID` area, :ref:`int` id **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_area_attach_object_instance_id` **(** :ref:`RID` area, :ref:`int` id **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_area_clear_shapes` **(** :ref:`RID` area **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`_area_create` **(** **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_area_get_canvas_instance_id` **(** :ref:`RID` area **)** |virtual| |const| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_area_get_object_instance_id` **(** :ref:`RID` area **)** |virtual| |const| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`_area_get_param` **(** :ref:`RID` area, :ref:`AreaParameter` param **)** |virtual| |const| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`_area_get_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** |virtual| |const| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_area_get_shape_count` **(** :ref:`RID` area **)** |virtual| |const| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`_area_get_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx **)** |virtual| |const| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`_area_get_space` **(** :ref:`RID` area **)** |virtual| |const| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`_area_get_transform` **(** :ref:`RID` area **)** |virtual| |const| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_area_remove_shape` **(** :ref:`RID` area, :ref:`int` shape_idx **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_area_set_area_monitor_callback` **(** :ref:`RID` area, :ref:`Callable` callback **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_area_set_collision_layer` **(** :ref:`RID` area, :ref:`int` layer **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_area_set_collision_mask` **(** :ref:`RID` area, :ref:`int` mask **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_area_set_monitor_callback` **(** :ref:`RID` area, :ref:`Callable` callback **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_area_set_monitorable` **(** :ref:`RID` area, :ref:`bool` monitorable **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_area_set_param` **(** :ref:`RID` area, :ref:`AreaParameter` param, :ref:`Variant` value **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_area_set_shape` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`RID` shape **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_area_set_shape_disabled` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`bool` disabled **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_area_set_shape_transform` **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`Transform2D` transform **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_area_set_space` **(** :ref:`RID` area, :ref:`RID` space **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_area_set_transform` **(** :ref:`RID` area, :ref:`Transform2D` transform **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_body_add_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_body_add_constant_central_force` **(** :ref:`RID` body, :ref:`Vector2` force **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_body_add_constant_force` **(** :ref:`RID` body, :ref:`Vector2` force, :ref:`Vector2` position **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_body_add_constant_torque` **(** :ref:`RID` body, :ref:`float` torque **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_body_add_shape` **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform2D` transform, :ref:`bool` disabled **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_body_apply_central_force` **(** :ref:`RID` body, :ref:`Vector2` force **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_body_apply_central_impulse` **(** :ref:`RID` body, :ref:`Vector2` impulse **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_body_apply_force` **(** :ref:`RID` body, :ref:`Vector2` force, :ref:`Vector2` position **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_body_apply_impulse` **(** :ref:`RID` body, :ref:`Vector2` impulse, :ref:`Vector2` position **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_body_apply_torque` **(** :ref:`RID` body, :ref:`float` torque **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_body_apply_torque_impulse` **(** :ref:`RID` body, :ref:`float` impulse **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_body_attach_canvas_instance_id` **(** :ref:`RID` body, :ref:`int` id **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_body_attach_object_instance_id` **(** :ref:`RID` body, :ref:`int` id **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_body_clear_shapes` **(** :ref:`RID` body **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`_body_create` **(** **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_body_get_canvas_instance_id` **(** :ref:`RID` body **)** |virtual| |const| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_body_get_collision_layer` **(** :ref:`RID` body **)** |virtual| |const| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_body_get_collision_mask` **(** :ref:`RID` body **)** |virtual| |const| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`_body_get_collision_priority` **(** :ref:`RID` body **)** |virtual| |const| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`_body_get_constant_force` **(** :ref:`RID` body **)** |virtual| |const| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`_body_get_constant_torque` **(** :ref:`RID` body **)** |virtual| |const| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`CCDMode` | :ref:`_body_get_continuous_collision_detection_mode` **(** :ref:`RID` body **)** |virtual| |const| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PhysicsDirectBodyState2D` | :ref:`_body_get_direct_state` **(** :ref:`RID` body **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_body_get_max_contacts_reported` **(** :ref:`RID` body **)** |virtual| |const| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`BodyMode` | :ref:`_body_get_mode` **(** :ref:`RID` body **)** |virtual| |const| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_body_get_object_instance_id` **(** :ref:`RID` body **)** |virtual| |const| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`_body_get_param` **(** :ref:`RID` body, :ref:`BodyParameter` param **)** |virtual| |const| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`_body_get_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** |virtual| |const| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_body_get_shape_count` **(** :ref:`RID` body **)** |virtual| |const| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`_body_get_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx **)** |virtual| |const| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`_body_get_space` **(** :ref:`RID` body **)** |virtual| |const| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`_body_get_state` **(** :ref:`RID` body, :ref:`BodyState` state **)** |virtual| |const| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`_body_is_omitting_force_integration` **(** :ref:`RID` body **)** |virtual| |const| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_body_remove_collision_exception` **(** :ref:`RID` body, :ref:`RID` excepted_body **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_body_remove_shape` **(** :ref:`RID` body, :ref:`int` shape_idx **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_body_reset_mass_properties` **(** :ref:`RID` body **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_body_set_axis_velocity` **(** :ref:`RID` body, :ref:`Vector2` axis_velocity **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_body_set_collision_layer` **(** :ref:`RID` body, :ref:`int` layer **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_body_set_collision_mask` **(** :ref:`RID` body, :ref:`int` mask **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_body_set_collision_priority` **(** :ref:`RID` body, :ref:`float` priority **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_body_set_constant_force` **(** :ref:`RID` body, :ref:`Vector2` force **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_body_set_constant_torque` **(** :ref:`RID` body, :ref:`float` torque **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_body_set_continuous_collision_detection_mode` **(** :ref:`RID` body, :ref:`CCDMode` mode **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_body_set_force_integration_callback` **(** :ref:`RID` body, :ref:`Callable` callable, :ref:`Variant` userdata **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_body_set_max_contacts_reported` **(** :ref:`RID` body, :ref:`int` amount **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_body_set_mode` **(** :ref:`RID` body, :ref:`BodyMode` mode **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_body_set_omit_force_integration` **(** :ref:`RID` body, :ref:`bool` enable **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_body_set_param` **(** :ref:`RID` body, :ref:`BodyParameter` param, :ref:`Variant` value **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_body_set_shape` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`RID` shape **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_body_set_shape_as_one_way_collision` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` enable, :ref:`float` margin **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_body_set_shape_disabled` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` disabled **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_body_set_shape_transform` **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Transform2D` transform **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_body_set_space` **(** :ref:`RID` body, :ref:`RID` space **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_body_set_state` **(** :ref:`RID` body, :ref:`BodyState` state, :ref:`Variant` value **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`_body_test_motion` **(** :ref:`RID` body, :ref:`Transform2D` from, :ref:`Vector2` motion, :ref:`float` margin, :ref:`bool` collide_separation_ray, :ref:`bool` recovery_as_collision, PhysicsServer2DExtensionMotionResult* result **)** |virtual| |const| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`_capsule_shape_create` **(** **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`_circle_shape_create` **(** **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`_concave_polygon_shape_create` **(** **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`_convex_polygon_shape_create` **(** **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`_damped_spring_joint_get_param` **(** :ref:`RID` joint, :ref:`DampedSpringParam` param **)** |virtual| |const| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_damped_spring_joint_set_param` **(** :ref:`RID` joint, :ref:`DampedSpringParam` param, :ref:`float` value **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_end_sync` **(** **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_finish` **(** **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_flush_queries` **(** **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_free_rid` **(** :ref:`RID` rid **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_process_info` **(** :ref:`ProcessInfo` process_info **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_init` **(** **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`_is_flushing_queries` **(** **)** |virtual| |const| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_joint_clear` **(** :ref:`RID` joint **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`_joint_create` **(** **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`_joint_get_param` **(** :ref:`RID` joint, :ref:`JointParam` param **)** |virtual| |const| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`JointType` | :ref:`_joint_get_type` **(** :ref:`RID` joint **)** |virtual| |const| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_joint_make_damped_spring` **(** :ref:`RID` joint, :ref:`Vector2` anchor_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a, :ref:`RID` body_b **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_joint_make_groove` **(** :ref:`RID` joint, :ref:`Vector2` a_groove1, :ref:`Vector2` a_groove2, :ref:`Vector2` b_anchor, :ref:`RID` body_a, :ref:`RID` body_b **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_joint_make_pin` **(** :ref:`RID` joint, :ref:`Vector2` anchor, :ref:`RID` body_a, :ref:`RID` body_b **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_joint_set_param` **(** :ref:`RID` joint, :ref:`JointParam` param, :ref:`float` value **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`_pin_joint_get_param` **(** :ref:`RID` joint, :ref:`PinJointParam` param **)** |virtual| |const| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_pin_joint_set_param` **(** :ref:`RID` joint, :ref:`PinJointParam` param, :ref:`float` value **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`_rectangle_shape_create` **(** **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`_segment_shape_create` **(** **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`_separation_ray_shape_create` **(** **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_set_active` **(** :ref:`bool` active **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`_shape_get_data` **(** :ref:`RID` shape **)** |virtual| |const| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ShapeType` | :ref:`_shape_get_type` **(** :ref:`RID` shape **)** |virtual| |const| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_shape_set_data` **(** :ref:`RID` shape, :ref:`Variant` data **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`_space_create` **(** **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PhysicsDirectSpaceState2D` | :ref:`_space_get_direct_state` **(** :ref:`RID` space **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`_space_get_param` **(** :ref:`RID` space, :ref:`SpaceParameter` param **)** |virtual| |const| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`_space_is_active` **(** :ref:`RID` space **)** |virtual| |const| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_space_set_active` **(** :ref:`RID` space, :ref:`bool` active **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_space_set_param` **(** :ref:`RID` space, :ref:`SpaceParameter` param, :ref:`float` value **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_step` **(** :ref:`float` step **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_sync` **(** **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`_world_boundary_shape_create` **(** **)** |virtual| | ++-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Method Descriptions +------------------- + +.. _class_PhysicsServer2DExtension_method__area_add_shape: + +- void **_area_add_shape** **(** :ref:`RID` area, :ref:`RID` shape, :ref:`Transform2D` transform, :ref:`bool` disabled **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__area_attach_canvas_instance_id: + +- void **_area_attach_canvas_instance_id** **(** :ref:`RID` area, :ref:`int` id **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__area_attach_object_instance_id: + +- void **_area_attach_object_instance_id** **(** :ref:`RID` area, :ref:`int` id **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__area_clear_shapes: + +- void **_area_clear_shapes** **(** :ref:`RID` area **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__area_create: + +- :ref:`RID` **_area_create** **(** **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__area_get_canvas_instance_id: + +- :ref:`int` **_area_get_canvas_instance_id** **(** :ref:`RID` area **)** |virtual| |const| + +---- + +.. _class_PhysicsServer2DExtension_method__area_get_object_instance_id: + +- :ref:`int` **_area_get_object_instance_id** **(** :ref:`RID` area **)** |virtual| |const| + +---- + +.. _class_PhysicsServer2DExtension_method__area_get_param: + +- :ref:`Variant` **_area_get_param** **(** :ref:`RID` area, :ref:`AreaParameter` param **)** |virtual| |const| + +---- + +.. _class_PhysicsServer2DExtension_method__area_get_shape: + +- :ref:`RID` **_area_get_shape** **(** :ref:`RID` area, :ref:`int` shape_idx **)** |virtual| |const| + +---- + +.. _class_PhysicsServer2DExtension_method__area_get_shape_count: + +- :ref:`int` **_area_get_shape_count** **(** :ref:`RID` area **)** |virtual| |const| + +---- + +.. _class_PhysicsServer2DExtension_method__area_get_shape_transform: + +- :ref:`Transform2D` **_area_get_shape_transform** **(** :ref:`RID` area, :ref:`int` shape_idx **)** |virtual| |const| + +---- + +.. _class_PhysicsServer2DExtension_method__area_get_space: + +- :ref:`RID` **_area_get_space** **(** :ref:`RID` area **)** |virtual| |const| + +---- + +.. _class_PhysicsServer2DExtension_method__area_get_transform: + +- :ref:`Transform2D` **_area_get_transform** **(** :ref:`RID` area **)** |virtual| |const| + +---- + +.. _class_PhysicsServer2DExtension_method__area_remove_shape: + +- void **_area_remove_shape** **(** :ref:`RID` area, :ref:`int` shape_idx **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__area_set_area_monitor_callback: + +- void **_area_set_area_monitor_callback** **(** :ref:`RID` area, :ref:`Callable` callback **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__area_set_collision_layer: + +- void **_area_set_collision_layer** **(** :ref:`RID` area, :ref:`int` layer **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__area_set_collision_mask: + +- void **_area_set_collision_mask** **(** :ref:`RID` area, :ref:`int` mask **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__area_set_monitor_callback: + +- void **_area_set_monitor_callback** **(** :ref:`RID` area, :ref:`Callable` callback **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__area_set_monitorable: + +- void **_area_set_monitorable** **(** :ref:`RID` area, :ref:`bool` monitorable **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__area_set_param: + +- void **_area_set_param** **(** :ref:`RID` area, :ref:`AreaParameter` param, :ref:`Variant` value **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__area_set_shape: + +- void **_area_set_shape** **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`RID` shape **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__area_set_shape_disabled: + +- void **_area_set_shape_disabled** **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`bool` disabled **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__area_set_shape_transform: + +- void **_area_set_shape_transform** **(** :ref:`RID` area, :ref:`int` shape_idx, :ref:`Transform2D` transform **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__area_set_space: + +- void **_area_set_space** **(** :ref:`RID` area, :ref:`RID` space **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__area_set_transform: + +- void **_area_set_transform** **(** :ref:`RID` area, :ref:`Transform2D` transform **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__body_add_collision_exception: + +- void **_body_add_collision_exception** **(** :ref:`RID` body, :ref:`RID` excepted_body **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__body_add_constant_central_force: + +- void **_body_add_constant_central_force** **(** :ref:`RID` body, :ref:`Vector2` force **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__body_add_constant_force: + +- void **_body_add_constant_force** **(** :ref:`RID` body, :ref:`Vector2` force, :ref:`Vector2` position **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__body_add_constant_torque: + +- void **_body_add_constant_torque** **(** :ref:`RID` body, :ref:`float` torque **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__body_add_shape: + +- void **_body_add_shape** **(** :ref:`RID` body, :ref:`RID` shape, :ref:`Transform2D` transform, :ref:`bool` disabled **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__body_apply_central_force: + +- void **_body_apply_central_force** **(** :ref:`RID` body, :ref:`Vector2` force **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__body_apply_central_impulse: + +- void **_body_apply_central_impulse** **(** :ref:`RID` body, :ref:`Vector2` impulse **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__body_apply_force: + +- void **_body_apply_force** **(** :ref:`RID` body, :ref:`Vector2` force, :ref:`Vector2` position **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__body_apply_impulse: + +- void **_body_apply_impulse** **(** :ref:`RID` body, :ref:`Vector2` impulse, :ref:`Vector2` position **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__body_apply_torque: + +- void **_body_apply_torque** **(** :ref:`RID` body, :ref:`float` torque **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__body_apply_torque_impulse: + +- void **_body_apply_torque_impulse** **(** :ref:`RID` body, :ref:`float` impulse **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__body_attach_canvas_instance_id: + +- void **_body_attach_canvas_instance_id** **(** :ref:`RID` body, :ref:`int` id **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__body_attach_object_instance_id: + +- void **_body_attach_object_instance_id** **(** :ref:`RID` body, :ref:`int` id **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__body_clear_shapes: + +- void **_body_clear_shapes** **(** :ref:`RID` body **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__body_create: + +- :ref:`RID` **_body_create** **(** **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__body_get_canvas_instance_id: + +- :ref:`int` **_body_get_canvas_instance_id** **(** :ref:`RID` body **)** |virtual| |const| + +---- + +.. _class_PhysicsServer2DExtension_method__body_get_collision_layer: + +- :ref:`int` **_body_get_collision_layer** **(** :ref:`RID` body **)** |virtual| |const| + +---- + +.. _class_PhysicsServer2DExtension_method__body_get_collision_mask: + +- :ref:`int` **_body_get_collision_mask** **(** :ref:`RID` body **)** |virtual| |const| + +---- + +.. _class_PhysicsServer2DExtension_method__body_get_collision_priority: + +- :ref:`float` **_body_get_collision_priority** **(** :ref:`RID` body **)** |virtual| |const| + +---- + +.. _class_PhysicsServer2DExtension_method__body_get_constant_force: + +- :ref:`Vector2` **_body_get_constant_force** **(** :ref:`RID` body **)** |virtual| |const| + +---- + +.. _class_PhysicsServer2DExtension_method__body_get_constant_torque: + +- :ref:`float` **_body_get_constant_torque** **(** :ref:`RID` body **)** |virtual| |const| + +---- + +.. _class_PhysicsServer2DExtension_method__body_get_continuous_collision_detection_mode: + +- :ref:`CCDMode` **_body_get_continuous_collision_detection_mode** **(** :ref:`RID` body **)** |virtual| |const| + +---- + +.. _class_PhysicsServer2DExtension_method__body_get_direct_state: + +- :ref:`PhysicsDirectBodyState2D` **_body_get_direct_state** **(** :ref:`RID` body **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__body_get_max_contacts_reported: + +- :ref:`int` **_body_get_max_contacts_reported** **(** :ref:`RID` body **)** |virtual| |const| + +---- + +.. _class_PhysicsServer2DExtension_method__body_get_mode: + +- :ref:`BodyMode` **_body_get_mode** **(** :ref:`RID` body **)** |virtual| |const| + +---- + +.. _class_PhysicsServer2DExtension_method__body_get_object_instance_id: + +- :ref:`int` **_body_get_object_instance_id** **(** :ref:`RID` body **)** |virtual| |const| + +---- + +.. _class_PhysicsServer2DExtension_method__body_get_param: + +- :ref:`Variant` **_body_get_param** **(** :ref:`RID` body, :ref:`BodyParameter` param **)** |virtual| |const| + +---- + +.. _class_PhysicsServer2DExtension_method__body_get_shape: + +- :ref:`RID` **_body_get_shape** **(** :ref:`RID` body, :ref:`int` shape_idx **)** |virtual| |const| + +---- + +.. _class_PhysicsServer2DExtension_method__body_get_shape_count: + +- :ref:`int` **_body_get_shape_count** **(** :ref:`RID` body **)** |virtual| |const| + +---- + +.. _class_PhysicsServer2DExtension_method__body_get_shape_transform: + +- :ref:`Transform2D` **_body_get_shape_transform** **(** :ref:`RID` body, :ref:`int` shape_idx **)** |virtual| |const| + +---- + +.. _class_PhysicsServer2DExtension_method__body_get_space: + +- :ref:`RID` **_body_get_space** **(** :ref:`RID` body **)** |virtual| |const| + +---- + +.. _class_PhysicsServer2DExtension_method__body_get_state: + +- :ref:`Variant` **_body_get_state** **(** :ref:`RID` body, :ref:`BodyState` state **)** |virtual| |const| + +---- + +.. _class_PhysicsServer2DExtension_method__body_is_omitting_force_integration: + +- :ref:`bool` **_body_is_omitting_force_integration** **(** :ref:`RID` body **)** |virtual| |const| + +---- + +.. _class_PhysicsServer2DExtension_method__body_remove_collision_exception: + +- void **_body_remove_collision_exception** **(** :ref:`RID` body, :ref:`RID` excepted_body **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__body_remove_shape: + +- void **_body_remove_shape** **(** :ref:`RID` body, :ref:`int` shape_idx **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__body_reset_mass_properties: + +- void **_body_reset_mass_properties** **(** :ref:`RID` body **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__body_set_axis_velocity: + +- void **_body_set_axis_velocity** **(** :ref:`RID` body, :ref:`Vector2` axis_velocity **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__body_set_collision_layer: + +- void **_body_set_collision_layer** **(** :ref:`RID` body, :ref:`int` layer **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__body_set_collision_mask: + +- void **_body_set_collision_mask** **(** :ref:`RID` body, :ref:`int` mask **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__body_set_collision_priority: + +- void **_body_set_collision_priority** **(** :ref:`RID` body, :ref:`float` priority **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__body_set_constant_force: + +- void **_body_set_constant_force** **(** :ref:`RID` body, :ref:`Vector2` force **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__body_set_constant_torque: + +- void **_body_set_constant_torque** **(** :ref:`RID` body, :ref:`float` torque **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__body_set_continuous_collision_detection_mode: + +- void **_body_set_continuous_collision_detection_mode** **(** :ref:`RID` body, :ref:`CCDMode` mode **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__body_set_force_integration_callback: + +- void **_body_set_force_integration_callback** **(** :ref:`RID` body, :ref:`Callable` callable, :ref:`Variant` userdata **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__body_set_max_contacts_reported: + +- void **_body_set_max_contacts_reported** **(** :ref:`RID` body, :ref:`int` amount **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__body_set_mode: + +- void **_body_set_mode** **(** :ref:`RID` body, :ref:`BodyMode` mode **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__body_set_omit_force_integration: + +- void **_body_set_omit_force_integration** **(** :ref:`RID` body, :ref:`bool` enable **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__body_set_param: + +- void **_body_set_param** **(** :ref:`RID` body, :ref:`BodyParameter` param, :ref:`Variant` value **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__body_set_shape: + +- void **_body_set_shape** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`RID` shape **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__body_set_shape_as_one_way_collision: + +- void **_body_set_shape_as_one_way_collision** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` enable, :ref:`float` margin **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__body_set_shape_disabled: + +- void **_body_set_shape_disabled** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`bool` disabled **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__body_set_shape_transform: + +- void **_body_set_shape_transform** **(** :ref:`RID` body, :ref:`int` shape_idx, :ref:`Transform2D` transform **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__body_set_space: + +- void **_body_set_space** **(** :ref:`RID` body, :ref:`RID` space **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__body_set_state: + +- void **_body_set_state** **(** :ref:`RID` body, :ref:`BodyState` state, :ref:`Variant` value **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__body_test_motion: + +- :ref:`bool` **_body_test_motion** **(** :ref:`RID` body, :ref:`Transform2D` from, :ref:`Vector2` motion, :ref:`float` margin, :ref:`bool` collide_separation_ray, :ref:`bool` recovery_as_collision, PhysicsServer2DExtensionMotionResult* result **)** |virtual| |const| + +---- + +.. _class_PhysicsServer2DExtension_method__capsule_shape_create: + +- :ref:`RID` **_capsule_shape_create** **(** **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__circle_shape_create: + +- :ref:`RID` **_circle_shape_create** **(** **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__concave_polygon_shape_create: + +- :ref:`RID` **_concave_polygon_shape_create** **(** **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__convex_polygon_shape_create: + +- :ref:`RID` **_convex_polygon_shape_create** **(** **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__damped_spring_joint_get_param: + +- :ref:`float` **_damped_spring_joint_get_param** **(** :ref:`RID` joint, :ref:`DampedSpringParam` param **)** |virtual| |const| + +---- + +.. _class_PhysicsServer2DExtension_method__damped_spring_joint_set_param: + +- void **_damped_spring_joint_set_param** **(** :ref:`RID` joint, :ref:`DampedSpringParam` param, :ref:`float` value **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__end_sync: + +- void **_end_sync** **(** **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__finish: + +- void **_finish** **(** **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__flush_queries: + +- void **_flush_queries** **(** **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__free_rid: + +- void **_free_rid** **(** :ref:`RID` rid **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__get_process_info: + +- :ref:`int` **_get_process_info** **(** :ref:`ProcessInfo` process_info **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__init: + +- void **_init** **(** **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__is_flushing_queries: + +- :ref:`bool` **_is_flushing_queries** **(** **)** |virtual| |const| + +---- + +.. _class_PhysicsServer2DExtension_method__joint_clear: + +- void **_joint_clear** **(** :ref:`RID` joint **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__joint_create: + +- :ref:`RID` **_joint_create** **(** **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__joint_get_param: + +- :ref:`float` **_joint_get_param** **(** :ref:`RID` joint, :ref:`JointParam` param **)** |virtual| |const| + +---- + +.. _class_PhysicsServer2DExtension_method__joint_get_type: + +- :ref:`JointType` **_joint_get_type** **(** :ref:`RID` joint **)** |virtual| |const| + +---- + +.. _class_PhysicsServer2DExtension_method__joint_make_damped_spring: + +- void **_joint_make_damped_spring** **(** :ref:`RID` joint, :ref:`Vector2` anchor_a, :ref:`Vector2` anchor_b, :ref:`RID` body_a, :ref:`RID` body_b **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__joint_make_groove: + +- void **_joint_make_groove** **(** :ref:`RID` joint, :ref:`Vector2` a_groove1, :ref:`Vector2` a_groove2, :ref:`Vector2` b_anchor, :ref:`RID` body_a, :ref:`RID` body_b **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__joint_make_pin: + +- void **_joint_make_pin** **(** :ref:`RID` joint, :ref:`Vector2` anchor, :ref:`RID` body_a, :ref:`RID` body_b **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__joint_set_param: + +- void **_joint_set_param** **(** :ref:`RID` joint, :ref:`JointParam` param, :ref:`float` value **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__pin_joint_get_param: + +- :ref:`float` **_pin_joint_get_param** **(** :ref:`RID` joint, :ref:`PinJointParam` param **)** |virtual| |const| + +---- + +.. _class_PhysicsServer2DExtension_method__pin_joint_set_param: + +- void **_pin_joint_set_param** **(** :ref:`RID` joint, :ref:`PinJointParam` param, :ref:`float` value **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__rectangle_shape_create: + +- :ref:`RID` **_rectangle_shape_create** **(** **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__segment_shape_create: + +- :ref:`RID` **_segment_shape_create** **(** **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__separation_ray_shape_create: + +- :ref:`RID` **_separation_ray_shape_create** **(** **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__set_active: + +- void **_set_active** **(** :ref:`bool` active **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__shape_get_data: + +- :ref:`Variant` **_shape_get_data** **(** :ref:`RID` shape **)** |virtual| |const| + +---- + +.. _class_PhysicsServer2DExtension_method__shape_get_type: + +- :ref:`ShapeType` **_shape_get_type** **(** :ref:`RID` shape **)** |virtual| |const| + +---- + +.. _class_PhysicsServer2DExtension_method__shape_set_data: + +- void **_shape_set_data** **(** :ref:`RID` shape, :ref:`Variant` data **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__space_create: + +- :ref:`RID` **_space_create** **(** **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__space_get_direct_state: + +- :ref:`PhysicsDirectSpaceState2D` **_space_get_direct_state** **(** :ref:`RID` space **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__space_get_param: + +- :ref:`float` **_space_get_param** **(** :ref:`RID` space, :ref:`SpaceParameter` param **)** |virtual| |const| + +---- + +.. _class_PhysicsServer2DExtension_method__space_is_active: + +- :ref:`bool` **_space_is_active** **(** :ref:`RID` space **)** |virtual| |const| + +---- + +.. _class_PhysicsServer2DExtension_method__space_set_active: + +- void **_space_set_active** **(** :ref:`RID` space, :ref:`bool` active **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__space_set_param: + +- void **_space_set_param** **(** :ref:`RID` space, :ref:`SpaceParameter` param, :ref:`float` value **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__step: + +- void **_step** **(** :ref:`float` step **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__sync: + +- void **_sync** **(** **)** |virtual| + +---- + +.. _class_PhysicsServer2DExtension_method__world_boundary_shape_create: + +- :ref:`RID` **_world_boundary_shape_create** **(** **)** |virtual| + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` diff --git a/classes/class_physicsserver2dmanager.rst b/classes/class_physicsserver2dmanager.rst new file mode 100644 index 000000000..5d8abf3fc --- /dev/null +++ b/classes/class_physicsserver2dmanager.rst @@ -0,0 +1,55 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsServer2DManager.xml. + +.. _class_PhysicsServer2DManager: + +PhysicsServer2DManager +====================== + +**Inherits:** :ref:`Object` + +Manager for 2D physics server implementations. + +Description +----------- + +``PhysicsServer2DManager`` is the API for registering :ref:`PhysicsServer2D` implementations, and for setting the default implementation. + +\ **Note:** It is not possible to switch physics servers at runtime. This class is only used on startup at the server initialization level, by Godot itself and possibly by GDExtensions. + +Methods +------- + ++------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`register_server` **(** :ref:`String` name, :ref:`Callable` create_callback **)** | ++------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_default_server` **(** :ref:`String` name, :ref:`int` priority **)** | ++------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Method Descriptions +------------------- + +.. _class_PhysicsServer2DManager_method_register_server: + +- void **register_server** **(** :ref:`String` name, :ref:`Callable` create_callback **)** + +Register a :ref:`PhysicsServer2D` implementation by passing a ``name`` and a :ref:`Callable` that returns a :ref:`PhysicsServer2D` object. + +---- + +.. _class_PhysicsServer2DManager_method_set_default_server: + +- void **set_default_server** **(** :ref:`String` name, :ref:`int` priority **)** + +Set the default :ref:`PhysicsServer2D` implementation to the one identified by ``name``, if ``priority`` is greater than the priority of the current default implementation. + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` diff --git a/classes/class_physicsserver3dextension.rst b/classes/class_physicsserver3dextension.rst index f993ce527..b439ed5b1 100644 --- a/classes/class_physicsserver3dextension.rst +++ b/classes/class_physicsserver3dextension.rst @@ -192,6 +192,12 @@ Methods +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`_cylinder_shape_create` **(** **)** |virtual| | +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_end_sync` **(** **)** |virtual| | ++-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_finish` **(** **)** |virtual| | ++-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_flush_queries` **(** **)** |virtual| | ++-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_free_rid` **(** :ref:`RID` rid **)** |virtual| | +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_generic_6dof_joint_get_flag` **(** :ref:`RID` joint, Vector3.Axis axis, :ref:`G6DOFJointAxisFlag` flag **)** |virtual| |const| | @@ -214,6 +220,10 @@ Methods +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_hinge_joint_set_param` **(** :ref:`RID` joint, :ref:`HingeJointParam` param, :ref:`float` value **)** |virtual| | +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_init` **(** **)** |virtual| | ++-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`_is_flushing_queries` **(** **)** |virtual| |const| | ++-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`_joint_clear` **(** :ref:`RID` joint **)** |virtual| | +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`_joint_create` **(** **)** |virtual| | @@ -276,6 +286,10 @@ Methods +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`_sphere_shape_create` **(** **)** |virtual| | +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_step` **(** :ref:`float` step **)** |virtual| | ++-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_sync` **(** **)** |virtual| | ++-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`_world_boundary_shape_create` **(** **)** |virtual| | +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -804,6 +818,24 @@ Method Descriptions ---- +.. _class_PhysicsServer3DExtension_method__end_sync: + +- void **_end_sync** **(** **)** |virtual| + +---- + +.. _class_PhysicsServer3DExtension_method__finish: + +- void **_finish** **(** **)** |virtual| + +---- + +.. _class_PhysicsServer3DExtension_method__flush_queries: + +- void **_flush_queries** **(** **)** |virtual| + +---- + .. _class_PhysicsServer3DExtension_method__free_rid: - void **_free_rid** **(** :ref:`RID` rid **)** |virtual| @@ -870,6 +902,18 @@ Method Descriptions ---- +.. _class_PhysicsServer3DExtension_method__init: + +- void **_init** **(** **)** |virtual| + +---- + +.. _class_PhysicsServer3DExtension_method__is_flushing_queries: + +- :ref:`bool` **_is_flushing_queries** **(** **)** |virtual| |const| + +---- + .. _class_PhysicsServer3DExtension_method__joint_clear: - void **_joint_clear** **(** :ref:`RID` joint **)** |virtual| @@ -1056,6 +1100,18 @@ Method Descriptions ---- +.. _class_PhysicsServer3DExtension_method__step: + +- void **_step** **(** :ref:`float` step **)** |virtual| + +---- + +.. _class_PhysicsServer3DExtension_method__sync: + +- void **_sync** **(** **)** |virtual| + +---- + .. _class_PhysicsServer3DExtension_method__world_boundary_shape_create: - :ref:`RID` **_world_boundary_shape_create** **(** **)** |virtual| diff --git a/classes/class_physicsserver3dmanager.rst b/classes/class_physicsserver3dmanager.rst new file mode 100644 index 000000000..3a9c2e0a3 --- /dev/null +++ b/classes/class_physicsserver3dmanager.rst @@ -0,0 +1,55 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PhysicsServer3DManager.xml. + +.. _class_PhysicsServer3DManager: + +PhysicsServer3DManager +====================== + +**Inherits:** :ref:`Object` + +Manager for 3D physics server implementations. + +Description +----------- + +``PhysicsServer3DManager`` is the API for registering :ref:`PhysicsServer3D` implementations, and for setting the default implementation. + +\ **Note:** It is not possible to switch physics servers at runtime. This class is only used on startup at the server initialization level, by Godot itself and possibly by GDExtensions. + +Methods +------- + ++------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`register_server` **(** :ref:`String` name, :ref:`Callable` create_callback **)** | ++------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_default_server` **(** :ref:`String` name, :ref:`int` priority **)** | ++------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +Method Descriptions +------------------- + +.. _class_PhysicsServer3DManager_method_register_server: + +- void **register_server** **(** :ref:`String` name, :ref:`Callable` create_callback **)** + +Register a :ref:`PhysicsServer3D` implementation by passing a ``name`` and a :ref:`Callable` that returns a :ref:`PhysicsServer2D` object. + +---- + +.. _class_PhysicsServer3DManager_method_set_default_server: + +- void **set_default_server** **(** :ref:`String` name, :ref:`int` priority **)** + +Set the default :ref:`PhysicsServer3D` implementation to the one identified by ``name``, if ``priority`` is greater than the priority of the current default implementation. + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` diff --git a/classes/class_physicsshapequeryparameters2d.rst b/classes/class_physicsshapequeryparameters2d.rst index fdbd5bc53..2a56d02dc 100644 --- a/classes/class_physicsshapequeryparameters2d.rst +++ b/classes/class_physicsshapequeryparameters2d.rst @@ -29,7 +29,7 @@ Properties +---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`int` | :ref:`collision_mask` | ``4294967295`` | +---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+ -| :ref:`Array` | :ref:`exclude` | ``[]`` | +| :ref:`RID[]` | :ref:`exclude` | ``[]`` | +---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`float` | :ref:`margin` | ``0.0`` | +---------------------------------------+----------------------------------------------------------------------------------------------+-----------------------------------+ @@ -95,7 +95,7 @@ The physics layers the query will detect (as a bitmask). By default, all collisi .. _class_PhysicsShapeQueryParameters2D_property_exclude: -- :ref:`Array` **exclude** +- :ref:`RID[]` **exclude** +-----------+--------------------+ | *Default* | ``[]`` | diff --git a/classes/class_physicstestmotionparameters2d.rst b/classes/class_physicstestmotionparameters2d.rst index 8a7c3d470..f0f9f7bb4 100644 --- a/classes/class_physicstestmotionparameters2d.rst +++ b/classes/class_physicstestmotionparameters2d.rst @@ -25,7 +25,7 @@ Properties +---------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`bool` | :ref:`collide_separation_ray` | ``false`` | +---------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+ -| :ref:`Array` | :ref:`exclude_bodies` | ``[]`` | +| :ref:`RID[]` | :ref:`exclude_bodies` | ``[]`` | +---------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`Array` | :ref:`exclude_objects` | ``[]`` | +---------------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+ @@ -61,7 +61,7 @@ If set to ``false``, shapes of type :ref:`PhysicsServer2D.SHAPE_SEPARATION_RAY` **exclude_bodies** +- :ref:`RID[]` **exclude_bodies** +-----------+---------------------------+ | *Default* | ``[]`` | diff --git a/classes/class_popupmenu.rst b/classes/class_popupmenu.rst index 5cdd5946d..1c94255cd 100644 --- a/classes/class_popupmenu.rst +++ b/classes/class_popupmenu.rst @@ -80,7 +80,7 @@ Methods +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_current_index` **(** **)** |const| | +| :ref:`int` | :ref:`get_focused_item` **(** **)** |const| | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Key` | :ref:`get_item_accelerator` **(** :ref:`int` index **)** |const| | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -122,7 +122,7 @@ Methods +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`scroll_to_item` **(** :ref:`int` index **)** | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_current_index` **(** :ref:`int` index **)** | +| void | :ref:`set_focused_item` **(** :ref:`int` index **)** | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_item_accelerator` **(** :ref:`int` index, :ref:`Key` accel **)** | +--------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -539,9 +539,9 @@ Removes all items from the ``PopupMenu``. ---- -.. _class_PopupMenu_method_get_current_index: +.. _class_PopupMenu_method_get_focused_item: -- :ref:`int` **get_current_index** **(** **)** |const| +- :ref:`int` **get_focused_item** **(** **)** |const| Returns the index of the currently focused item. Returns ``-1`` if no item is focused. @@ -715,9 +715,9 @@ Moves the scroll view to make the item at the given ``index`` visible. ---- -.. _class_PopupMenu_method_set_current_index: +.. _class_PopupMenu_method_set_focused_item: -- void **set_current_index** **(** :ref:`int` index **)** +- void **set_focused_item** **(** :ref:`int` index **)** Sets the currently focused item as the given ``index``. diff --git a/classes/class_proceduralskymaterial.rst b/classes/class_proceduralskymaterial.rst index d83909218..0eafc835e 100644 --- a/classes/class_proceduralskymaterial.rst +++ b/classes/class_proceduralskymaterial.rst @@ -26,33 +26,33 @@ The ``ProceduralSkyMaterial`` supports up to 4 suns. Each sun takes its color, e Properties ---------- -+-----------------------------------+----------------------------------------------------------------------------------------+--------------------------------------+ -| :ref:`Color` | :ref:`ground_bottom_color` | ``Color(0.2, 0.169, 0.133, 1)`` | -+-----------------------------------+----------------------------------------------------------------------------------------+--------------------------------------+ -| :ref:`float` | :ref:`ground_curve` | ``0.02`` | -+-----------------------------------+----------------------------------------------------------------------------------------+--------------------------------------+ -| :ref:`float` | :ref:`ground_energy` | ``1.0`` | -+-----------------------------------+----------------------------------------------------------------------------------------+--------------------------------------+ -| :ref:`Color` | :ref:`ground_horizon_color` | ``Color(0.6463, 0.6558, 0.6708, 1)`` | -+-----------------------------------+----------------------------------------------------------------------------------------+--------------------------------------+ -| :ref:`Texture2D` | :ref:`sky_cover` | | -+-----------------------------------+----------------------------------------------------------------------------------------+--------------------------------------+ -| :ref:`Color` | :ref:`sky_cover_modulate` | ``Color(1, 1, 1, 1)`` | -+-----------------------------------+----------------------------------------------------------------------------------------+--------------------------------------+ -| :ref:`float` | :ref:`sky_curve` | ``0.15`` | -+-----------------------------------+----------------------------------------------------------------------------------------+--------------------------------------+ -| :ref:`float` | :ref:`sky_energy` | ``1.0`` | -+-----------------------------------+----------------------------------------------------------------------------------------+--------------------------------------+ -| :ref:`Color` | :ref:`sky_horizon_color` | ``Color(0.6463, 0.6558, 0.6708, 1)`` | -+-----------------------------------+----------------------------------------------------------------------------------------+--------------------------------------+ -| :ref:`Color` | :ref:`sky_top_color` | ``Color(0.385, 0.454, 0.55, 1)`` | -+-----------------------------------+----------------------------------------------------------------------------------------+--------------------------------------+ -| :ref:`float` | :ref:`sun_angle_max` | ``30.0`` | -+-----------------------------------+----------------------------------------------------------------------------------------+--------------------------------------+ -| :ref:`float` | :ref:`sun_curve` | ``0.15`` | -+-----------------------------------+----------------------------------------------------------------------------------------+--------------------------------------+ -| :ref:`bool` | :ref:`use_debanding` | ``true`` | -+-----------------------------------+----------------------------------------------------------------------------------------+--------------------------------------+ ++-----------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------+ +| :ref:`Color` | :ref:`ground_bottom_color` | ``Color(0.2, 0.169, 0.133, 1)`` | ++-----------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------+ +| :ref:`float` | :ref:`ground_curve` | ``0.02`` | ++-----------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------+ +| :ref:`float` | :ref:`ground_energy_multiplier` | ``1.0`` | ++-----------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------+ +| :ref:`Color` | :ref:`ground_horizon_color` | ``Color(0.6463, 0.6558, 0.6708, 1)`` | ++-----------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------+ +| :ref:`Texture2D` | :ref:`sky_cover` | | ++-----------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------+ +| :ref:`Color` | :ref:`sky_cover_modulate` | ``Color(1, 1, 1, 1)`` | ++-----------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------+ +| :ref:`float` | :ref:`sky_curve` | ``0.15`` | ++-----------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------+ +| :ref:`float` | :ref:`sky_energy_multiplier` | ``1.0`` | ++-----------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------+ +| :ref:`Color` | :ref:`sky_horizon_color` | ``Color(0.6463, 0.6558, 0.6708, 1)`` | ++-----------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------+ +| :ref:`Color` | :ref:`sky_top_color` | ``Color(0.385, 0.454, 0.55, 1)`` | ++-----------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------+ +| :ref:`float` | :ref:`sun_angle_max` | ``30.0`` | ++-----------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------+ +| :ref:`float` | :ref:`sun_curve` | ``0.15`` | ++-----------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------+ +| :ref:`bool` | :ref:`use_debanding` | ``true`` | ++-----------------------------------+------------------------------------------------------------------------------------------------+--------------------------------------+ Property Descriptions --------------------- @@ -89,19 +89,19 @@ How quickly the :ref:`ground_horizon_color` **ground_energy** +- :ref:`float` **ground_energy_multiplier** -+-----------+--------------------------+ -| *Default* | ``1.0`` | -+-----------+--------------------------+ -| *Setter* | set_ground_energy(value) | -+-----------+--------------------------+ -| *Getter* | get_ground_energy() | -+-----------+--------------------------+ ++-----------+-------------------------------------+ +| *Default* | ``1.0`` | ++-----------+-------------------------------------+ +| *Setter* | set_ground_energy_multiplier(value) | ++-----------+-------------------------------------+ +| *Getter* | get_ground_energy_multiplier() | ++-----------+-------------------------------------+ -Amount of energy contribution from the ground. +Multiplier for ground color. A higher value will make the ground brighter. ---- @@ -131,7 +131,7 @@ Color of the ground at the horizon. Blends with :ref:`ground_bottom_color`). The texture's colors will be *added* to the existing sky color, and will be multiplied by :ref:`sky_energy` and :ref:`sky_cover_modulate`. This is mainly suited to displaying stars at night, but it can also be used to display clouds at day or night (with a non-physically-accurate look). +The sky cover texture to use. This texture must use an equirectangular projection (similar to :ref:`PanoramaSkyMaterial`). The texture's colors will be *added* to the existing sky color, and will be multiplied by :ref:`sky_energy_multiplier` and :ref:`sky_cover_modulate`. This is mainly suited to displaying stars at night, but it can also be used to display clouds at day or night (with a non-physically-accurate look). ---- @@ -167,19 +167,19 @@ How quickly the :ref:`sky_horizon_color` **sky_energy** +- :ref:`float` **sky_energy_multiplier** -+-----------+-----------------------+ -| *Default* | ``1.0`` | -+-----------+-----------------------+ -| *Setter* | set_sky_energy(value) | -+-----------+-----------------------+ -| *Getter* | get_sky_energy() | -+-----------+-----------------------+ ++-----------+----------------------------------+ +| *Default* | ``1.0`` | ++-----------+----------------------------------+ +| *Setter* | set_sky_energy_multiplier(value) | ++-----------+----------------------------------+ +| *Getter* | get_sky_energy_multiplier() | ++-----------+----------------------------------+ -Amount of energy contribution from the sky. +Multiplier for sky color. A higher value will make the sky brighter. ---- diff --git a/classes/class_progressbar.rst b/classes/class_progressbar.rst index e5ed917ac..4b6cbd296 100644 --- a/classes/class_progressbar.rst +++ b/classes/class_progressbar.rst @@ -25,7 +25,7 @@ Properties +-------------------------+--------------------------------------------------------------------+----------+ | :ref:`int` | :ref:`fill_mode` | ``0`` | +-------------------------+--------------------------------------------------------------------+----------+ -| :ref:`bool` | :ref:`percent_visible` | ``true`` | +| :ref:`bool` | :ref:`show_percentage` | ``true`` | +-------------------------+--------------------------------------------------------------------+----------+ Theme Properties @@ -44,9 +44,9 @@ Theme Properties +---------------------------------+-----------------------------------------------------------------------------+--------------------------------+ | :ref:`int` | :ref:`font_size` | | +---------------------------------+-----------------------------------------------------------------------------+--------------------------------+ -| :ref:`StyleBox` | :ref:`bg` | | +| :ref:`StyleBox` | :ref:`background` | | +---------------------------------+-----------------------------------------------------------------------------+--------------------------------+ -| :ref:`StyleBox` | :ref:`fg` | | +| :ref:`StyleBox` | :ref:`fill` | | +---------------------------------+-----------------------------------------------------------------------------+--------------------------------+ Enumerations @@ -91,16 +91,16 @@ The fill direction. See :ref:`FillMode` for possible ---- -.. _class_ProgressBar_property_percent_visible: +.. _class_ProgressBar_property_show_percentage: -- :ref:`bool` **percent_visible** +- :ref:`bool` **show_percentage** +-----------+----------------------------+ | *Default* | ``true`` | +-----------+----------------------------+ -| *Setter* | set_percent_visible(value) | +| *Setter* | set_show_percentage(value) | +-----------+----------------------------+ -| *Getter* | is_percent_visible() | +| *Getter* | is_percentage_shown() | +-----------+----------------------------+ If ``true``, the fill percentage is displayed on the bar. @@ -160,7 +160,7 @@ The size of the text outline. - :ref:`Font` **font** -Font used to draw the fill percentage if :ref:`percent_visible` is ``true``. +Font used to draw the fill percentage if :ref:`show_percentage` is ``true``. ---- @@ -168,21 +168,21 @@ Font used to draw the fill percentage if :ref:`percent_visible` **font_size** -Font size used to draw the fill percentage if :ref:`percent_visible` is ``true``. +Font size used to draw the fill percentage if :ref:`show_percentage` is ``true``. ---- -.. _class_ProgressBar_theme_style_bg: +.. _class_ProgressBar_theme_style_background: -- :ref:`StyleBox` **bg** +- :ref:`StyleBox` **background** The style of the background. ---- -.. _class_ProgressBar_theme_style_fg: +.. _class_ProgressBar_theme_style_fill: -- :ref:`StyleBox` **fg** +- :ref:`StyleBox` **fill** The style of the progress (i.e. the part that fills the bar). diff --git a/classes/class_projectsettings.rst b/classes/class_projectsettings.rst index d263f3e1a..09a80fdeb 100644 --- a/classes/class_projectsettings.rst +++ b/classes/class_projectsettings.rst @@ -37,1199 +37,1211 @@ Tutorials Properties ---------- -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`application/boot_splash/bg_color` | ``Color(0.14, 0.14, 0.14, 1)`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`application/boot_splash/fullsize` | ``true`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`application/boot_splash/image` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`application/boot_splash/minimum_display_time` | ``0`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`application/boot_splash/show_image` | ``true`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`application/boot_splash/use_filter` | ``true`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`application/config/custom_user_dir_name` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`application/config/description` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`PackedStringArray` | :ref:`application/config/features` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`application/config/icon` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`application/config/macos_native_icon` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`application/config/name` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`application/config/name_localized` | ``{}`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`application/config/project_settings_override` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`application/config/use_custom_user_dir` | ``false`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`application/config/use_hidden_project_data_directory` | ``true`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`application/config/windows_native_icon` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`application/run/disable_stderr` | ``false`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`application/run/disable_stdout` | ``false`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`application/run/flush_stdout_on_print` | ``false`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`application/run/flush_stdout_on_print.debug` | ``true`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`application/run/frame_delay_msec` | ``0`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`application/run/low_processor_mode` | ``false`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`application/run/low_processor_mode_sleep_usec` | ``6900`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`application/run/main_scene` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`audio/buses/channel_disable_threshold_db` | ``-60.0`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`audio/buses/channel_disable_time` | ``2.0`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`audio/buses/default_bus_layout` | ``"res://default_bus_layout.tres"`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`audio/driver/driver` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`audio/driver/enable_input` | ``false`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`audio/driver/mix_rate` | ``44100`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`audio/driver/mix_rate.web` | ``0`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`audio/driver/output_latency` | ``15`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`audio/driver/output_latency.web` | ``50`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`audio/general/2d_panning_strength` | ``1.0`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`audio/general/3d_panning_strength` | ``1.0`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`audio/video/video_delay_compensation_ms` | ``0`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`compression/formats/gzip/compression_level` | ``-1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`compression/formats/zlib/compression_level` | ``-1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`compression/formats/zstd/compression_level` | ``3`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`compression/formats/zstd/long_distance_matching` | ``false`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`compression/formats/zstd/window_log_size` | ``27`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/file_logging/enable_file_logging` | ``false`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/file_logging/enable_file_logging.pc` | ``true`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`debug/file_logging/log_path` | ``"user://logs/godot.log"`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/file_logging/max_log_files` | ``5`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/gdscript/warnings/assert_always_false` | ``1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/gdscript/warnings/assert_always_true` | ``1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/gdscript/warnings/constant_used_as_function` | ``1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/gdscript/warnings/deprecated_keyword` | ``1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/gdscript/warnings/empty_file` | ``1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/enable` | ``true`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/exclude_addons` | ``true`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/gdscript/warnings/function_used_as_property` | ``1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/gdscript/warnings/incompatible_ternary` | ``1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/gdscript/warnings/int_assigned_to_enum` | ``1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/gdscript/warnings/integer_division` | ``1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/gdscript/warnings/narrowing_conversion` | ``1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/gdscript/warnings/property_used_as_function` | ``1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/gdscript/warnings/redundant_await` | ``1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/gdscript/warnings/return_value_discarded` | ``1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/gdscript/warnings/shadowed_global_identifier` | ``1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/gdscript/warnings/shadowed_variable` | ``1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/gdscript/warnings/shadowed_variable_base_class` | ``1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/gdscript/warnings/standalone_expression` | ``1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/gdscript/warnings/standalone_ternary` | ``1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/gdscript/warnings/treat_warnings_as_errors` | ``false`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/gdscript/warnings/unassigned_variable` | ``1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/gdscript/warnings/unassigned_variable_op_assign` | ``1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/gdscript/warnings/unreachable_code` | ``1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/gdscript/warnings/unreachable_pattern` | ``1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/gdscript/warnings/unsafe_call_argument` | ``0`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/gdscript/warnings/unsafe_cast` | ``0`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/gdscript/warnings/unsafe_method_access` | ``0`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/gdscript/warnings/unsafe_property_access` | ``0`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/gdscript/warnings/unused_local_constant` | ``1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/gdscript/warnings/unused_parameter` | ``1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/gdscript/warnings/unused_private_class_variable` | ``1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/gdscript/warnings/unused_signal` | ``1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/gdscript/warnings/unused_variable` | ``1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/gdscript/warnings/void_assignment` | ``1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`debug/settings/crash_handler/message` | ``"Please include this when reporting the bug to the project developer."`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`debug/settings/crash_handler/message.editor` | ``"Please include this when reporting the bug on: https://github.com/godotengine/godot/issues"`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/settings/fps/force_fps` | ``0`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/settings/gdscript/max_call_stack` | ``1024`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/settings/profiler/max_functions` | ``16384`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/settings/stdout/print_fps` | ``false`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/settings/stdout/print_gpu_profile` | ``false`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/settings/stdout/verbose_stdout` | ``false`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`debug/shapes/collision/contact_color` | ``Color(1, 0.2, 0.1, 0.8)`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/shapes/collision/draw_2d_outlines` | ``true`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`debug/shapes/collision/max_contacts_displayed` | ``10000`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`debug/shapes/collision/shape_color` | ``Color(0, 0.6, 0.7, 0.42)`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`debug/shapes/navigation/disabled_geometry_color` | ``Color(1, 0.7, 0.1, 0.4)`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`debug/shapes/navigation/edge_connection_color` | ``Color(1, 0, 1, 1)`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/shapes/navigation/enable_edge_connections` | ``true`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/shapes/navigation/enable_edge_connections_xray` | ``true`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/shapes/navigation/enable_edge_lines` | ``true`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/shapes/navigation/enable_edge_lines_xray` | ``true`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`debug/shapes/navigation/enable_geometry_face_random_color` | ``true`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`debug/shapes/navigation/geometry_color` | ``Color(0.1, 1, 0.7, 0.4)`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`debug/shapes/navigation/geometry_edge_color` | ``Color(0.5, 1, 1, 1)`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`debug/shapes/navigation/geometry_edge_disabled_color` | ``Color(0.5, 0.5, 0.5, 1)`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`debug/shapes/navigation/geometry_face_color` | ``Color(0.5, 1, 1, 0.4)`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`debug/shapes/navigation/geometry_face_disabled_color` | ``Color(0.5, 0.5, 0.5, 0.4)`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`debug/shapes/paths/geometry_color` | ``Color(0.1, 1, 0.7, 0.4)`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`debug/shapes/paths/geometry_width` | ``2.0`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`display/mouse_cursor/custom_image` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`display/mouse_cursor/custom_image_hotspot` | ``Vector2(0, 0)`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`display/mouse_cursor/tooltip_position_offset` | ``Vector2(10, 10)`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`display/window/dpi/allow_hidpi` | ``true`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`display/window/energy_saving/keep_screen_on` | ``true`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`display/window/energy_saving/keep_screen_on.editor` | ``false`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`display/window/handheld/orientation` | ``0`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`display/window/ios/hide_home_indicator` | ``true`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`display/window/size/always_on_top` | ``false`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`display/window/size/borderless` | ``false`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`display/window/size/fullscreen` | ``false`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`display/window/size/resizable` | ``true`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`display/window/size/viewport_height` | ``648`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`display/window/size/viewport_width` | ``1152`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`display/window/size/window_height_override` | ``0`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`display/window/size/window_width_override` | ``0`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`display/window/vsync/vsync_mode` | ``1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`editor/movie_writer/disable_vsync` | ``false`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`editor/movie_writer/fps` | ``60`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`editor/movie_writer/mix_rate` | ``48000`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`editor/movie_writer/mjpeg_quality` | ``0.75`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`editor/movie_writer/movie_file` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`editor/movie_writer/speaker_mode` | ``0`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`editor/node_naming/name_casing` | ``0`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`editor/node_naming/name_num_separator` | ``0`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`editor/run/main_run_args` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`PackedStringArray` | :ref:`editor/script/search_in_file_extensions` | ``PackedStringArray("gd", "gdshader")`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`editor/script/templates_search_path` | ``"res://script_templates"`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`filesystem/import/blender/enabled` | ``true`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`filesystem/import/fbx/enabled` | ``true`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`gui/common/default_scroll_deadzone` | ``0`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`gui/common/swap_cancel_ok` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`gui/common/text_edit_undo_stack_max_size` | ``1024`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`gui/theme/custom` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`gui/theme/custom_font` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`gui/theme/default_font_antialiasing` | ``1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`gui/theme/default_font_generate_mipmaps` | ``false`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`gui/theme/default_font_hinting` | ``1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`gui/theme/default_font_multichannel_signed_distance_field` | ``false`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`gui/theme/default_font_subpixel_positioning` | ``1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`gui/theme/default_theme_scale` | ``1.0`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`gui/theme/lcd_subpixel_layout` | ``1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`gui/timers/incremental_search_max_interval_msec` | ``2000`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`gui/timers/text_edit_idle_detect_sec` | ``3`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`gui/timers/tooltip_delay_sec` | ``0.5`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_accept` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_cancel` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_copy` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_cut` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_down` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_end` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_filedialog_refresh` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_filedialog_show_hidden` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_filedialog_up_one_level` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_focus_next` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_focus_prev` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_graph_delete` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_graph_duplicate` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_home` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_left` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_menu` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_page_down` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_page_up` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_paste` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_redo` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_right` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_select` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_swap_input_direction` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_text_backspace` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_text_backspace_all_to_left` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_text_backspace_all_to_left.macos` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_text_backspace_word` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_text_backspace_word.macos` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_text_caret_document_end` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_text_caret_document_end.macos` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_text_caret_document_start` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_text_caret_document_start.macos` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_text_caret_down` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_text_caret_left` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_text_caret_line_end` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_text_caret_line_end.macos` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_text_caret_line_start` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_text_caret_line_start.macos` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_text_caret_page_down` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_text_caret_page_up` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_text_caret_right` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_text_caret_up` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_text_caret_word_left` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_text_caret_word_left.macos` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_text_caret_word_right` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_text_caret_word_right.macos` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_text_completion_accept` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_text_completion_query` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_text_completion_replace` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_text_dedent` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_text_delete` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_text_delete_all_to_right` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_text_delete_all_to_right.macos` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_text_delete_word` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_text_delete_word.macos` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_text_indent` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_text_newline` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_text_newline_above` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_text_newline_blank` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_text_scroll_down` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_text_scroll_down.macos` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_text_scroll_up` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_text_scroll_up.macos` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_text_select_all` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_text_select_word_under_caret` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_text_submit` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_text_toggle_insert_mode` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_undo` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`input/ui_up` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_devices/buffering/agile_event_flushing` | ``false`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_devices/pen_tablet/driver` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`input_devices/pen_tablet/driver.windows` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_devices/pointing/emulate_mouse_from_touch` | ``true`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`input_devices/pointing/emulate_touch_from_mouse` | ``false`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`input_devices/pointing/ios/touch_delay` | ``0.15`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`internationalization/locale/fallback` | ``"en"`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`internationalization/locale/include_text_server_data` | ``false`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`internationalization/locale/test` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`PackedStringArray` | :ref:`internationalization/locale/translation_remaps` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`PackedStringArray` | :ref:`internationalization/locale/translations` | | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`internationalization/pseudolocalization/double_vowels` | ``false`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`internationalization/pseudolocalization/expansion_ratio` | ``0.0`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`internationalization/pseudolocalization/fake_bidi` | ``false`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`internationalization/pseudolocalization/override` | ``false`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`internationalization/pseudolocalization/prefix` | ``"["`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`internationalization/pseudolocalization/replace_with_accents` | ``true`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`internationalization/pseudolocalization/skip_placeholders` | ``true`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`internationalization/pseudolocalization/suffix` | ``"]"`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`internationalization/pseudolocalization/use_pseudolocalization` | ``false`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`internationalization/rendering/force_right_to_left_layout_direction` | ``false`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`internationalization/rendering/text_driver` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_navigation/layer_1` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_navigation/layer_10` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_navigation/layer_11` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_navigation/layer_12` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_navigation/layer_13` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_navigation/layer_14` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_navigation/layer_15` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_navigation/layer_16` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_navigation/layer_17` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_navigation/layer_18` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_navigation/layer_19` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_navigation/layer_2` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_navigation/layer_20` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_navigation/layer_21` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_navigation/layer_22` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_navigation/layer_23` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_navigation/layer_24` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_navigation/layer_25` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_navigation/layer_26` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_navigation/layer_27` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_navigation/layer_28` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_navigation/layer_29` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_navigation/layer_3` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_navigation/layer_30` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_navigation/layer_31` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_navigation/layer_32` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_navigation/layer_4` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_navigation/layer_5` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_navigation/layer_6` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_navigation/layer_7` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_navigation/layer_8` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_navigation/layer_9` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_1` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_10` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_11` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_12` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_13` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_14` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_15` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_16` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_17` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_18` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_19` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_2` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_20` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_21` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_22` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_23` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_24` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_25` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_26` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_27` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_28` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_29` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_3` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_30` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_31` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_32` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_4` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_5` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_6` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_7` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_8` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_physics/layer_9` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_1` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_10` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_11` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_12` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_13` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_14` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_15` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_16` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_17` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_18` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_19` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_2` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_20` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_3` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_4` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_5` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_6` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_7` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_8` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/2d_render/layer_9` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_navigation/layer_1` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_navigation/layer_10` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_navigation/layer_11` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_navigation/layer_12` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_navigation/layer_13` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_navigation/layer_14` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_navigation/layer_15` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_navigation/layer_16` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_navigation/layer_17` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_navigation/layer_18` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_navigation/layer_19` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_navigation/layer_2` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_navigation/layer_20` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_navigation/layer_21` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_navigation/layer_22` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_navigation/layer_23` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_navigation/layer_24` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_navigation/layer_25` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_navigation/layer_26` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_navigation/layer_27` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_navigation/layer_28` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_navigation/layer_29` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_navigation/layer_3` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_navigation/layer_30` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_navigation/layer_31` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_navigation/layer_32` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_navigation/layer_4` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_navigation/layer_5` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_navigation/layer_6` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_navigation/layer_7` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_navigation/layer_8` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_navigation/layer_9` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_1` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_10` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_11` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_12` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_13` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_14` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_15` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_16` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_17` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_18` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_19` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_2` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_20` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_21` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_22` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_23` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_24` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_25` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_26` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_27` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_28` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_29` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_3` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_30` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_31` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_32` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_4` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_5` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_6` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_7` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_8` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_physics/layer_9` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_1` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_10` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_11` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_12` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_13` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_14` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_15` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_16` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_17` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_18` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_19` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_2` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_20` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_3` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_4` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_5` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_6` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_7` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_8` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`layer_names/3d_render/layer_9` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`memory/limits/message_queue/max_size_kb` | ``4096`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`memory/limits/multithreaded_server/rid_pool_prealloc` | ``60`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`navigation/2d/default_cell_size` | ``1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`navigation/2d/default_edge_connection_margin` | ``1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`navigation/3d/default_cell_size` | ``0.25`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`navigation/3d/default_edge_connection_margin` | ``0.25`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/limits/debugger/max_chars_per_second` | ``32768`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/limits/debugger/max_errors_per_second` | ``400`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/limits/debugger/max_queued_messages` | ``2048`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/limits/debugger/max_warnings_per_second` | ``400`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/limits/packet_peer_stream/max_buffer_po2` | ``16`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/limits/tcp/connect_timeout_seconds` | ``30`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/limits/webrtc/max_channel_in_buffer_kb` | ``64`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/remote_fs/page_read_ahead` | ``4`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`network/remote_fs/page_size` | ``65536`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`network/ssl/certificate_bundle_override` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`physics/2d/default_angular_damp` | ``1.0`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`physics/2d/default_gravity` | ``980.0`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`physics/2d/default_gravity_vector` | ``Vector2(0, 1)`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`physics/2d/default_linear_damp` | ``0.1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`physics/2d/physics_engine` | ``"DEFAULT"`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`physics/2d/run_on_separate_thread` | ``false`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`physics/2d/sleep_threshold_angular` | ``0.139626`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`physics/2d/sleep_threshold_linear` | ``2.0`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`physics/2d/solver/contact_max_allowed_penetration` | ``0.3`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`physics/2d/solver/contact_max_separation` | ``1.5`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`physics/2d/solver/contact_recycle_radius` | ``1.0`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`physics/2d/solver/default_constraint_bias` | ``0.2`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`physics/2d/solver/default_contact_bias` | ``0.8`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`physics/2d/solver/solver_iterations` | ``16`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`physics/2d/time_before_sleep` | ``0.5`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`physics/3d/default_angular_damp` | ``0.1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`physics/3d/default_gravity` | ``9.8`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Vector3` | :ref:`physics/3d/default_gravity_vector` | ``Vector3(0, -1, 0)`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`physics/3d/default_linear_damp` | ``0.1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`physics/3d/physics_engine` | ``"DEFAULT"`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`physics/3d/run_on_separate_thread` | ``false`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`physics/3d/sleep_threshold_angular` | ``0.139626`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`physics/3d/sleep_threshold_linear` | ``0.1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`physics/3d/solver/contact_max_allowed_penetration` | ``0.01`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`physics/3d/solver/contact_max_separation` | ``0.05`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`physics/3d/solver/contact_recycle_radius` | ``0.01`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`physics/3d/solver/default_contact_bias` | ``0.8`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`physics/3d/solver/solver_iterations` | ``16`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`physics/3d/time_before_sleep` | ``0.5`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`physics/common/enable_object_picking` | ``true`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`physics/common/physics_jitter_fix` | ``0.5`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`physics/common/physics_ticks_per_second` | ``60`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/2d/sdf/oversize` | ``1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/2d/sdf/scale` | ``1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/2d/shadow_atlas/size` | ``2048`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/2d/snap/snap_2d_transforms_to_pixel` | ``false`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/2d/snap/snap_2d_vertices_to_pixel` | ``false`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/anti_aliasing/quality/msaa_2d` | ``0`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/anti_aliasing/quality/msaa_3d` | ``0`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/anti_aliasing/quality/screen_space_aa` | ``0`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/anti_aliasing/quality/use_debanding` | ``false`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/anti_aliasing/quality/use_taa` | ``false`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`rendering/anti_aliasing/screen_space_roughness_limiter/amount` | ``0.25`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/anti_aliasing/screen_space_roughness_limiter/enabled` | ``true`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`rendering/anti_aliasing/screen_space_roughness_limiter/limit` | ``0.18`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/camera/depth_of_field/depth_of_field_bokeh_quality` | ``1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/camera/depth_of_field/depth_of_field_bokeh_shape` | ``1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/camera/depth_of_field/depth_of_field_use_jitter` | ``false`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`rendering/driver/depth_prepass/disable_for_vendors` | ``"PowerVR,Mali,Adreno,Apple"`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/driver/depth_prepass/enable` | ``true`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`rendering/driver/driver_name` | ``"vulkan"`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/driver/threads/thread_model` | ``1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`rendering/environment/defaults/default_clear_color` | ``Color(0.3, 0.3, 0.3, 1)`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`rendering/environment/defaults/default_environment` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/environment/glow/upscale_mode` | ``1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/environment/glow/upscale_mode.mobile` | ``0`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/environment/glow/use_high_quality` | ``false`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/environment/screen_space_reflection/roughness_quality` | ``1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`rendering/environment/ssao/adaptive_target` | ``0.5`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/environment/ssao/blur_passes` | ``2`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`rendering/environment/ssao/fadeout_from` | ``50.0`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`rendering/environment/ssao/fadeout_to` | ``300.0`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/environment/ssao/half_size` | ``true`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/environment/ssao/quality` | ``2`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`rendering/environment/ssil/adaptive_target` | ``0.5`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/environment/ssil/blur_passes` | ``4`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`rendering/environment/ssil/fadeout_from` | ``50.0`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`rendering/environment/ssil/fadeout_to` | ``300.0`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/environment/ssil/half_size` | ``true`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/environment/ssil/quality` | ``2`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`rendering/environment/subsurface_scattering/subsurface_scattering_depth_scale` | ``0.01`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/environment/subsurface_scattering/subsurface_scattering_quality` | ``1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`rendering/environment/subsurface_scattering/subsurface_scattering_scale` | ``0.05`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/environment/volumetric_fog/use_filter` | ``1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/environment/volumetric_fog/volume_depth` | ``64`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/environment/volumetric_fog/volume_size` | ``64`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/global_illumination/gi/use_half_resolution` | ``false`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/global_illumination/sdfgi/frames_to_converge` | ``5`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/global_illumination/sdfgi/frames_to_update_lights` | ``2`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/global_illumination/sdfgi/probe_ray_count` | ``1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/global_illumination/voxel_gi/quality` | ``0`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/lightmapping/bake_performance/max_rays_per_pass` | ``32`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/lightmapping/bake_performance/max_rays_per_probe_pass` | ``64`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/lightmapping/bake_performance/region_size` | ``512`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/lightmapping/bake_quality/high_quality_probe_ray_count` | ``512`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/lightmapping/bake_quality/high_quality_ray_count` | ``256`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/lightmapping/bake_quality/low_quality_probe_ray_count` | ``64`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/lightmapping/bake_quality/low_quality_ray_count` | ``16`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/lightmapping/bake_quality/medium_quality_probe_ray_count` | ``256`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/lightmapping/bake_quality/medium_quality_ray_count` | ``64`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/lightmapping/bake_quality/ultra_quality_probe_ray_count` | ``2048`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/lightmapping/bake_quality/ultra_quality_ray_count` | ``1024`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`rendering/lightmapping/probe_capture/update_speed` | ``15`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`rendering/limits/cluster_builder/max_clustered_elements` | ``512`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/limits/forward_renderer/threaded_render_minimum_instances` | ``500`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/limits/global_shader_variables/buffer_size` | ``65536`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/limits/opengl/max_lights_per_object` | ``8`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/limits/opengl/max_renderable_elements` | ``65536`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/limits/opengl/max_renderable_lights` | ``32`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/limits/spatial_indexer/threaded_cull_minimum_instances` | ``1000`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/limits/spatial_indexer/update_iterations_per_frame` | ``10`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`rendering/limits/time/time_rollover_secs` | ``3600`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`rendering/mesh_lod/lod_change/threshold_pixels` | ``1.0`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/occlusion_culling/bvh_build_quality` | ``2`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/occlusion_culling/occlusion_rays_per_thread` | ``512`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/occlusion_culling/use_occlusion_culling` | ``false`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/reflections/reflection_atlas/reflection_count` | ``64`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/reflections/reflection_atlas/reflection_size` | ``256`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/reflections/reflection_atlas/reflection_size.mobile` | ``128`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/reflections/sky_reflections/fast_filter_high_quality` | ``false`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/reflections/sky_reflections/ggx_samples` | ``32`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/reflections/sky_reflections/ggx_samples.mobile` | ``16`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/reflections/sky_reflections/roughness_layers` | ``8`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/reflections/sky_reflections/texture_array_reflections` | ``true`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/reflections/sky_reflections/texture_array_reflections.mobile` | ``false`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`rendering/scaling_3d/fsr_sharpness` | ``0.2`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/scaling_3d/mode` | ``0`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`rendering/scaling_3d/scale` | ``1.0`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/shader_compiler/shader_cache/compress` | ``true`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/shader_compiler/shader_cache/enabled` | ``true`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/shader_compiler/shader_cache/strip_debug` | ``false`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/shader_compiler/shader_cache/strip_debug.release` | ``true`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/shader_compiler/shader_cache/use_zstd_compression` | ``true`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/shading/overrides/force_lambert_over_burley` | ``false`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/shading/overrides/force_lambert_over_burley.mobile` | ``true`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/shading/overrides/force_vertex_shading` | ``false`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/shading/overrides/force_vertex_shading.mobile` | ``true`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/shadows/directional_shadow/16_bits` | ``true`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/shadows/directional_shadow/size` | ``4096`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/shadows/directional_shadow/size.mobile` | ``2048`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/shadows/directional_shadow/soft_shadow_filter_quality` | ``2`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/shadows/directional_shadow/soft_shadow_filter_quality.mobile` | ``0`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/shadows/positional_shadow/atlas_16_bits` | ``true`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/shadows/positional_shadow/atlas_quadrant_0_subdiv` | ``2`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/shadows/positional_shadow/atlas_quadrant_1_subdiv` | ``2`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/shadows/positional_shadow/atlas_quadrant_2_subdiv` | ``3`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/shadows/positional_shadow/atlas_quadrant_3_subdiv` | ``4`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/shadows/positional_shadow/atlas_size` | ``4096`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/shadows/positional_shadow/atlas_size.mobile` | ``2048`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/shadows/positional_shadow/soft_shadow_filter_quality` | ``2`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/shadows/positional_shadow/soft_shadow_filter_quality.mobile` | ``0`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/textures/decals/filter` | ``3`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/textures/default_filters/anisotropic_filtering_level` | ``2`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`rendering/textures/default_filters/texture_mipmap_bias` | ``0.0`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/textures/default_filters/use_nearest_mipmap_filter` | ``false`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/textures/light_projectors/filter` | ``3`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/textures/lossless_compression/force_png` | ``false`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/textures/lossless_compression/webp_compression_level` | ``2`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/textures/vram_compression/import_bptc` | ``false`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/textures/vram_compression/import_etc` | ``false`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/textures/vram_compression/import_etc2` | ``true`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`rendering/textures/vram_compression/import_s3tc` | ``true`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/vrs/mode` | ``0`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`rendering/vrs/texture` | ``""`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/vulkan/descriptor_pools/max_descriptors_per_pool` | ``64`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/vulkan/rendering/back_end` | ``0`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/vulkan/rendering/back_end.mobile` | ``1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/vulkan/staging_buffer/block_size_kb` | ``256`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/vulkan/staging_buffer/max_size_mb` | ``128`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`rendering/vulkan/staging_buffer/texture_upload_region_size_px` | ``64`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`threading/worker_pool/low_priority_thread_ratio` | ``0.3`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`threading/worker_pool/max_threads` | ``-1`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`threading/worker_pool/use_system_threads_for_low_priority_tasks` | ``true`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`xr/openxr/default_action_map` | ``"res://openxr_action_map.tres"`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`xr/openxr/enabled` | ``false`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`xr/openxr/form_factor` | ``"0"`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`xr/openxr/reference_space` | ``"1"`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`xr/openxr/view_configuration` | ``"1"`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`xr/shaders/enabled` | ``false`` | -+---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`application/boot_splash/bg_color` | ``Color(0.14, 0.14, 0.14, 1)`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`application/boot_splash/fullsize` | ``true`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`application/boot_splash/image` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`application/boot_splash/minimum_display_time` | ``0`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`application/boot_splash/show_image` | ``true`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`application/boot_splash/use_filter` | ``true`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`application/config/custom_user_dir_name` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`application/config/description` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`application/config/features` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`application/config/icon` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`application/config/macos_native_icon` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`application/config/name` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`application/config/name_localized` | ``{}`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`application/config/project_settings_override` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`application/config/use_custom_user_dir` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`application/config/use_hidden_project_data_directory` | ``true`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`application/config/windows_native_icon` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`application/run/disable_stderr` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`application/run/disable_stdout` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`application/run/flush_stdout_on_print` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`application/run/flush_stdout_on_print.debug` | ``true`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`application/run/frame_delay_msec` | ``0`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`application/run/low_processor_mode` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`application/run/low_processor_mode_sleep_usec` | ``6900`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`application/run/main_scene` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`audio/buses/channel_disable_threshold_db` | ``-60.0`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`audio/buses/channel_disable_time` | ``2.0`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`audio/buses/default_bus_layout` | ``"res://default_bus_layout.tres"`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`audio/driver/driver` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`audio/driver/enable_input` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`audio/driver/mix_rate` | ``44100`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`audio/driver/mix_rate.web` | ``0`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`audio/driver/output_latency` | ``15`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`audio/driver/output_latency.web` | ``50`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`audio/general/2d_panning_strength` | ``1.0`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`audio/general/3d_panning_strength` | ``1.0`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`audio/video/video_delay_compensation_ms` | ``0`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`compression/formats/gzip/compression_level` | ``-1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`compression/formats/zlib/compression_level` | ``-1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`compression/formats/zstd/compression_level` | ``3`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`compression/formats/zstd/long_distance_matching` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`compression/formats/zstd/window_log_size` | ``27`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/file_logging/enable_file_logging` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/file_logging/enable_file_logging.pc` | ``true`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`debug/file_logging/log_path` | ``"user://logs/godot.log"`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/file_logging/max_log_files` | ``5`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/gdscript/warnings/assert_always_false` | ``1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/gdscript/warnings/assert_always_true` | ``1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/gdscript/warnings/constant_used_as_function` | ``1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/gdscript/warnings/deprecated_keyword` | ``1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/gdscript/warnings/empty_file` | ``1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/enable` | ``true`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/exclude_addons` | ``true`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/gdscript/warnings/function_used_as_property` | ``1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/gdscript/warnings/incompatible_ternary` | ``1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/gdscript/warnings/int_assigned_to_enum` | ``1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/gdscript/warnings/integer_division` | ``1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/gdscript/warnings/narrowing_conversion` | ``1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/gdscript/warnings/property_used_as_function` | ``1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/gdscript/warnings/redundant_await` | ``1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/gdscript/warnings/return_value_discarded` | ``1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/gdscript/warnings/shadowed_global_identifier` | ``1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/gdscript/warnings/shadowed_variable` | ``1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/gdscript/warnings/shadowed_variable_base_class` | ``1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/gdscript/warnings/standalone_expression` | ``1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/gdscript/warnings/standalone_ternary` | ``1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/gdscript/warnings/treat_warnings_as_errors` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/gdscript/warnings/unassigned_variable` | ``1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/gdscript/warnings/unassigned_variable_op_assign` | ``1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/gdscript/warnings/unreachable_code` | ``1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/gdscript/warnings/unreachable_pattern` | ``1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/gdscript/warnings/unsafe_call_argument` | ``0`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/gdscript/warnings/unsafe_cast` | ``0`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/gdscript/warnings/unsafe_method_access` | ``0`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/gdscript/warnings/unsafe_property_access` | ``0`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/gdscript/warnings/unused_local_constant` | ``1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/gdscript/warnings/unused_parameter` | ``1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/gdscript/warnings/unused_private_class_variable` | ``1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/gdscript/warnings/unused_signal` | ``1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/gdscript/warnings/unused_variable` | ``1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/gdscript/warnings/void_assignment` | ``1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`debug/settings/crash_handler/message` | ``"Please include this when reporting the bug to the project developer."`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`debug/settings/crash_handler/message.editor` | ``"Please include this when reporting the bug on: https://github.com/godotengine/godot/issues"`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/settings/fps/force_fps` | ``0`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/settings/gdscript/max_call_stack` | ``1024`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/settings/profiler/max_functions` | ``16384`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/settings/stdout/print_fps` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/settings/stdout/print_gpu_profile` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/settings/stdout/verbose_stdout` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`debug/shapes/collision/contact_color` | ``Color(1, 0.2, 0.1, 0.8)`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/shapes/collision/draw_2d_outlines` | ``true`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`debug/shapes/collision/max_contacts_displayed` | ``10000`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`debug/shapes/collision/shape_color` | ``Color(0, 0.6, 0.7, 0.42)`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`debug/shapes/navigation/edge_connection_color` | ``Color(1, 0, 1, 1)`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/shapes/navigation/enable_edge_connections` | ``true`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/shapes/navigation/enable_edge_connections_xray` | ``true`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/shapes/navigation/enable_edge_lines` | ``true`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/shapes/navigation/enable_edge_lines_xray` | ``true`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/shapes/navigation/enable_geometry_face_random_color` | ``true`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/shapes/navigation/enable_link_connections` | ``true`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`debug/shapes/navigation/enable_link_connections_xray` | ``true`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`debug/shapes/navigation/geometry_edge_color` | ``Color(0.5, 1, 1, 1)`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`debug/shapes/navigation/geometry_edge_disabled_color` | ``Color(0.5, 0.5, 0.5, 1)`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`debug/shapes/navigation/geometry_face_color` | ``Color(0.5, 1, 1, 0.4)`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`debug/shapes/navigation/geometry_face_disabled_color` | ``Color(0.5, 0.5, 0.5, 0.4)`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`debug/shapes/navigation/link_connection_color` | ``Color(1, 0.5, 1, 1)`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`debug/shapes/navigation/link_connection_disabled_color` | ``Color(0.5, 0.5, 0.5, 1)`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`debug/shapes/paths/geometry_color` | ``Color(0.1, 1, 0.7, 0.4)`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`debug/shapes/paths/geometry_width` | ``2.0`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`display/mouse_cursor/custom_image` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`display/mouse_cursor/custom_image_hotspot` | ``Vector2(0, 0)`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`display/mouse_cursor/tooltip_position_offset` | ``Vector2(10, 10)`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`display/window/dpi/allow_hidpi` | ``true`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`display/window/energy_saving/keep_screen_on` | ``true`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`display/window/energy_saving/keep_screen_on.editor` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`display/window/handheld/orientation` | ``0`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`display/window/ios/hide_home_indicator` | ``true`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`display/window/per_pixel_transparency/allowed` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`display/window/size/always_on_top` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`display/window/size/borderless` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`display/window/size/fullscreen` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`display/window/size/resizable` | ``true`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`display/window/size/viewport_height` | ``648`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`display/window/size/viewport_width` | ``1152`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`display/window/size/window_height_override` | ``0`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`display/window/size/window_width_override` | ``0`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`display/window/vsync/vsync_mode` | ``1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`editor/movie_writer/disable_vsync` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`editor/movie_writer/fps` | ``60`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`editor/movie_writer/mix_rate` | ``48000`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`editor/movie_writer/mjpeg_quality` | ``0.75`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`editor/movie_writer/movie_file` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`editor/movie_writer/speaker_mode` | ``0`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`editor/node_naming/name_casing` | ``0`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`editor/node_naming/name_num_separator` | ``0`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`editor/run/main_run_args` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`editor/script/search_in_file_extensions` | ``PackedStringArray("gd", "gdshader")`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`editor/script/templates_search_path` | ``"res://script_templates"`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`filesystem/import/blender/enabled` | ``true`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`filesystem/import/fbx/enabled` | ``true`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`gui/common/default_scroll_deadzone` | ``0`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`gui/common/swap_cancel_ok` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`gui/common/text_edit_undo_stack_max_size` | ``1024`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`gui/theme/custom` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`gui/theme/custom_font` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`gui/theme/default_font_antialiasing` | ``1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`gui/theme/default_font_generate_mipmaps` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`gui/theme/default_font_hinting` | ``1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`gui/theme/default_font_multichannel_signed_distance_field` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`gui/theme/default_font_subpixel_positioning` | ``1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`gui/theme/default_theme_scale` | ``1.0`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`gui/theme/lcd_subpixel_layout` | ``1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`gui/timers/incremental_search_max_interval_msec` | ``2000`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`gui/timers/text_edit_idle_detect_sec` | ``3`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`gui/timers/tooltip_delay_sec` | ``0.5`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_accept` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_cancel` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_copy` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_cut` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_down` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_end` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_filedialog_refresh` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_filedialog_show_hidden` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_filedialog_up_one_level` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_focus_next` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_focus_prev` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_graph_delete` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_graph_duplicate` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_home` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_left` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_menu` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_page_down` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_page_up` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_paste` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_redo` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_right` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_select` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_swap_input_direction` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_text_backspace` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_text_backspace_all_to_left` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_text_backspace_all_to_left.macos` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_text_backspace_word` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_text_backspace_word.macos` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_text_caret_document_end` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_text_caret_document_end.macos` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_text_caret_document_start` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_text_caret_document_start.macos` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_text_caret_down` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_text_caret_left` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_text_caret_line_end` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_text_caret_line_end.macos` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_text_caret_line_start` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_text_caret_line_start.macos` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_text_caret_page_down` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_text_caret_page_up` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_text_caret_right` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_text_caret_up` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_text_caret_word_left` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_text_caret_word_left.macos` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_text_caret_word_right` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_text_caret_word_right.macos` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_text_completion_accept` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_text_completion_query` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_text_completion_replace` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_text_dedent` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_text_delete` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_text_delete_all_to_right` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_text_delete_all_to_right.macos` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_text_delete_word` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_text_delete_word.macos` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_text_indent` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_text_newline` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_text_newline_above` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_text_newline_blank` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_text_scroll_down` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_text_scroll_down.macos` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_text_scroll_up` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_text_scroll_up.macos` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_text_select_all` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_text_select_word_under_caret` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_text_submit` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_text_toggle_insert_mode` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_undo` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`input/ui_up` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`input_devices/buffering/agile_event_flushing` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`input_devices/pen_tablet/driver` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`input_devices/pen_tablet/driver.windows` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`input_devices/pointing/emulate_mouse_from_touch` | ``true`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`input_devices/pointing/emulate_touch_from_mouse` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`input_devices/pointing/ios/touch_delay` | ``0.15`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`internationalization/locale/fallback` | ``"en"`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`internationalization/locale/include_text_server_data` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`internationalization/locale/test` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`internationalization/locale/translation_remaps` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`internationalization/locale/translations` | | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`internationalization/pseudolocalization/double_vowels` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`internationalization/pseudolocalization/expansion_ratio` | ``0.0`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`internationalization/pseudolocalization/fake_bidi` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`internationalization/pseudolocalization/override` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`internationalization/pseudolocalization/prefix` | ``"["`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`internationalization/pseudolocalization/replace_with_accents` | ``true`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`internationalization/pseudolocalization/skip_placeholders` | ``true`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`internationalization/pseudolocalization/suffix` | ``"]"`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`internationalization/pseudolocalization/use_pseudolocalization` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`internationalization/rendering/force_right_to_left_layout_direction` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`internationalization/rendering/text_driver` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_1` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_10` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_11` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_12` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_13` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_14` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_15` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_16` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_17` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_18` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_19` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_2` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_20` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_21` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_22` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_23` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_24` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_25` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_26` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_27` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_28` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_29` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_3` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_30` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_31` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_32` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_4` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_5` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_6` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_7` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_8` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_navigation/layer_9` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_1` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_10` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_11` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_12` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_13` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_14` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_15` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_16` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_17` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_18` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_19` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_2` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_20` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_21` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_22` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_23` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_24` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_25` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_26` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_27` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_28` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_29` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_3` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_30` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_31` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_32` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_4` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_5` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_6` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_7` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_8` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_physics/layer_9` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_1` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_10` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_11` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_12` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_13` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_14` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_15` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_16` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_17` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_18` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_19` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_2` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_20` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_3` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_4` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_5` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_6` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_7` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_8` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/2d_render/layer_9` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_1` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_10` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_11` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_12` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_13` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_14` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_15` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_16` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_17` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_18` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_19` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_2` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_20` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_21` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_22` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_23` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_24` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_25` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_26` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_27` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_28` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_29` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_3` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_30` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_31` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_32` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_4` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_5` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_6` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_7` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_8` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_navigation/layer_9` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_1` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_10` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_11` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_12` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_13` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_14` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_15` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_16` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_17` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_18` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_19` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_2` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_20` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_21` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_22` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_23` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_24` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_25` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_26` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_27` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_28` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_29` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_3` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_30` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_31` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_32` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_4` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_5` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_6` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_7` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_8` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_physics/layer_9` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_1` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_10` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_11` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_12` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_13` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_14` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_15` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_16` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_17` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_18` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_19` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_2` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_20` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_3` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_4` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_5` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_6` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_7` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_8` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`layer_names/3d_render/layer_9` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`memory/limits/message_queue/max_size_kb` | ``4096`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`memory/limits/multithreaded_server/rid_pool_prealloc` | ``60`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`navigation/2d/default_cell_size` | ``1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`navigation/2d/default_edge_connection_margin` | ``1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`navigation/2d/default_link_connection_radius` | ``4`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`navigation/3d/default_cell_size` | ``0.25`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`navigation/3d/default_edge_connection_margin` | ``0.25`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`navigation/3d/default_link_connection_radius` | ``1.0`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/debugger/max_chars_per_second` | ``32768`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/debugger/max_errors_per_second` | ``400`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/debugger/max_queued_messages` | ``2048`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/debugger/max_warnings_per_second` | ``400`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/packet_peer_stream/max_buffer_po2` | ``16`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/tcp/connect_timeout_seconds` | ``30`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/limits/webrtc/max_channel_in_buffer_kb` | ``64`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/remote_fs/page_read_ahead` | ``4`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`network/remote_fs/page_size` | ``65536`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`network/tls/certificate_bundle_override` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`physics/2d/default_angular_damp` | ``1.0`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`physics/2d/default_gravity` | ``980.0`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`physics/2d/default_gravity_vector` | ``Vector2(0, 1)`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`physics/2d/default_linear_damp` | ``0.1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`physics/2d/physics_engine` | ``"DEFAULT"`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`physics/2d/run_on_separate_thread` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`physics/2d/sleep_threshold_angular` | ``0.139626`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`physics/2d/sleep_threshold_linear` | ``2.0`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`physics/2d/solver/contact_max_allowed_penetration` | ``0.3`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`physics/2d/solver/contact_max_separation` | ``1.5`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`physics/2d/solver/contact_recycle_radius` | ``1.0`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`physics/2d/solver/default_constraint_bias` | ``0.2`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`physics/2d/solver/default_contact_bias` | ``0.8`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`physics/2d/solver/solver_iterations` | ``16`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`physics/2d/time_before_sleep` | ``0.5`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`physics/3d/default_angular_damp` | ``0.1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`physics/3d/default_gravity` | ``9.8`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Vector3` | :ref:`physics/3d/default_gravity_vector` | ``Vector3(0, -1, 0)`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`physics/3d/default_linear_damp` | ``0.1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`physics/3d/physics_engine` | ``"DEFAULT"`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`physics/3d/run_on_separate_thread` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`physics/3d/sleep_threshold_angular` | ``0.139626`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`physics/3d/sleep_threshold_linear` | ``0.1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`physics/3d/solver/contact_max_allowed_penetration` | ``0.01`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`physics/3d/solver/contact_max_separation` | ``0.05`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`physics/3d/solver/contact_recycle_radius` | ``0.01`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`physics/3d/solver/default_contact_bias` | ``0.8`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`physics/3d/solver/solver_iterations` | ``16`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`physics/3d/time_before_sleep` | ``0.5`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`physics/common/enable_object_picking` | ``true`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`physics/common/physics_jitter_fix` | ``0.5`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`physics/common/physics_ticks_per_second` | ``60`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/2d/sdf/oversize` | ``1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/2d/sdf/scale` | ``1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/2d/shadow_atlas/size` | ``2048`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/2d/snap/snap_2d_transforms_to_pixel` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/2d/snap/snap_2d_vertices_to_pixel` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/anti_aliasing/quality/msaa_2d` | ``0`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/anti_aliasing/quality/msaa_3d` | ``0`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/anti_aliasing/quality/screen_space_aa` | ``0`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/anti_aliasing/quality/use_debanding` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/anti_aliasing/quality/use_taa` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`rendering/anti_aliasing/screen_space_roughness_limiter/amount` | ``0.25`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/anti_aliasing/screen_space_roughness_limiter/enabled` | ``true`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`rendering/anti_aliasing/screen_space_roughness_limiter/limit` | ``0.18`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/camera/depth_of_field/depth_of_field_bokeh_quality` | ``1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/camera/depth_of_field/depth_of_field_bokeh_shape` | ``1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/camera/depth_of_field/depth_of_field_use_jitter` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`rendering/driver/depth_prepass/disable_for_vendors` | ``"PowerVR,Mali,Adreno,Apple"`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/driver/depth_prepass/enable` | ``true`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`rendering/driver/driver_name` | ``"vulkan"`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/driver/threads/thread_model` | ``1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`rendering/environment/defaults/default_clear_color` | ``Color(0.3, 0.3, 0.3, 1)`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`rendering/environment/defaults/default_environment` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/environment/glow/upscale_mode` | ``1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/environment/glow/upscale_mode.mobile` | ``0`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/environment/glow/use_high_quality` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/environment/screen_space_reflection/roughness_quality` | ``1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`rendering/environment/ssao/adaptive_target` | ``0.5`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/environment/ssao/blur_passes` | ``2`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`rendering/environment/ssao/fadeout_from` | ``50.0`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`rendering/environment/ssao/fadeout_to` | ``300.0`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/environment/ssao/half_size` | ``true`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/environment/ssao/quality` | ``2`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`rendering/environment/ssil/adaptive_target` | ``0.5`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/environment/ssil/blur_passes` | ``4`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`rendering/environment/ssil/fadeout_from` | ``50.0`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`rendering/environment/ssil/fadeout_to` | ``300.0`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/environment/ssil/half_size` | ``true`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/environment/ssil/quality` | ``2`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`rendering/environment/subsurface_scattering/subsurface_scattering_depth_scale` | ``0.01`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/environment/subsurface_scattering/subsurface_scattering_quality` | ``1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`rendering/environment/subsurface_scattering/subsurface_scattering_scale` | ``0.05`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/environment/volumetric_fog/use_filter` | ``1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/environment/volumetric_fog/volume_depth` | ``64`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/environment/volumetric_fog/volume_size` | ``64`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/global_illumination/gi/use_half_resolution` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/global_illumination/sdfgi/frames_to_converge` | ``5`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/global_illumination/sdfgi/frames_to_update_lights` | ``2`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/global_illumination/sdfgi/probe_ray_count` | ``1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/global_illumination/voxel_gi/quality` | ``0`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/lightmapping/bake_performance/max_rays_per_pass` | ``32`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/lightmapping/bake_performance/max_rays_per_probe_pass` | ``64`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/lightmapping/bake_performance/region_size` | ``512`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/lightmapping/bake_quality/high_quality_probe_ray_count` | ``512`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/lightmapping/bake_quality/high_quality_ray_count` | ``256`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/lightmapping/bake_quality/low_quality_probe_ray_count` | ``64`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/lightmapping/bake_quality/low_quality_ray_count` | ``16`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/lightmapping/bake_quality/medium_quality_probe_ray_count` | ``256`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/lightmapping/bake_quality/medium_quality_ray_count` | ``64`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/lightmapping/bake_quality/ultra_quality_probe_ray_count` | ``2048`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/lightmapping/bake_quality/ultra_quality_ray_count` | ``1024`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`rendering/lightmapping/probe_capture/update_speed` | ``15`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/lights_and_shadows/directional_shadow/16_bits` | ``true`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/lights_and_shadows/directional_shadow/size` | ``4096`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/lights_and_shadows/directional_shadow/size.mobile` | ``2048`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/lights_and_shadows/directional_shadow/soft_shadow_filter_quality` | ``2`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/lights_and_shadows/directional_shadow/soft_shadow_filter_quality.mobile` | ``0`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/lights_and_shadows/positional_shadow/atlas_16_bits` | ``true`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/lights_and_shadows/positional_shadow/atlas_quadrant_0_subdiv` | ``2`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/lights_and_shadows/positional_shadow/atlas_quadrant_1_subdiv` | ``2`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/lights_and_shadows/positional_shadow/atlas_quadrant_2_subdiv` | ``3`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/lights_and_shadows/positional_shadow/atlas_quadrant_3_subdiv` | ``4`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/lights_and_shadows/positional_shadow/atlas_size` | ``4096`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/lights_and_shadows/positional_shadow/atlas_size.mobile` | ``2048`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/lights_and_shadows/positional_shadow/soft_shadow_filter_quality` | ``2`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/lights_and_shadows/positional_shadow/soft_shadow_filter_quality.mobile` | ``0`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/lights_and_shadows/use_physical_light_units` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`rendering/limits/cluster_builder/max_clustered_elements` | ``512`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/limits/forward_renderer/threaded_render_minimum_instances` | ``500`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/limits/global_shader_variables/buffer_size` | ``65536`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/limits/opengl/max_lights_per_object` | ``8`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/limits/opengl/max_renderable_elements` | ``65536`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/limits/opengl/max_renderable_lights` | ``32`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/limits/spatial_indexer/threaded_cull_minimum_instances` | ``1000`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/limits/spatial_indexer/update_iterations_per_frame` | ``10`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`rendering/limits/time/time_rollover_secs` | ``3600`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`rendering/mesh_lod/lod_change/threshold_pixels` | ``1.0`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/occlusion_culling/bvh_build_quality` | ``2`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/occlusion_culling/occlusion_rays_per_thread` | ``512`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/occlusion_culling/use_occlusion_culling` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/reflections/reflection_atlas/reflection_count` | ``64`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/reflections/reflection_atlas/reflection_size` | ``256`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/reflections/reflection_atlas/reflection_size.mobile` | ``128`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/reflections/sky_reflections/fast_filter_high_quality` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/reflections/sky_reflections/ggx_samples` | ``32`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/reflections/sky_reflections/ggx_samples.mobile` | ``16`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/reflections/sky_reflections/roughness_layers` | ``8`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/reflections/sky_reflections/texture_array_reflections` | ``true`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/reflections/sky_reflections/texture_array_reflections.mobile` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`rendering/scaling_3d/fsr_sharpness` | ``0.2`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/scaling_3d/mode` | ``0`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`rendering/scaling_3d/scale` | ``1.0`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/shader_compiler/shader_cache/compress` | ``true`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/shader_compiler/shader_cache/enabled` | ``true`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/shader_compiler/shader_cache/strip_debug` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/shader_compiler/shader_cache/strip_debug.release` | ``true`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/shader_compiler/shader_cache/use_zstd_compression` | ``true`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/shading/overrides/force_lambert_over_burley` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/shading/overrides/force_lambert_over_burley.mobile` | ``true`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/shading/overrides/force_vertex_shading` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/shading/overrides/force_vertex_shading.mobile` | ``true`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/textures/decals/filter` | ``3`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/textures/default_filters/anisotropic_filtering_level` | ``2`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`rendering/textures/default_filters/texture_mipmap_bias` | ``0.0`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/textures/default_filters/use_nearest_mipmap_filter` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/textures/light_projectors/filter` | ``3`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/textures/lossless_compression/force_png` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/textures/lossless_compression/webp_compression_level` | ``2`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/textures/vram_compression/import_bptc` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/textures/vram_compression/import_etc` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/textures/vram_compression/import_etc2` | ``true`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`rendering/textures/vram_compression/import_s3tc` | ``true`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/vrs/mode` | ``0`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`rendering/vrs/texture` | ``""`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/vulkan/descriptor_pools/max_descriptors_per_pool` | ``64`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/vulkan/rendering/back_end` | ``0`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/vulkan/rendering/back_end.mobile` | ``1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/vulkan/staging_buffer/block_size_kb` | ``256`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/vulkan/staging_buffer/max_size_mb` | ``128`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`rendering/vulkan/staging_buffer/texture_upload_region_size_px` | ``64`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`threading/worker_pool/low_priority_thread_ratio` | ``0.3`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`threading/worker_pool/max_threads` | ``-1`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`threading/worker_pool/use_system_threads_for_low_priority_tasks` | ``true`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`xr/openxr/default_action_map` | ``"res://openxr_action_map.tres"`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`xr/openxr/enabled` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`xr/openxr/form_factor` | ``"0"`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`xr/openxr/reference_space` | ``"1"`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`xr/openxr/view_configuration` | ``"1"`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`xr/shaders/enabled` | ``false`` | ++---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ Methods ------- @@ -1645,6 +1657,8 @@ The ``Dummy`` audio driver disables all audio playback and recording, which is u If ``true``, microphone input will be allowed. This requires appropriate permissions to be set when exporting to Android or iOS. +\ **Note:** If the operating system blocks access to audio input devices (due to the user's privacy settings), audio capture will only return silence. On Windows 10 and later, make sure that apps are allowed to access the microphone in the OS' privacy settings. + ---- .. _class_ProjectSettings_property_audio/driver/mix_rate: @@ -2409,18 +2423,6 @@ Color of the collision shapes, visible when "Visible Collision Shapes" is enable ---- -.. _class_ProjectSettings_property_debug/shapes/navigation/disabled_geometry_color: - -- :ref:`Color` **debug/shapes/navigation/disabled_geometry_color** - -+-----------+-----------------------------+ -| *Default* | ``Color(1, 0.7, 0.1, 0.4)`` | -+-----------+-----------------------------+ - -Color of the disabled navigation geometry, visible when "Visible Navigation" is enabled in the Debug menu. - ----- - .. _class_ProjectSettings_property_debug/shapes/navigation/edge_connection_color: - :ref:`Color` **debug/shapes/navigation/edge_connection_color** @@ -2493,15 +2495,27 @@ If enabled, colorizes each navigation mesh polygon face with a random color when ---- -.. _class_ProjectSettings_property_debug/shapes/navigation/geometry_color: +.. _class_ProjectSettings_property_debug/shapes/navigation/enable_link_connections: -- :ref:`Color` **debug/shapes/navigation/geometry_color** +- :ref:`bool` **debug/shapes/navigation/enable_link_connections** -+-----------+-----------------------------+ -| *Default* | ``Color(0.1, 1, 0.7, 0.4)`` | -+-----------+-----------------------------+ ++-----------+----------+ +| *Default* | ``true`` | ++-----------+----------+ -Color of the navigation geometry, visible when "Visible Navigation" is enabled in the Debug menu. +If enabled, displays navigation link connections when "Visible Navigation" is enabled in the Debug menu. + +---- + +.. _class_ProjectSettings_property_debug/shapes/navigation/enable_link_connections_xray: + +- :ref:`bool` **debug/shapes/navigation/enable_link_connections_xray** + ++-----------+----------+ +| *Default* | ``true`` | ++-----------+----------+ + +If enabled, displays navigation link connections through geometry when "Visible Navigation" is enabled in the Debug menu. ---- @@ -2553,6 +2567,30 @@ Color to display disabled navigation mesh polygon faces, visible when "Visible N ---- +.. _class_ProjectSettings_property_debug/shapes/navigation/link_connection_color: + +- :ref:`Color` **debug/shapes/navigation/link_connection_color** + ++-----------+-------------------------+ +| *Default* | ``Color(1, 0.5, 1, 1)`` | ++-----------+-------------------------+ + +Color to use to display navigation link connections, visible when "Visible Navigation" is enabled in the Debug menu. + +---- + +.. _class_ProjectSettings_property_debug/shapes/navigation/link_connection_disabled_color: + +- :ref:`Color` **debug/shapes/navigation/link_connection_disabled_color** + ++-----------+-----------------------------+ +| *Default* | ``Color(0.5, 0.5, 0.5, 1)`` | ++-----------+-----------------------------+ + +Color to use to display disabled navigation link connections, visible when "Visible Navigation" is enabled in the Debug menu. + +---- + .. _class_ProjectSettings_property_debug/shapes/paths/geometry_color: - :ref:`Color` **debug/shapes/paths/geometry_color** @@ -2677,6 +2715,18 @@ If ``true``, the home indicator is hidden automatically. This only affects iOS d ---- +.. _class_ProjectSettings_property_display/window/per_pixel_transparency/allowed: + +- :ref:`bool` **display/window/per_pixel_transparency/allowed** + ++-----------+-----------+ +| *Default* | ``false`` | ++-----------+-----------+ + +If ``true``, allows per-pixel transparency for the window background. This affects performance, so leave it on ``false`` unless you need it. + +---- + .. _class_ProjectSettings_property_display/window/size/always_on_top: - :ref:`bool` **display/window/size/always_on_top** @@ -5969,6 +6019,18 @@ Default edge connection margin for 2D navigation maps. See :ref:`NavigationServe ---- +.. _class_ProjectSettings_property_navigation/2d/default_link_connection_radius: + +- :ref:`int` **navigation/2d/default_link_connection_radius** + ++-----------+-------+ +| *Default* | ``4`` | ++-----------+-------+ + +Default link connection radius for 2D navigation maps. See :ref:`NavigationServer2D.map_set_link_connection_radius`. + +---- + .. _class_ProjectSettings_property_navigation/3d/default_cell_size: - :ref:`float` **navigation/3d/default_cell_size** @@ -5993,6 +6055,18 @@ Default edge connection margin for 3D navigation maps. See :ref:`NavigationServe ---- +.. _class_ProjectSettings_property_navigation/3d/default_link_connection_radius: + +- :ref:`float` **navigation/3d/default_link_connection_radius** + ++-----------+---------+ +| *Default* | ``1.0`` | ++-----------+---------+ + +Default link connection radius for 3D navigation maps. See :ref:`NavigationServer3D.map_set_link_connection_radius`. + +---- + .. _class_ProjectSettings_property_network/limits/debugger/max_chars_per_second: - :ref:`int` **network/limits/debugger/max_chars_per_second** @@ -6101,15 +6175,15 @@ Page size used by remote filesystem (in bytes). ---- -.. _class_ProjectSettings_property_network/ssl/certificate_bundle_override: +.. _class_ProjectSettings_property_network/tls/certificate_bundle_override: -- :ref:`String` **network/ssl/certificate_bundle_override** +- :ref:`String` **network/tls/certificate_bundle_override** +-----------+--------+ | *Default* | ``""`` | +-----------+--------+ -The CA certificates bundle to use for SSL connections. If this is set to a non-empty value, this will *override* Godot's default `Mozilla certificate bundle `__. If left empty, the default certificate bundle will be used. +The CA certificates bundle to use for TLS connections. If this is set to a non-empty value, this will *override* Godot's default `Mozilla certificate bundle `__. If left empty, the default certificate bundle will be used. If in doubt, leave this setting empty. @@ -7315,6 +7389,194 @@ The framerate-independent update speed when representing dynamic object lighting ---- +.. _class_ProjectSettings_property_rendering/lights_and_shadows/directional_shadow/16_bits: + +- :ref:`bool` **rendering/lights_and_shadows/directional_shadow/16_bits** + ++-----------+----------+ +| *Default* | ``true`` | ++-----------+----------+ + +Use 16 bits for shadow depth map. Enabling this results in shadows having less precision and may result in shadow acne, but can lead to performance improvements on some devices. + +---- + +.. _class_ProjectSettings_property_rendering/lights_and_shadows/directional_shadow/size: + +- :ref:`int` **rendering/lights_and_shadows/directional_shadow/size** + ++-----------+----------+ +| *Default* | ``4096`` | ++-----------+----------+ + +The directional shadow's size in pixels. Higher values will result in sharper shadows, at the cost of performance. The value will be rounded up to the nearest power of 2. + +---- + +.. _class_ProjectSettings_property_rendering/lights_and_shadows/directional_shadow/size.mobile: + +- :ref:`int` **rendering/lights_and_shadows/directional_shadow/size.mobile** + ++-----------+----------+ +| *Default* | ``2048`` | ++-----------+----------+ + +Lower-end override for :ref:`rendering/lights_and_shadows/directional_shadow/size` on mobile devices, due to performance concerns or driver support. + +---- + +.. _class_ProjectSettings_property_rendering/lights_and_shadows/directional_shadow/soft_shadow_filter_quality: + +- :ref:`int` **rendering/lights_and_shadows/directional_shadow/soft_shadow_filter_quality** + ++-----------+-------+ +| *Default* | ``2`` | ++-----------+-------+ + +Quality setting for shadows cast by :ref:`DirectionalLight3D`\ s. Higher quality settings use more samples when reading from shadow maps and are thus slower. Low quality settings may result in shadows looking grainy. + +\ **Note:** The Soft Very Low setting will automatically multiply *constant* shadow blur by 0.75x to reduce the amount of noise visible. This automatic blur change only affects the constant blur factor defined in :ref:`Light3D.shadow_blur`, not the variable blur performed by :ref:`DirectionalLight3D`\ s' :ref:`Light3D.light_angular_distance`. + +\ **Note:** The Soft High and Soft Ultra settings will automatically multiply *constant* shadow blur by 1.5× and 2× respectively to make better use of the increased sample count. This increased blur also improves stability of dynamic object shadows. + +---- + +.. _class_ProjectSettings_property_rendering/lights_and_shadows/directional_shadow/soft_shadow_filter_quality.mobile: + +- :ref:`int` **rendering/lights_and_shadows/directional_shadow/soft_shadow_filter_quality.mobile** + ++-----------+-------+ +| *Default* | ``0`` | ++-----------+-------+ + +Lower-end override for :ref:`rendering/lights_and_shadows/directional_shadow/soft_shadow_filter_quality` on mobile devices, due to performance concerns or driver support. + +---- + +.. _class_ProjectSettings_property_rendering/lights_and_shadows/positional_shadow/atlas_16_bits: + +- :ref:`bool` **rendering/lights_and_shadows/positional_shadow/atlas_16_bits** + ++-----------+----------+ +| *Default* | ``true`` | ++-----------+----------+ + +Use 16 bits for shadow depth map. Enabling this results in shadows having less precision and may result in shadow acne, but can lead to performance improvements on some devices. + +---- + +.. _class_ProjectSettings_property_rendering/lights_and_shadows/positional_shadow/atlas_quadrant_0_subdiv: + +- :ref:`int` **rendering/lights_and_shadows/positional_shadow/atlas_quadrant_0_subdiv** + ++-----------+-------+ +| *Default* | ``2`` | ++-----------+-------+ + +Subdivision quadrant size for shadow mapping. See shadow mapping documentation. + +---- + +.. _class_ProjectSettings_property_rendering/lights_and_shadows/positional_shadow/atlas_quadrant_1_subdiv: + +- :ref:`int` **rendering/lights_and_shadows/positional_shadow/atlas_quadrant_1_subdiv** + ++-----------+-------+ +| *Default* | ``2`` | ++-----------+-------+ + +Subdivision quadrant size for shadow mapping. See shadow mapping documentation. + +---- + +.. _class_ProjectSettings_property_rendering/lights_and_shadows/positional_shadow/atlas_quadrant_2_subdiv: + +- :ref:`int` **rendering/lights_and_shadows/positional_shadow/atlas_quadrant_2_subdiv** + ++-----------+-------+ +| *Default* | ``3`` | ++-----------+-------+ + +Subdivision quadrant size for shadow mapping. See shadow mapping documentation. + +---- + +.. _class_ProjectSettings_property_rendering/lights_and_shadows/positional_shadow/atlas_quadrant_3_subdiv: + +- :ref:`int` **rendering/lights_and_shadows/positional_shadow/atlas_quadrant_3_subdiv** + ++-----------+-------+ +| *Default* | ``4`` | ++-----------+-------+ + +Subdivision quadrant size for shadow mapping. See shadow mapping documentation. + +---- + +.. _class_ProjectSettings_property_rendering/lights_and_shadows/positional_shadow/atlas_size: + +- :ref:`int` **rendering/lights_and_shadows/positional_shadow/atlas_size** + ++-----------+----------+ +| *Default* | ``4096`` | ++-----------+----------+ + +Size for shadow atlas (used for OmniLights and SpotLights). See documentation. + +---- + +.. _class_ProjectSettings_property_rendering/lights_and_shadows/positional_shadow/atlas_size.mobile: + +- :ref:`int` **rendering/lights_and_shadows/positional_shadow/atlas_size.mobile** + ++-----------+----------+ +| *Default* | ``2048`` | ++-----------+----------+ + +Lower-end override for :ref:`rendering/lights_and_shadows/positional_shadow/atlas_size` on mobile devices, due to performance concerns or driver support. + +---- + +.. _class_ProjectSettings_property_rendering/lights_and_shadows/positional_shadow/soft_shadow_filter_quality: + +- :ref:`int` **rendering/lights_and_shadows/positional_shadow/soft_shadow_filter_quality** + ++-----------+-------+ +| *Default* | ``2`` | ++-----------+-------+ + +Quality setting for shadows cast by :ref:`OmniLight3D`\ s and :ref:`SpotLight3D`\ s. Higher quality settings use more samples when reading from shadow maps and are thus slower. Low quality settings may result in shadows looking grainy. + +\ **Note:** The Soft Very Low setting will automatically multiply *constant* shadow blur by 0.75x to reduce the amount of noise visible. This automatic blur change only affects the constant blur factor defined in :ref:`Light3D.shadow_blur`, not the variable blur performed by :ref:`DirectionalLight3D`\ s' :ref:`Light3D.light_angular_distance`. + +\ **Note:** The Soft High and Soft Ultra settings will automatically multiply shadow blur by 1.5× and 2× respectively to make better use of the increased sample count. This increased blur also improves stability of dynamic object shadows. + +---- + +.. _class_ProjectSettings_property_rendering/lights_and_shadows/positional_shadow/soft_shadow_filter_quality.mobile: + +- :ref:`int` **rendering/lights_and_shadows/positional_shadow/soft_shadow_filter_quality.mobile** + ++-----------+-------+ +| *Default* | ``0`` | ++-----------+-------+ + +Lower-end override for :ref:`rendering/lights_and_shadows/positional_shadow/soft_shadow_filter_quality` on mobile devices, due to performance concerns or driver support. + +---- + +.. _class_ProjectSettings_property_rendering/lights_and_shadows/use_physical_light_units: + +- :ref:`bool` **rendering/lights_and_shadows/use_physical_light_units** + ++-----------+-----------+ +| *Default* | ``false`` | ++-----------+-----------+ + +Enables the use of physically based units for light sources. Physically based units tend to be much larger than the arbitrary units used by Godot, but they can be used to match lighting within Godot to real-world lighting. Due to the large dynamic range of lighting conditions present in nature, Godot bakes exposure into the various lighting quantities before rendering. Most light sources bake exposure automatically at run time based on the active :ref:`CameraAttributes` resource, but :ref:`LightmapGI` and :ref:`VoxelGI` require a :ref:`CameraAttributes` resource to be set at bake time to reduce the dynamic range. At run time, Godot will automatically reconcile the baked exposure with the active exposure to ensure lighting remains consistent. + +---- + .. _class_ProjectSettings_property_rendering/limits/cluster_builder/max_clustered_elements: - :ref:`float` **rendering/limits/cluster_builder/max_clustered_elements** @@ -7707,178 +7969,6 @@ Lower-end override for :ref:`rendering/shading/overrides/force_vertex_shading` **rendering/shadows/directional_shadow/16_bits** - -+-----------+----------+ -| *Default* | ``true`` | -+-----------+----------+ - ----- - -.. _class_ProjectSettings_property_rendering/shadows/directional_shadow/size: - -- :ref:`int` **rendering/shadows/directional_shadow/size** - -+-----------+----------+ -| *Default* | ``4096`` | -+-----------+----------+ - -The directional shadow's size in pixels. Higher values will result in sharper shadows, at the cost of performance. The value will be rounded up to the nearest power of 2. - ----- - -.. _class_ProjectSettings_property_rendering/shadows/directional_shadow/size.mobile: - -- :ref:`int` **rendering/shadows/directional_shadow/size.mobile** - -+-----------+----------+ -| *Default* | ``2048`` | -+-----------+----------+ - -Lower-end override for :ref:`rendering/shadows/directional_shadow/size` on mobile devices, due to performance concerns or driver support. - ----- - -.. _class_ProjectSettings_property_rendering/shadows/directional_shadow/soft_shadow_filter_quality: - -- :ref:`int` **rendering/shadows/directional_shadow/soft_shadow_filter_quality** - -+-----------+-------+ -| *Default* | ``2`` | -+-----------+-------+ - -Quality setting for shadows cast by :ref:`DirectionalLight3D`\ s. Higher quality settings use more samples when reading from shadow maps and are thus slower. Low quality settings may result in shadows looking grainy. - -\ **Note:** The Soft Very Low setting will automatically multiply *constant* shadow blur by 0.75x to reduce the amount of noise visible. This automatic blur change only affects the constant blur factor defined in :ref:`Light3D.shadow_blur`, not the variable blur performed by :ref:`DirectionalLight3D`\ s' :ref:`Light3D.light_angular_distance`. - -\ **Note:** The Soft High and Soft Ultra settings will automatically multiply *constant* shadow blur by 1.5× and 2× respectively to make better use of the increased sample count. This increased blur also improves stability of dynamic object shadows. - ----- - -.. _class_ProjectSettings_property_rendering/shadows/directional_shadow/soft_shadow_filter_quality.mobile: - -- :ref:`int` **rendering/shadows/directional_shadow/soft_shadow_filter_quality.mobile** - -+-----------+-------+ -| *Default* | ``0`` | -+-----------+-------+ - -Lower-end override for :ref:`rendering/shadows/directional_shadow/soft_shadow_filter_quality` on mobile devices, due to performance concerns or driver support. - ----- - -.. _class_ProjectSettings_property_rendering/shadows/positional_shadow/atlas_16_bits: - -- :ref:`bool` **rendering/shadows/positional_shadow/atlas_16_bits** - -+-----------+----------+ -| *Default* | ``true`` | -+-----------+----------+ - ----- - -.. _class_ProjectSettings_property_rendering/shadows/positional_shadow/atlas_quadrant_0_subdiv: - -- :ref:`int` **rendering/shadows/positional_shadow/atlas_quadrant_0_subdiv** - -+-----------+-------+ -| *Default* | ``2`` | -+-----------+-------+ - -Subdivision quadrant size for shadow mapping. See shadow mapping documentation. - ----- - -.. _class_ProjectSettings_property_rendering/shadows/positional_shadow/atlas_quadrant_1_subdiv: - -- :ref:`int` **rendering/shadows/positional_shadow/atlas_quadrant_1_subdiv** - -+-----------+-------+ -| *Default* | ``2`` | -+-----------+-------+ - -Subdivision quadrant size for shadow mapping. See shadow mapping documentation. - ----- - -.. _class_ProjectSettings_property_rendering/shadows/positional_shadow/atlas_quadrant_2_subdiv: - -- :ref:`int` **rendering/shadows/positional_shadow/atlas_quadrant_2_subdiv** - -+-----------+-------+ -| *Default* | ``3`` | -+-----------+-------+ - -Subdivision quadrant size for shadow mapping. See shadow mapping documentation. - ----- - -.. _class_ProjectSettings_property_rendering/shadows/positional_shadow/atlas_quadrant_3_subdiv: - -- :ref:`int` **rendering/shadows/positional_shadow/atlas_quadrant_3_subdiv** - -+-----------+-------+ -| *Default* | ``4`` | -+-----------+-------+ - -Subdivision quadrant size for shadow mapping. See shadow mapping documentation. - ----- - -.. _class_ProjectSettings_property_rendering/shadows/positional_shadow/atlas_size: - -- :ref:`int` **rendering/shadows/positional_shadow/atlas_size** - -+-----------+----------+ -| *Default* | ``4096`` | -+-----------+----------+ - -Size for shadow atlas (used for OmniLights and SpotLights). See documentation. - ----- - -.. _class_ProjectSettings_property_rendering/shadows/positional_shadow/atlas_size.mobile: - -- :ref:`int` **rendering/shadows/positional_shadow/atlas_size.mobile** - -+-----------+----------+ -| *Default* | ``2048`` | -+-----------+----------+ - -Lower-end override for :ref:`rendering/shadows/positional_shadow/atlas_size` on mobile devices, due to performance concerns or driver support. - ----- - -.. _class_ProjectSettings_property_rendering/shadows/positional_shadow/soft_shadow_filter_quality: - -- :ref:`int` **rendering/shadows/positional_shadow/soft_shadow_filter_quality** - -+-----------+-------+ -| *Default* | ``2`` | -+-----------+-------+ - -Quality setting for shadows cast by :ref:`OmniLight3D`\ s and :ref:`SpotLight3D`\ s. Higher quality settings use more samples when reading from shadow maps and are thus slower. Low quality settings may result in shadows looking grainy. - -\ **Note:** The Soft Very Low setting will automatically multiply *constant* shadow blur by 0.75x to reduce the amount of noise visible. This automatic blur change only affects the constant blur factor defined in :ref:`Light3D.shadow_blur`, not the variable blur performed by :ref:`DirectionalLight3D`\ s' :ref:`Light3D.light_angular_distance`. - -\ **Note:** The Soft High and Soft Ultra settings will automatically multiply shadow blur by 1.5× and 2× respectively to make better use of the increased sample count. This increased blur also improves stability of dynamic object shadows. - ----- - -.. _class_ProjectSettings_property_rendering/shadows/positional_shadow/soft_shadow_filter_quality.mobile: - -- :ref:`int` **rendering/shadows/positional_shadow/soft_shadow_filter_quality.mobile** - -+-----------+-------+ -| *Default* | ``0`` | -+-----------+-------+ - -Lower-end override for :ref:`rendering/shadows/positional_shadow/soft_shadow_filter_quality` on mobile devices, due to performance concerns or driver support. - ----- - .. _class_ProjectSettings_property_rendering/textures/decals/filter: - :ref:`int` **rendering/textures/decals/filter** diff --git a/classes/class_rect2.rst b/classes/class_rect2.rst index 17020dd8e..89eb2c9ea 100644 --- a/classes/class_rect2.rst +++ b/classes/class_rect2.rst @@ -78,7 +78,7 @@ Methods +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`grow_side` **(** :ref:`int` side, :ref:`float` amount **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_no_area` **(** **)** |const| | +| :ref:`bool` | :ref:`has_area` **(** **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_point` **(** :ref:`Vector2` point **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -226,7 +226,7 @@ Returns a copy of this ``Rect2`` expanded to include a given point. - :ref:`float` **get_area** **(** **)** |const| -Returns the area of the ``Rect2``. See also :ref:`has_no_area`. +Returns the area of the ``Rect2``. See also :ref:`has_area`. ---- @@ -262,13 +262,11 @@ Returns a copy of the ``Rect2`` grown by the specified ``amount`` on the specifi ---- -.. _class_Rect2_method_has_no_area: +.. _class_Rect2_method_has_area: -- :ref:`bool` **has_no_area** **(** **)** |const| +- :ref:`bool` **has_area** **(** **)** |const| -Returns ``true`` if the ``Rect2`` is flat or empty, ``false`` otherwise. See also :ref:`get_area`. - -\ **Note:** If the ``Rect2`` has a negative size and is not flat or empty, :ref:`has_no_area` will return ``true``. +Returns ``true`` if the ``Rect2`` has area, and ``false`` if the ``Rect2`` is linear, empty, or has a negative :ref:`size`. See also :ref:`get_area`. ---- diff --git a/classes/class_rect2i.rst b/classes/class_rect2i.rst index ca55d46fb..b42d24c4f 100644 --- a/classes/class_rect2i.rst +++ b/classes/class_rect2i.rst @@ -74,7 +74,7 @@ Methods +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2i` | :ref:`grow_side` **(** :ref:`int` side, :ref:`int` amount **)** |const| | +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_no_area` **(** **)** |const| | +| :ref:`bool` | :ref:`has_area` **(** **)** |const| | +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_point` **(** :ref:`Vector2i` point **)** |const| | +---------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -216,7 +216,7 @@ Returns a copy of this ``Rect2i`` expanded so that the borders align with the gi - :ref:`int` **get_area** **(** **)** |const| -Returns the area of the ``Rect2i``. See also :ref:`has_no_area`. +Returns the area of the ``Rect2i``. See also :ref:`has_area`. ---- @@ -254,13 +254,11 @@ Returns a copy of the ``Rect2i`` grown by the specified ``amount`` on the specif ---- -.. _class_Rect2i_method_has_no_area: +.. _class_Rect2i_method_has_area: -- :ref:`bool` **has_no_area** **(** **)** |const| +- :ref:`bool` **has_area** **(** **)** |const| -Returns ``true`` if the ``Rect2i`` is flat or empty, ``false`` otherwise. See also :ref:`get_area`. - -\ **Note:** If the ``Rect2i`` has a negative size and is not flat or empty, :ref:`has_no_area` will return ``true``. +Returns ``true`` if the ``Rect2i`` has area, and ``false`` if the ``Rect2i`` is linear, empty, or has a negative :ref:`size`. See also :ref:`get_area`. ---- diff --git a/classes/class_refcounted.rst b/classes/class_refcounted.rst index 8f966fe25..b59eec315 100644 --- a/classes/class_refcounted.rst +++ b/classes/class_refcounted.rst @@ -12,7 +12,7 @@ RefCounted **Inherits:** :ref:`Object` -**Inherited By:** :ref:`AESContext`, :ref:`AStar2D`, :ref:`AStar3D`, :ref:`AStarGrid2D`, :ref:`AnimationTrackEditPlugin`, :ref:`AudioEffectInstance`, :ref:`AudioStreamPlayback`, :ref:`CameraFeed`, :ref:`CharFXTransform`, :ref:`ConfigFile`, :ref:`Crypto`, :ref:`DTLSServer`, :ref:`Directory`, :ref:`ENetConnection`, :ref:`EditorExportPlugin`, :ref:`EditorFeatureProfile`, :ref:`EditorFileSystemImportFormatSupportQuery`, :ref:`EditorInspectorPlugin`, :ref:`EditorResourceConversionPlugin`, :ref:`EditorResourcePreviewGenerator`, :ref:`EditorSceneFormatImporter`, :ref:`EditorScenePostImport`, :ref:`EditorScenePostImportPlugin`, :ref:`EditorScript`, :ref:`EditorTranslationParserPlugin`, :ref:`EditorUndoRedoManager`, :ref:`EncodedObjectAsID`, :ref:`EngineProfiler`, :ref:`Expression`, :ref:`File`, :ref:`HMACContext`, :ref:`HTTPClient`, :ref:`HashingContext`, :ref:`JSON`, :ref:`JavaClass`, :ref:`JavaScriptObject`, :ref:`KinematicCollision2D`, :ref:`KinematicCollision3D`, :ref:`Lightmapper`, :ref:`MeshDataTool`, :ref:`MultiplayerAPI`, :ref:`Mutex`, :ref:`Node3DGizmo`, :ref:`OggPacketSequencePlayback`, :ref:`PCKPacker`, :ref:`PackedDataContainerRef`, :ref:`PacketPeer`, :ref:`PhysicsPointQueryParameters2D`, :ref:`PhysicsPointQueryParameters3D`, :ref:`PhysicsRayQueryParameters2D`, :ref:`PhysicsRayQueryParameters3D`, :ref:`PhysicsShapeQueryParameters2D`, :ref:`PhysicsShapeQueryParameters3D`, :ref:`PhysicsTestMotionParameters2D`, :ref:`PhysicsTestMotionParameters3D`, :ref:`PhysicsTestMotionResult2D`, :ref:`PhysicsTestMotionResult3D`, :ref:`RDAttachmentFormat`, :ref:`RDFramebufferPass`, :ref:`RDPipelineColorBlendState`, :ref:`RDPipelineColorBlendStateAttachment`, :ref:`RDPipelineDepthStencilState`, :ref:`RDPipelineMultisampleState`, :ref:`RDPipelineRasterizationState`, :ref:`RDPipelineSpecializationConstant`, :ref:`RDSamplerState`, :ref:`RDShaderSource`, :ref:`RDTextureFormat`, :ref:`RDTextureView`, :ref:`RDUniform`, :ref:`RDVertexAttribute`, :ref:`RandomNumberGenerator`, :ref:`RegEx`, :ref:`RegExMatch`, :ref:`Resource`, :ref:`ResourceFormatLoader`, :ref:`ResourceFormatSaver`, :ref:`ResourceImporter`, :ref:`SceneState`, :ref:`SceneTreeTimer`, :ref:`Semaphore`, :ref:`SkinReference`, :ref:`StreamPeer`, :ref:`SurfaceTool`, :ref:`TCPServer`, :ref:`TextLine`, :ref:`TextParagraph`, :ref:`TextServer`, :ref:`Thread`, :ref:`TriangleMesh`, :ref:`Tween`, :ref:`Tweener`, :ref:`UDPServer`, :ref:`UPNP`, :ref:`UPNPDevice`, :ref:`WeakRef`, :ref:`WebRTCPeerConnection`, :ref:`XMLParser`, :ref:`XRInterface`, :ref:`XRPose`, :ref:`XRPositionalTracker` +**Inherited By:** :ref:`AESContext`, :ref:`AStar2D`, :ref:`AStar3D`, :ref:`AStarGrid2D`, :ref:`AnimationTrackEditPlugin`, :ref:`AudioEffectInstance`, :ref:`AudioStreamPlayback`, :ref:`CameraFeed`, :ref:`CharFXTransform`, :ref:`ConfigFile`, :ref:`Crypto`, :ref:`DTLSServer`, :ref:`Directory`, :ref:`ENetConnection`, :ref:`EditorExportPlatform`, :ref:`EditorExportPlugin`, :ref:`EditorFeatureProfile`, :ref:`EditorFileSystemImportFormatSupportQuery`, :ref:`EditorInspectorPlugin`, :ref:`EditorResourceConversionPlugin`, :ref:`EditorResourcePreviewGenerator`, :ref:`EditorSceneFormatImporter`, :ref:`EditorScenePostImport`, :ref:`EditorScenePostImportPlugin`, :ref:`EditorScript`, :ref:`EditorTranslationParserPlugin`, :ref:`EditorUndoRedoManager`, :ref:`EncodedObjectAsID`, :ref:`EngineProfiler`, :ref:`Expression`, :ref:`File`, :ref:`HMACContext`, :ref:`HTTPClient`, :ref:`HashingContext`, :ref:`JSON`, :ref:`JavaClass`, :ref:`JavaScriptObject`, :ref:`KinematicCollision2D`, :ref:`KinematicCollision3D`, :ref:`Lightmapper`, :ref:`MeshDataTool`, :ref:`MultiplayerAPI`, :ref:`Mutex`, :ref:`Node3DGizmo`, :ref:`OggPacketSequencePlayback`, :ref:`PCKPacker`, :ref:`PackedDataContainerRef`, :ref:`PacketPeer`, :ref:`PhysicsPointQueryParameters2D`, :ref:`PhysicsPointQueryParameters3D`, :ref:`PhysicsRayQueryParameters2D`, :ref:`PhysicsRayQueryParameters3D`, :ref:`PhysicsShapeQueryParameters2D`, :ref:`PhysicsShapeQueryParameters3D`, :ref:`PhysicsTestMotionParameters2D`, :ref:`PhysicsTestMotionParameters3D`, :ref:`PhysicsTestMotionResult2D`, :ref:`PhysicsTestMotionResult3D`, :ref:`RDAttachmentFormat`, :ref:`RDFramebufferPass`, :ref:`RDPipelineColorBlendState`, :ref:`RDPipelineColorBlendStateAttachment`, :ref:`RDPipelineDepthStencilState`, :ref:`RDPipelineMultisampleState`, :ref:`RDPipelineRasterizationState`, :ref:`RDPipelineSpecializationConstant`, :ref:`RDSamplerState`, :ref:`RDShaderSource`, :ref:`RDTextureFormat`, :ref:`RDTextureView`, :ref:`RDUniform`, :ref:`RDVertexAttribute`, :ref:`RandomNumberGenerator`, :ref:`RegEx`, :ref:`RegExMatch`, :ref:`Resource`, :ref:`ResourceFormatLoader`, :ref:`ResourceFormatSaver`, :ref:`ResourceImporter`, :ref:`SceneState`, :ref:`SceneTreeTimer`, :ref:`Semaphore`, :ref:`SkinReference`, :ref:`StreamPeer`, :ref:`SurfaceTool`, :ref:`TCPServer`, :ref:`TextLine`, :ref:`TextParagraph`, :ref:`TextServer`, :ref:`Thread`, :ref:`TriangleMesh`, :ref:`Tween`, :ref:`Tweener`, :ref:`UDPServer`, :ref:`UPNP`, :ref:`UPNPDevice`, :ref:`WeakRef`, :ref:`WebRTCPeerConnection`, :ref:`XMLParser`, :ref:`XRInterface`, :ref:`XRPose`, :ref:`XRPositionalTracker` Base class for reference-counted objects. diff --git a/classes/class_regexmatch.rst b/classes/class_regexmatch.rst index 9b55d9fc2..332085da5 100644 --- a/classes/class_regexmatch.rst +++ b/classes/class_regexmatch.rst @@ -22,13 +22,13 @@ Contains the results of a single :ref:`RegEx` match returned by :re Properties ---------- -+-------------------------------------+---------------------------------------------------+--------+ -| :ref:`Dictionary` | :ref:`names` | ``{}`` | -+-------------------------------------+---------------------------------------------------+--------+ -| :ref:`Array` | :ref:`strings` | ``[]`` | -+-------------------------------------+---------------------------------------------------+--------+ -| :ref:`String` | :ref:`subject` | ``""`` | -+-------------------------------------+---------------------------------------------------+--------+ ++---------------------------------------------------+---------------------------------------------------+-------------------------+ +| :ref:`Dictionary` | :ref:`names` | ``{}`` | ++---------------------------------------------------+---------------------------------------------------+-------------------------+ +| :ref:`PackedStringArray` | :ref:`strings` | ``PackedStringArray()`` | ++---------------------------------------------------+---------------------------------------------------+-------------------------+ +| :ref:`String` | :ref:`subject` | ``""`` | ++---------------------------------------------------+---------------------------------------------------+-------------------------+ Methods ------- @@ -62,13 +62,13 @@ A dictionary of named groups and its corresponding group number. Only groups tha .. _class_RegExMatch_property_strings: -- :ref:`Array` **strings** +- :ref:`PackedStringArray` **strings** -+-----------+---------------+ -| *Default* | ``[]`` | -+-----------+---------------+ -| *Getter* | get_strings() | -+-----------+---------------+ ++-----------+-------------------------+ +| *Default* | ``PackedStringArray()`` | ++-----------+-------------------------+ +| *Getter* | get_strings() | ++-----------+-------------------------+ An :ref:`Array` of the match and its capturing groups. diff --git a/classes/class_renderingdevice.rst b/classes/class_renderingdevice.rst index 4d995d60a..3085e4e8e 100644 --- a/classes/class_renderingdevice.rst +++ b/classes/class_renderingdevice.rst @@ -190,7 +190,7 @@ Methods +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`uniform_buffer_create` **(** :ref:`int` size_bytes, :ref:`PackedByteArray` data=PackedByteArray() **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`uniform_set_create` **(** :ref:`Array` uniforms, :ref:`RID` shader, :ref:`int` shader_set **)** | +| :ref:`RID` | :ref:`uniform_set_create` **(** :ref:`RDUniform[]` uniforms, :ref:`RID` shader, :ref:`int` shader_set **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`uniform_set_is_valid` **(** :ref:`RID` uniform_set **)** | +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -2764,7 +2764,7 @@ Sets blend constants for draw list, blend constants are used only if the graphic .. _class_RenderingDevice_method_uniform_set_create: -- :ref:`RID` **uniform_set_create** **(** :ref:`Array` uniforms, :ref:`RID` shader, :ref:`int` shader_set **)** +- :ref:`RID` **uniform_set_create** **(** :ref:`RDUniform[]` uniforms, :ref:`RID` shader, :ref:`int` shader_set **)** ---- diff --git a/classes/class_renderingserver.rst b/classes/class_renderingserver.rst index 675097c04..dc87af022 100644 --- a/classes/class_renderingserver.rst +++ b/classes/class_renderingserver.rst @@ -50,903 +50,909 @@ Properties Methods ------- -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image[]` | :ref:`bake_render_uv2` **(** :ref:`RID` base, :ref:`Array` material_overrides, :ref:`Vector2i` image_size **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`camera_create` **(** **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`camera_effects_create` **(** **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`camera_effects_set_custom_exposure` **(** :ref:`RID` camera_effects, :ref:`bool` enable, :ref:`float` exposure **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`camera_effects_set_dof_blur` **(** :ref:`RID` camera_effects, :ref:`bool` far_enable, :ref:`float` far_distance, :ref:`float` far_transition, :ref:`bool` near_enable, :ref:`float` near_distance, :ref:`float` near_transition, :ref:`float` amount **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`camera_effects_set_dof_blur_bokeh_shape` **(** :ref:`DOFBokehShape` shape **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`camera_effects_set_dof_blur_quality` **(** :ref:`DOFBlurQuality` quality, :ref:`bool` use_jitter **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`camera_set_camera_effects` **(** :ref:`RID` camera, :ref:`RID` effects **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`camera_set_cull_mask` **(** :ref:`RID` camera, :ref:`int` layers **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`camera_set_environment` **(** :ref:`RID` camera, :ref:`RID` env **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`camera_set_frustum` **(** :ref:`RID` camera, :ref:`float` size, :ref:`Vector2` offset, :ref:`float` z_near, :ref:`float` z_far **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`camera_set_orthogonal` **(** :ref:`RID` camera, :ref:`float` size, :ref:`float` z_near, :ref:`float` z_far **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`camera_set_perspective` **(** :ref:`RID` camera, :ref:`float` fovy_degrees, :ref:`float` z_near, :ref:`float` z_far **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`camera_set_transform` **(** :ref:`RID` camera, :ref:`Transform3D` transform **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`camera_set_use_vertical_aspect` **(** :ref:`RID` camera, :ref:`bool` enable **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`canvas_create` **(** **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_animation_slice` **(** :ref:`RID` item, :ref:`float` animation_length, :ref:`float` slice_begin, :ref:`float` slice_end, :ref:`float` offset=0.0 **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_circle` **(** :ref:`RID` item, :ref:`Vector2` pos, :ref:`float` radius, :ref:`Color` color **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_clip_ignore` **(** :ref:`RID` item, :ref:`bool` ignore **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_lcd_texture_rect_region` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`Rect2` src_rect, :ref:`Color` modulate **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_line` **(** :ref:`RID` item, :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_mesh` **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`Transform2D` transform=Transform2D(1, 0, 0, 1, 0, 0), :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`RID` texture **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_msdf_texture_rect_region` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`int` outline_size=0, :ref:`float` px_range=1.0 **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_multimesh` **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`RID` texture **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_nine_patch` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`Rect2` source, :ref:`RID` texture, :ref:`Vector2` topleft, :ref:`Vector2` bottomright, :ref:`NinePatchAxisMode` x_axis_mode=0, :ref:`NinePatchAxisMode` y_axis_mode=0, :ref:`bool` draw_center=true, :ref:`Color` modulate=Color(1, 1, 1, 1) **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_particles` **(** :ref:`RID` item, :ref:`RID` particles, :ref:`RID` texture **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_polygon` **(** :ref:`RID` item, :ref:`PackedVector2Array` points, :ref:`PackedColorArray` colors, :ref:`PackedVector2Array` uvs=PackedVector2Array(), :ref:`RID` texture **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_polyline` **(** :ref:`RID` item, :ref:`PackedVector2Array` points, :ref:`PackedColorArray` colors, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_primitive` **(** :ref:`RID` item, :ref:`PackedVector2Array` points, :ref:`PackedColorArray` colors, :ref:`PackedVector2Array` uvs, :ref:`RID` texture, :ref:`float` width=1.0 **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_rect` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`Color` color **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_set_transform` **(** :ref:`RID` item, :ref:`Transform2D` transform **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_texture_rect` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`bool` tile=false, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`bool` transpose=false **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_texture_rect_region` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`bool` transpose=false, :ref:`bool` clip_uv=true **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_add_triangle_array` **(** :ref:`RID` item, :ref:`PackedInt32Array` indices, :ref:`PackedVector2Array` points, :ref:`PackedColorArray` colors, :ref:`PackedVector2Array` uvs=PackedVector2Array(), :ref:`PackedInt32Array` bones=PackedInt32Array(), :ref:`PackedFloat32Array` weights=PackedFloat32Array(), :ref:`RID` texture, :ref:`int` count=-1 **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_clear` **(** :ref:`RID` item **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`canvas_item_create` **(** **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_canvas_group_mode` **(** :ref:`RID` item, :ref:`CanvasGroupMode` mode, :ref:`float` clear_margin=5.0, :ref:`bool` fit_empty=false, :ref:`float` fit_margin=0.0, :ref:`bool` blur_mipmaps=false **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_clip` **(** :ref:`RID` item, :ref:`bool` clip **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_copy_to_backbuffer` **(** :ref:`RID` item, :ref:`bool` enabled, :ref:`Rect2` rect **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_custom_rect` **(** :ref:`RID` item, :ref:`bool` use_custom_rect, :ref:`Rect2` rect=Rect2(0, 0, 0, 0) **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_default_texture_filter` **(** :ref:`RID` item, :ref:`CanvasItemTextureFilter` filter **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_default_texture_repeat` **(** :ref:`RID` item, :ref:`CanvasItemTextureRepeat` repeat **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_distance_field_mode` **(** :ref:`RID` item, :ref:`bool` enabled **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_draw_behind_parent` **(** :ref:`RID` item, :ref:`bool` enabled **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_draw_index` **(** :ref:`RID` item, :ref:`int` index **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_light_mask` **(** :ref:`RID` item, :ref:`int` mask **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_material` **(** :ref:`RID` item, :ref:`RID` material **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_modulate` **(** :ref:`RID` item, :ref:`Color` color **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_parent` **(** :ref:`RID` item, :ref:`RID` parent **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_self_modulate` **(** :ref:`RID` item, :ref:`Color` color **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_sort_children_by_y` **(** :ref:`RID` item, :ref:`bool` enabled **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_transform` **(** :ref:`RID` item, :ref:`Transform2D` transform **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_use_parent_material` **(** :ref:`RID` item, :ref:`bool` enabled **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_visibility_notifier` **(** :ref:`RID` item, :ref:`bool` enable, :ref:`Rect2` area, :ref:`Callable` enter_callable, :ref:`Callable` exit_callable **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_visible` **(** :ref:`RID` item, :ref:`bool` visible **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_z_as_relative_to_parent` **(** :ref:`RID` item, :ref:`bool` enabled **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_item_set_z_index` **(** :ref:`RID` item, :ref:`int` z_index **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_attach_to_canvas` **(** :ref:`RID` light, :ref:`RID` canvas **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`canvas_light_create` **(** **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_occluder_attach_to_canvas` **(** :ref:`RID` occluder, :ref:`RID` canvas **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`canvas_light_occluder_create` **(** **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_occluder_set_as_sdf_collision` **(** :ref:`RID` occluder, :ref:`bool` enable **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_occluder_set_enabled` **(** :ref:`RID` occluder, :ref:`bool` enabled **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_occluder_set_light_mask` **(** :ref:`RID` occluder, :ref:`int` mask **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_occluder_set_polygon` **(** :ref:`RID` occluder, :ref:`RID` polygon **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_occluder_set_transform` **(** :ref:`RID` occluder, :ref:`Transform2D` transform **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_color` **(** :ref:`RID` light, :ref:`Color` color **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_enabled` **(** :ref:`RID` light, :ref:`bool` enabled **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_energy` **(** :ref:`RID` light, :ref:`float` energy **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_height` **(** :ref:`RID` light, :ref:`float` height **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_item_cull_mask` **(** :ref:`RID` light, :ref:`int` mask **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_item_shadow_cull_mask` **(** :ref:`RID` light, :ref:`int` mask **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_layer_range` **(** :ref:`RID` light, :ref:`int` min_layer, :ref:`int` max_layer **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_mode` **(** :ref:`RID` light, :ref:`CanvasLightMode` mode **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_shadow_color` **(** :ref:`RID` light, :ref:`Color` color **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_shadow_enabled` **(** :ref:`RID` light, :ref:`bool` enabled **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_shadow_filter` **(** :ref:`RID` light, :ref:`CanvasLightShadowFilter` filter **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_shadow_smooth` **(** :ref:`RID` light, :ref:`float` smooth **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_texture` **(** :ref:`RID` light, :ref:`RID` texture **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_texture_offset` **(** :ref:`RID` light, :ref:`Vector2` offset **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_texture_scale` **(** :ref:`RID` light, :ref:`float` scale **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_transform` **(** :ref:`RID` light, :ref:`Transform2D` transform **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_light_set_z_range` **(** :ref:`RID` light, :ref:`int` min_z, :ref:`int` max_z **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`canvas_occluder_polygon_create` **(** **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_occluder_polygon_set_cull_mode` **(** :ref:`RID` occluder_polygon, :ref:`CanvasOccluderPolygonCullMode` mode **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_occluder_polygon_set_shape` **(** :ref:`RID` occluder_polygon, :ref:`PackedVector2Array` shape, :ref:`bool` closed **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_set_disable_scale` **(** :ref:`bool` disable **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_set_item_mirroring` **(** :ref:`RID` canvas, :ref:`RID` item, :ref:`Vector2` mirroring **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_set_modulate` **(** :ref:`RID` canvas, :ref:`Color` color **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_set_shadow_texture_size` **(** :ref:`int` size **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`canvas_texture_create` **(** **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_texture_set_channel` **(** :ref:`RID` canvas_texture, :ref:`CanvasTextureChannel` channel, :ref:`RID` texture **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_texture_set_shading_parameters` **(** :ref:`RID` canvas_texture, :ref:`Color` base_color, :ref:`float` shininess **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_texture_set_texture_filter` **(** :ref:`RID` canvas_texture, :ref:`CanvasItemTextureFilter` filter **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`canvas_texture_set_texture_repeat` **(** :ref:`RID` canvas_texture, :ref:`CanvasItemTextureRepeat` repeat **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RenderingDevice` | :ref:`create_local_rendering_device` **(** **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`decal_create` **(** **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`decal_set_albedo_mix` **(** :ref:`RID` decal, :ref:`float` albedo_mix **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`decal_set_cull_mask` **(** :ref:`RID` decal, :ref:`int` mask **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`decal_set_distance_fade` **(** :ref:`RID` decal, :ref:`bool` enabled, :ref:`float` begin, :ref:`float` length **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`decal_set_emission_energy` **(** :ref:`RID` decal, :ref:`float` energy **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`decal_set_extents` **(** :ref:`RID` decal, :ref:`Vector3` extents **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`decal_set_fade` **(** :ref:`RID` decal, :ref:`float` above, :ref:`float` below **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`decal_set_modulate` **(** :ref:`RID` decal, :ref:`Color` color **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`decal_set_normal_fade` **(** :ref:`RID` decal, :ref:`float` fade **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`decal_set_texture` **(** :ref:`RID` decal, :ref:`DecalTexture` type, :ref:`RID` texture **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`decals_set_filter` **(** :ref:`DecalFilter` filter **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`directional_light_create` **(** **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`directional_shadow_atlas_set_size` **(** :ref:`int` size, :ref:`bool` is_16bits **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`directional_soft_shadow_filter_set_quality` **(** :ref:`ShadowQuality` quality **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`environment_bake_panorama` **(** :ref:`RID` environment, :ref:`bool` bake_irradiance, :ref:`Vector2i` size **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`environment_create` **(** **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_glow_set_use_bicubic_upscale` **(** :ref:`bool` enable **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_glow_set_use_high_quality` **(** :ref:`bool` enable **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_adjustment` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` brightness, :ref:`float` contrast, :ref:`float` saturation, :ref:`bool` use_1d_color_correction, :ref:`RID` color_correction **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_ambient_light` **(** :ref:`RID` env, :ref:`Color` color, :ref:`EnvironmentAmbientSource` ambient=0, :ref:`float` energy=1.0, :ref:`float` sky_contibution=0.0, :ref:`EnvironmentReflectionSource` reflection_source=0 **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_background` **(** :ref:`RID` env, :ref:`EnvironmentBG` bg **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_bg_color` **(** :ref:`RID` env, :ref:`Color` color **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_bg_energy` **(** :ref:`RID` env, :ref:`float` energy **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_canvas_max_layer` **(** :ref:`RID` env, :ref:`int` max_layer **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_fog` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`Color` light_color, :ref:`float` light_energy, :ref:`float` sun_scatter, :ref:`float` density, :ref:`float` height, :ref:`float` height_density, :ref:`float` aerial_perspective **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_glow` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`PackedFloat32Array` levels, :ref:`float` intensity, :ref:`float` strength, :ref:`float` mix, :ref:`float` bloom_threshold, :ref:`EnvironmentGlowBlendMode` blend_mode, :ref:`float` hdr_bleed_threshold, :ref:`float` hdr_bleed_scale, :ref:`float` hdr_luminance_cap, :ref:`float` glow_map_strength, :ref:`RID` glow_map **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_sdfgi` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`int` cascades, :ref:`float` min_cell_size, :ref:`EnvironmentSDFGIYScale` y_scale, :ref:`bool` use_occlusion, :ref:`float` bounce_feedback, :ref:`bool` read_sky, :ref:`float` energy, :ref:`float` normal_bias, :ref:`float` probe_bias **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_sdfgi_frames_to_converge` **(** :ref:`EnvironmentSDFGIFramesToConverge` frames **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_sdfgi_frames_to_update_light` **(** :ref:`EnvironmentSDFGIFramesToUpdateLight` frames **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_sdfgi_ray_count` **(** :ref:`EnvironmentSDFGIRayCount` ray_count **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_sky` **(** :ref:`RID` env, :ref:`RID` sky **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_sky_custom_fov` **(** :ref:`RID` env, :ref:`float` scale **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_sky_orientation` **(** :ref:`RID` env, :ref:`Basis` orientation **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_ssao` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` radius, :ref:`float` intensity, :ref:`float` power, :ref:`float` detail, :ref:`float` horizon, :ref:`float` sharpness, :ref:`float` light_affect, :ref:`float` ao_channel_affect **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_ssao_quality` **(** :ref:`EnvironmentSSAOQuality` quality, :ref:`bool` half_size, :ref:`float` adaptive_target, :ref:`int` blur_passes, :ref:`float` fadeout_from, :ref:`float` fadeout_to **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_ssil_quality` **(** :ref:`EnvironmentSSILQuality` quality, :ref:`bool` half_size, :ref:`float` adaptive_target, :ref:`int` blur_passes, :ref:`float` fadeout_from, :ref:`float` fadeout_to **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_ssr` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`int` max_steps, :ref:`float` fade_in, :ref:`float` fade_out, :ref:`float` depth_tolerance **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_ssr_roughness_quality` **(** :ref:`EnvironmentSSRRoughnessQuality` quality **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_tonemap` **(** :ref:`RID` env, :ref:`EnvironmentToneMapper` tone_mapper, :ref:`float` exposure, :ref:`float` white, :ref:`bool` auto_exposure, :ref:`float` min_luminance, :ref:`float` max_luminance, :ref:`float` auto_exp_speed, :ref:`float` auto_exp_grey **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_volumetric_fog` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` density, :ref:`Color` albedo, :ref:`Color` emission, :ref:`float` emission_energy, :ref:`float` anisotropy, :ref:`float` length, :ref:`float` p_detail_spread, :ref:`float` gi_inject, :ref:`bool` temporal_reprojection, :ref:`float` temporal_reprojection_amount, :ref:`float` ambient_inject **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_volumetric_fog_filter_active` **(** :ref:`bool` active **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`environment_set_volumetric_fog_volume_size` **(** :ref:`int` size, :ref:`int` depth **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`fog_volume_create` **(** **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`fog_volume_set_extents` **(** :ref:`RID` fog_volume, :ref:`Vector3` extents **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`fog_volume_set_material` **(** :ref:`RID` fog_volume, :ref:`RID` material **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`fog_volume_set_shape` **(** :ref:`RID` fog_volume, :ref:`FogVolumeShape` shape **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`force_draw` **(** :ref:`bool` swap_buffers=true, :ref:`float` frame_step=0.0 **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`force_sync` **(** **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`free_rid` **(** :ref:`RID` rid **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_frame_setup_time_cpu` **(** **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RenderingDevice` | :ref:`get_rendering_device` **(** **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_rendering_info` **(** :ref:`RenderingInfo` info **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_test_cube` **(** **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_test_texture` **(** **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_video_adapter_api_version` **(** **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_video_adapter_name` **(** **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`DeviceType` | :ref:`get_video_adapter_type` **(** **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_video_adapter_vendor` **(** **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`get_white_texture` **(** **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`gi_set_use_half_resolution` **(** :ref:`bool` half_resolution **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`global_shader_uniform_add` **(** :ref:`StringName` name, :ref:`GlobalShaderUniformType` type, :ref:`Variant` default_value **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`global_shader_uniform_get` **(** :ref:`StringName` name **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedStringArray` | :ref:`global_shader_uniform_get_list` **(** **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`GlobalShaderUniformType` | :ref:`global_shader_uniform_get_type` **(** :ref:`StringName` name **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`global_shader_uniform_remove` **(** :ref:`StringName` name **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`global_shader_uniform_set` **(** :ref:`StringName` name, :ref:`Variant` value **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`global_shader_uniform_set_override` **(** :ref:`StringName` name, :ref:`Variant` value **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_changed` **(** **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_feature` **(** :ref:`Features` feature **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_os_feature` **(** :ref:`String` feature **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_attach_object_instance_id` **(** :ref:`RID` instance, :ref:`int` id **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_attach_skeleton` **(** :ref:`RID` instance, :ref:`RID` skeleton **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`instance_create` **(** **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`instance_create2` **(** :ref:`RID` base, :ref:`RID` scenario **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`instance_geometry_get_shader_uniform` **(** :ref:`RID` instance, :ref:`StringName` parameter **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`instance_geometry_get_shader_uniform_default_value` **(** :ref:`RID` instance, :ref:`StringName` parameter **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary[]` | :ref:`instance_geometry_get_shader_uniform_list` **(** :ref:`RID` instance **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_geometry_set_cast_shadows_setting` **(** :ref:`RID` instance, :ref:`ShadowCastingSetting` shadow_casting_setting **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_geometry_set_flag` **(** :ref:`RID` instance, :ref:`InstanceFlags` flag, :ref:`bool` enabled **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_geometry_set_lightmap` **(** :ref:`RID` instance, :ref:`RID` lightmap, :ref:`Rect2` lightmap_uv_scale, :ref:`int` lightmap_slice **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_geometry_set_lod_bias` **(** :ref:`RID` instance, :ref:`float` lod_bias **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_geometry_set_material_overlay` **(** :ref:`RID` instance, :ref:`RID` material **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_geometry_set_material_override` **(** :ref:`RID` instance, :ref:`RID` material **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_geometry_set_shader_uniform` **(** :ref:`RID` instance, :ref:`StringName` parameter, :ref:`Variant` value **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_geometry_set_transparency` **(** :ref:`RID` instance, :ref:`float` transparency **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_geometry_set_visibility_range` **(** :ref:`RID` instance, :ref:`float` min, :ref:`float` max, :ref:`float` min_margin, :ref:`float` max_margin, :ref:`VisibilityRangeFadeMode` fade_mode **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_base` **(** :ref:`RID` instance, :ref:`RID` base **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_blend_shape_weight` **(** :ref:`RID` instance, :ref:`int` shape, :ref:`float` weight **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_custom_aabb` **(** :ref:`RID` instance, :ref:`AABB` aabb **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_extra_visibility_margin` **(** :ref:`RID` instance, :ref:`float` margin **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_ignore_culling` **(** :ref:`RID` instance, :ref:`bool` enabled **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_layer_mask` **(** :ref:`RID` instance, :ref:`int` mask **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_scenario` **(** :ref:`RID` instance, :ref:`RID` scenario **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_surface_override_material` **(** :ref:`RID` instance, :ref:`int` surface, :ref:`RID` material **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_transform` **(** :ref:`RID` instance, :ref:`Transform3D` transform **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_visibility_parent` **(** :ref:`RID` instance, :ref:`RID` parent **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`instance_set_visible` **(** :ref:`RID` instance, :ref:`bool` visible **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedInt64Array` | :ref:`instances_cull_aabb` **(** :ref:`AABB` aabb, :ref:`RID` scenario **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedInt64Array` | :ref:`instances_cull_convex` **(** :ref:`Array` convex, :ref:`RID` scenario **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedInt64Array` | :ref:`instances_cull_ray` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`RID` scenario **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_directional_set_blend_splits` **(** :ref:`RID` light, :ref:`bool` enable **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_directional_set_shadow_mode` **(** :ref:`RID` light, :ref:`LightDirectionalShadowMode` mode **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_directional_set_sky_mode` **(** :ref:`RID` light, :ref:`LightDirectionalSkyMode` mode **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_omni_set_shadow_mode` **(** :ref:`RID` light, :ref:`LightOmniShadowMode` mode **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_projectors_set_filter` **(** :ref:`LightProjectorFilter` filter **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_set_bake_mode` **(** :ref:`RID` light, :ref:`LightBakeMode` bake_mode **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_set_color` **(** :ref:`RID` light, :ref:`Color` color **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_set_cull_mask` **(** :ref:`RID` light, :ref:`int` mask **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_set_distance_fade` **(** :ref:`RID` decal, :ref:`bool` enabled, :ref:`float` begin, :ref:`float` shadow, :ref:`float` length **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_set_max_sdfgi_cascade` **(** :ref:`RID` light, :ref:`int` cascade **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_set_negative` **(** :ref:`RID` light, :ref:`bool` enable **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_set_param` **(** :ref:`RID` light, :ref:`LightParam` param, :ref:`float` value **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_set_projector` **(** :ref:`RID` light, :ref:`RID` texture **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_set_reverse_cull_face_mode` **(** :ref:`RID` light, :ref:`bool` enabled **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`light_set_shadow` **(** :ref:`RID` light, :ref:`bool` enabled **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`lightmap_create` **(** **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedInt32Array` | :ref:`lightmap_get_probe_capture_bsp_tree` **(** :ref:`RID` lightmap **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedVector3Array` | :ref:`lightmap_get_probe_capture_points` **(** :ref:`RID` lightmap **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedColorArray` | :ref:`lightmap_get_probe_capture_sh` **(** :ref:`RID` lightmap **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedInt32Array` | :ref:`lightmap_get_probe_capture_tetrahedra` **(** :ref:`RID` lightmap **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`lightmap_set_probe_bounds` **(** :ref:`RID` lightmap, :ref:`AABB` bounds **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`lightmap_set_probe_capture_data` **(** :ref:`RID` lightmap, :ref:`PackedVector3Array` points, :ref:`PackedColorArray` point_sh, :ref:`PackedInt32Array` tetrahedra, :ref:`PackedInt32Array` bsp_tree **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`lightmap_set_probe_capture_update_speed` **(** :ref:`float` speed **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`lightmap_set_probe_interior` **(** :ref:`RID` lightmap, :ref:`bool` interior **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`lightmap_set_textures` **(** :ref:`RID` lightmap, :ref:`RID` light, :ref:`bool` uses_sh **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`make_sphere_mesh` **(** :ref:`int` latitudes, :ref:`int` longitudes, :ref:`float` radius **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`material_create` **(** **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`material_get_param` **(** :ref:`RID` material, :ref:`StringName` parameter **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`material_set_next_pass` **(** :ref:`RID` material, :ref:`RID` next_material **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`material_set_param` **(** :ref:`RID` material, :ref:`StringName` parameter, :ref:`Variant` value **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`material_set_render_priority` **(** :ref:`RID` material, :ref:`int` priority **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`material_set_shader` **(** :ref:`RID` shader_material, :ref:`RID` shader **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_add_surface` **(** :ref:`RID` mesh, :ref:`Dictionary` surface **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_add_surface_from_arrays` **(** :ref:`RID` mesh, :ref:`PrimitiveType` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[], :ref:`Dictionary` lods={}, :ref:`int` compress_format=0 **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_clear` **(** :ref:`RID` mesh **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`mesh_create` **(** **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`mesh_create_from_surfaces` **(** :ref:`Dictionary[]` surfaces, :ref:`int` blend_shape_count=0 **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mesh_get_blend_shape_count` **(** :ref:`RID` mesh **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`BlendShapeMode` | :ref:`mesh_get_blend_shape_mode` **(** :ref:`RID` mesh **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`mesh_get_custom_aabb` **(** :ref:`RID` mesh **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`mesh_get_surface` **(** :ref:`RID` mesh, :ref:`int` surface **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mesh_get_surface_count` **(** :ref:`RID` mesh **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_set_blend_shape_mode` **(** :ref:`RID` mesh, :ref:`BlendShapeMode` mode **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_set_custom_aabb` **(** :ref:`RID` mesh, :ref:`AABB` aabb **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_set_shadow_mesh` **(** :ref:`RID` mesh, :ref:`RID` shadow_mesh **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`mesh_surface_get_arrays` **(** :ref:`RID` mesh, :ref:`int` surface **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array[]` | :ref:`mesh_surface_get_blend_shape_arrays` **(** :ref:`RID` mesh, :ref:`int` surface **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mesh_surface_get_format_attribute_stride` **(** :ref:`int` format, :ref:`int` vertex_count **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mesh_surface_get_format_offset` **(** :ref:`int` format, :ref:`int` vertex_count, :ref:`int` array_index **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mesh_surface_get_format_skin_stride` **(** :ref:`int` format, :ref:`int` vertex_count **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`mesh_surface_get_format_vertex_stride` **(** :ref:`int` format, :ref:`int` vertex_count **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`mesh_surface_get_material` **(** :ref:`RID` mesh, :ref:`int` surface **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_surface_set_material` **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`RID` material **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_surface_update_attribute_region` **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`int` offset, :ref:`PackedByteArray` data **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_surface_update_skin_region` **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`int` offset, :ref:`PackedByteArray` data **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`mesh_surface_update_vertex_region` **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`int` offset, :ref:`PackedByteArray` data **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`multimesh_allocate_data` **(** :ref:`RID` multimesh, :ref:`int` instances, :ref:`MultimeshTransformFormat` transform_format, :ref:`bool` color_format=false, :ref:`bool` custom_data_format=false **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`multimesh_create` **(** **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`multimesh_get_aabb` **(** :ref:`RID` multimesh **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedFloat32Array` | :ref:`multimesh_get_buffer` **(** :ref:`RID` multimesh **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`multimesh_get_instance_count` **(** :ref:`RID` multimesh **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`multimesh_get_mesh` **(** :ref:`RID` multimesh **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`multimesh_get_visible_instances` **(** :ref:`RID` multimesh **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`multimesh_instance_get_color` **(** :ref:`RID` multimesh, :ref:`int` index **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Color` | :ref:`multimesh_instance_get_custom_data` **(** :ref:`RID` multimesh, :ref:`int` index **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform3D` | :ref:`multimesh_instance_get_transform` **(** :ref:`RID` multimesh, :ref:`int` index **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`multimesh_instance_get_transform_2d` **(** :ref:`RID` multimesh, :ref:`int` index **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`multimesh_instance_set_color` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Color` color **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`multimesh_instance_set_custom_data` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Color` custom_data **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`multimesh_instance_set_transform` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Transform3D` transform **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`multimesh_instance_set_transform_2d` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Transform2D` transform **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`multimesh_set_buffer` **(** :ref:`RID` multimesh, :ref:`PackedFloat32Array` buffer **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`multimesh_set_mesh` **(** :ref:`RID` multimesh, :ref:`RID` mesh **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`multimesh_set_visible_instances` **(** :ref:`RID` multimesh, :ref:`int` visible **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`occluder_create` **(** **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`occluder_set_mesh` **(** :ref:`RID` occluder, :ref:`PackedVector3Array` vertices, :ref:`PackedInt32Array` indices **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`omni_light_create` **(** **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`particles_collision_create` **(** **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_collision_height_field_update` **(** :ref:`RID` particles_collision **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_collision_set_attractor_attenuation` **(** :ref:`RID` particles_collision, :ref:`float` curve **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_collision_set_attractor_directionality` **(** :ref:`RID` particles_collision, :ref:`float` amount **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_collision_set_attractor_strength` **(** :ref:`RID` particles_collision, :ref:`float` setrngth **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_collision_set_box_extents` **(** :ref:`RID` particles_collision, :ref:`Vector3` extents **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_collision_set_collision_type` **(** :ref:`RID` particles_collision, :ref:`ParticlesCollisionType` type **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_collision_set_cull_mask` **(** :ref:`RID` particles_collision, :ref:`int` mask **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_collision_set_field_texture` **(** :ref:`RID` particles_collision, :ref:`RID` texture **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_collision_set_height_field_resolution` **(** :ref:`RID` particles_collision, :ref:`ParticlesCollisionHeightfieldResolution` resolution **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_collision_set_sphere_radius` **(** :ref:`RID` particles_collision, :ref:`float` radius **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`particles_create` **(** **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_emit` **(** :ref:`RID` particles, :ref:`Transform3D` transform, :ref:`Vector3` velocity, :ref:`Color` color, :ref:`Color` custom, :ref:`int` emit_flags **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`AABB` | :ref:`particles_get_current_aabb` **(** :ref:`RID` particles **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`particles_get_emitting` **(** :ref:`RID` particles **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`particles_is_inactive` **(** :ref:`RID` particles **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_request_process` **(** :ref:`RID` particles **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_restart` **(** :ref:`RID` particles **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_amount` **(** :ref:`RID` particles, :ref:`int` amount **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_collision_base_size` **(** :ref:`RID` particles, :ref:`float` size **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_custom_aabb` **(** :ref:`RID` particles, :ref:`AABB` aabb **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_draw_order` **(** :ref:`RID` particles, :ref:`ParticlesDrawOrder` order **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_draw_pass_mesh` **(** :ref:`RID` particles, :ref:`int` pass, :ref:`RID` mesh **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_draw_passes` **(** :ref:`RID` particles, :ref:`int` count **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_emission_transform` **(** :ref:`RID` particles, :ref:`Transform3D` transform **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_emitting` **(** :ref:`RID` particles, :ref:`bool` emitting **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_explosiveness_ratio` **(** :ref:`RID` particles, :ref:`float` ratio **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_fixed_fps` **(** :ref:`RID` particles, :ref:`int` fps **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_fractional_delta` **(** :ref:`RID` particles, :ref:`bool` enable **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_interpolate` **(** :ref:`RID` particles, :ref:`bool` enable **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_lifetime` **(** :ref:`RID` particles, :ref:`float` lifetime **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_mode` **(** :ref:`RID` particles, :ref:`ParticlesMode` mode **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_one_shot` **(** :ref:`RID` particles, :ref:`bool` one_shot **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_pre_process_time` **(** :ref:`RID` particles, :ref:`float` time **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_process_material` **(** :ref:`RID` particles, :ref:`RID` material **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_randomness_ratio` **(** :ref:`RID` particles, :ref:`float` ratio **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_speed_scale` **(** :ref:`RID` particles, :ref:`float` scale **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_subemitter` **(** :ref:`RID` particles, :ref:`RID` subemitter_particles **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_trail_bind_poses` **(** :ref:`RID` particles, :ref:`Transform3D[]` bind_poses **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_trails` **(** :ref:`RID` particles, :ref:`bool` enable, :ref:`float` length_sec **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_transform_align` **(** :ref:`RID` particles, :ref:`ParticlesTransformAlign` align **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`particles_set_use_local_coordinates` **(** :ref:`RID` particles, :ref:`bool` enable **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`positional_soft_shadow_filter_set_quality` **(** :ref:`ShadowQuality` quality **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`reflection_probe_create` **(** **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_ambient_color` **(** :ref:`RID` probe, :ref:`Color` color **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_ambient_energy` **(** :ref:`RID` probe, :ref:`float` energy **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_ambient_mode` **(** :ref:`RID` probe, :ref:`ReflectionProbeAmbientMode` mode **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_as_interior` **(** :ref:`RID` probe, :ref:`bool` enable **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_cull_mask` **(** :ref:`RID` probe, :ref:`int` layers **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_enable_box_projection` **(** :ref:`RID` probe, :ref:`bool` enable **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_enable_shadows` **(** :ref:`RID` probe, :ref:`bool` enable **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_extents` **(** :ref:`RID` probe, :ref:`Vector3` extents **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_intensity` **(** :ref:`RID` probe, :ref:`float` intensity **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_max_distance` **(** :ref:`RID` probe, :ref:`float` distance **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_mesh_lod_threshold` **(** :ref:`RID` probe, :ref:`float` pixels **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_origin_offset` **(** :ref:`RID` probe, :ref:`Vector3` offset **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_resolution` **(** :ref:`RID` probe, :ref:`int` resolution **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`reflection_probe_set_update_mode` **(** :ref:`RID` probe, :ref:`ReflectionProbeUpdateMode` mode **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`request_frame_drawn_callback` **(** :ref:`Callable` callable **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`scenario_create` **(** **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`scenario_set_camera_effects` **(** :ref:`RID` scenario, :ref:`RID` effects **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`scenario_set_environment` **(** :ref:`RID` scenario, :ref:`RID` environment **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`scenario_set_fallback_environment` **(** :ref:`RID` scenario, :ref:`RID` environment **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`screen_space_roughness_limiter_set_active` **(** :ref:`bool` enable, :ref:`float` amount, :ref:`float` limit **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_boot_image` **(** :ref:`Image` image, :ref:`Color` color, :ref:`bool` scale, :ref:`bool` use_filter=true **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_debug_generate_wireframes` **(** :ref:`bool` generate **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_default_clear_color` **(** :ref:`Color` color **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`shader_create` **(** **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`shader_get_code` **(** :ref:`RID` shader **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`shader_get_default_texture_param` **(** :ref:`RID` shader, :ref:`StringName` param, :ref:`int` index=0 **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`shader_get_param_default` **(** :ref:`RID` shader, :ref:`StringName` param **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary[]` | :ref:`shader_get_shader_uniform_list` **(** :ref:`RID` shader **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shader_set_code` **(** :ref:`RID` shader, :ref:`String` code **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shader_set_default_texture_param` **(** :ref:`RID` shader, :ref:`StringName` param, :ref:`RID` texture, :ref:`int` index=0 **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shader_set_path_hint` **(** :ref:`RID` shader, :ref:`String` path **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`skeleton_allocate_data` **(** :ref:`RID` skeleton, :ref:`int` bones, :ref:`bool` is_2d_skeleton=false **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform3D` | :ref:`skeleton_bone_get_transform` **(** :ref:`RID` skeleton, :ref:`int` bone **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`skeleton_bone_get_transform_2d` **(** :ref:`RID` skeleton, :ref:`int` bone **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`skeleton_bone_set_transform` **(** :ref:`RID` skeleton, :ref:`int` bone, :ref:`Transform3D` transform **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`skeleton_bone_set_transform_2d` **(** :ref:`RID` skeleton, :ref:`int` bone, :ref:`Transform2D` transform **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`skeleton_create` **(** **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`skeleton_get_bone_count` **(** :ref:`RID` skeleton **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`skeleton_set_base_transform_2d` **(** :ref:`RID` skeleton, :ref:`Transform2D` base_transform **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`sky_bake_panorama` **(** :ref:`RID` sky, :ref:`float` energy, :ref:`bool` bake_irradiance, :ref:`Vector2i` size **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`sky_create` **(** **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sky_set_material` **(** :ref:`RID` sky, :ref:`RID` material **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sky_set_mode` **(** :ref:`RID` sky, :ref:`SkyMode` mode **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sky_set_radiance_size` **(** :ref:`RID` sky, :ref:`int` radiance_size **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`spot_light_create` **(** **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sub_surface_scattering_set_quality` **(** :ref:`SubSurfaceScatteringQuality` quality **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`sub_surface_scattering_set_scale` **(** :ref:`float` scale, :ref:`float` depth_scale **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`texture_2d_create` **(** :ref:`Image` image **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`texture_2d_get` **(** :ref:`RID` texture **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`texture_2d_layer_get` **(** :ref:`RID` texture, :ref:`int` layer **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`texture_2d_layered_create` **(** :ref:`Image[]` layers, :ref:`TextureLayeredType` layered_type **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`texture_2d_layered_placeholder_create` **(** :ref:`TextureLayeredType` layered_type **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`texture_2d_placeholder_create` **(** **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_2d_update` **(** :ref:`RID` texture, :ref:`Image` image, :ref:`int` layer **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`texture_3d_create` **(** :ref:`Format` format, :ref:`int` width, :ref:`int` height, :ref:`int` depth, :ref:`bool` mipmaps, :ref:`Image[]` data **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image[]` | :ref:`texture_3d_get` **(** :ref:`RID` texture **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`texture_3d_placeholder_create` **(** **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_3d_update` **(** :ref:`RID` texture, :ref:`Image[]` data **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`texture_get_path` **(** :ref:`RID` texture **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`texture_proxy_create` **(** :ref:`RID` base **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_proxy_update` **(** :ref:`RID` texture, :ref:`RID` proxy_to **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_replace` **(** :ref:`RID` texture, :ref:`RID` by_texture **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_set_force_redraw_if_visible` **(** :ref:`RID` texture, :ref:`bool` enable **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_set_path` **(** :ref:`RID` texture, :ref:`String` path **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`texture_set_size_override` **(** :ref:`RID` texture, :ref:`int` width, :ref:`int` height **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_attach_camera` **(** :ref:`RID` viewport, :ref:`RID` camera **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_attach_canvas` **(** :ref:`RID` viewport, :ref:`RID` canvas **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_attach_to_screen` **(** :ref:`RID` viewport, :ref:`Rect2` rect=Rect2(0, 0, 0, 0), :ref:`int` screen=0 **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`viewport_create` **(** **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`viewport_get_measured_render_time_cpu` **(** :ref:`RID` viewport **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`viewport_get_measured_render_time_gpu` **(** :ref:`RID` viewport **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`viewport_get_render_info` **(** :ref:`RID` viewport, :ref:`ViewportRenderInfoType` type, :ref:`ViewportRenderInfo` info **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`viewport_get_texture` **(** :ref:`RID` viewport **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_remove_canvas` **(** :ref:`RID` viewport, :ref:`RID` canvas **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_active` **(** :ref:`RID` viewport, :ref:`bool` active **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_canvas_stacking` **(** :ref:`RID` viewport, :ref:`RID` canvas, :ref:`int` layer, :ref:`int` sublayer **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_canvas_transform` **(** :ref:`RID` viewport, :ref:`RID` canvas, :ref:`Transform2D` offset **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_clear_mode` **(** :ref:`RID` viewport, :ref:`ViewportClearMode` clear_mode **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_debug_draw` **(** :ref:`RID` viewport, :ref:`ViewportDebugDraw` draw **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_default_canvas_item_texture_filter` **(** :ref:`RID` viewport, :ref:`CanvasItemTextureFilter` filter **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_default_canvas_item_texture_repeat` **(** :ref:`RID` viewport, :ref:`CanvasItemTextureRepeat` repeat **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_disable_2d` **(** :ref:`RID` viewport, :ref:`bool` disable **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_disable_3d` **(** :ref:`RID` viewport, :ref:`bool` disable **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_disable_environment` **(** :ref:`RID` viewport, :ref:`bool` disabled **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_fsr_sharpness` **(** :ref:`RID` viewport, :ref:`float` sharpness **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_global_canvas_transform` **(** :ref:`RID` viewport, :ref:`Transform2D` transform **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_measure_render_time` **(** :ref:`RID` viewport, :ref:`bool` enable **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_msaa_2d` **(** :ref:`RID` viewport, :ref:`ViewportMSAA` msaa **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_msaa_3d` **(** :ref:`RID` viewport, :ref:`ViewportMSAA` msaa **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_occlusion_culling_build_quality` **(** :ref:`ViewportOcclusionCullingBuildQuality` quality **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_occlusion_rays_per_thread` **(** :ref:`int` rays_per_thread **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_parent_viewport` **(** :ref:`RID` viewport, :ref:`RID` parent_viewport **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_positional_shadow_atlas_quadrant_subdivision` **(** :ref:`RID` viewport, :ref:`int` quadrant, :ref:`int` subdivision **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_positional_shadow_atlas_size` **(** :ref:`RID` viewport, :ref:`int` size, :ref:`bool` use_16_bits=false **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_render_direct_to_screen` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_scaling_3d_mode` **(** :ref:`RID` viewport, :ref:`ViewportScaling3DMode` scaling_3d_mode **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_scaling_3d_scale` **(** :ref:`RID` viewport, :ref:`float` scale **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_scenario` **(** :ref:`RID` viewport, :ref:`RID` scenario **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_screen_space_aa` **(** :ref:`RID` viewport, :ref:`ViewportScreenSpaceAA` mode **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_sdf_oversize_and_scale` **(** :ref:`RID` viewport, :ref:`ViewportSDFOversize` oversize, :ref:`ViewportSDFScale` scale **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_size` **(** :ref:`RID` viewport, :ref:`int` width, :ref:`int` height **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_snap_2d_transforms_to_pixel` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_snap_2d_vertices_to_pixel` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_texture_mipmap_bias` **(** :ref:`RID` viewport, :ref:`float` mipmap_bias **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_transparent_background` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_update_mode` **(** :ref:`RID` viewport, :ref:`ViewportUpdateMode` update_mode **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_use_debanding` **(** :ref:`RID` viewport, :ref:`bool` enable **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_use_occlusion_culling` **(** :ref:`RID` viewport, :ref:`bool` enable **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_use_taa` **(** :ref:`RID` viewport, :ref:`bool` enable **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_use_xr` **(** :ref:`RID` viewport, :ref:`bool` use_xr **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_vrs_mode` **(** :ref:`RID` viewport, :ref:`ViewportVRSMode` mode **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`viewport_set_vrs_texture` **(** :ref:`RID` viewport, :ref:`RID` texture **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`visibility_notifier_create` **(** **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`visibility_notifier_set_aabb` **(** :ref:`RID` notifier, :ref:`AABB` aabb **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`visibility_notifier_set_callbacks` **(** :ref:`RID` notifier, :ref:`Callable` enter_callable, :ref:`Callable` exit_callable **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`voxel_gi_allocate_data` **(** :ref:`RID` voxel_gi, :ref:`Transform3D` to_cell_xform, :ref:`AABB` aabb, :ref:`Vector3i` octree_size, :ref:`PackedByteArray` octree_cells, :ref:`PackedByteArray` data_cells, :ref:`PackedByteArray` distance_field, :ref:`PackedInt32Array` level_counts **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`voxel_gi_create` **(** **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedByteArray` | :ref:`voxel_gi_get_data_cells` **(** :ref:`RID` voxel_gi **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedByteArray` | :ref:`voxel_gi_get_distance_field` **(** :ref:`RID` voxel_gi **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedInt32Array` | :ref:`voxel_gi_get_level_counts` **(** :ref:`RID` voxel_gi **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedByteArray` | :ref:`voxel_gi_get_octree_cells` **(** :ref:`RID` voxel_gi **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector3i` | :ref:`voxel_gi_get_octree_size` **(** :ref:`RID` voxel_gi **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform3D` | :ref:`voxel_gi_get_to_cell_xform` **(** :ref:`RID` voxel_gi **)** |const| | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`voxel_gi_set_bias` **(** :ref:`RID` voxel_gi, :ref:`float` bias **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`voxel_gi_set_dynamic_range` **(** :ref:`RID` voxel_gi, :ref:`float` range **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`voxel_gi_set_energy` **(** :ref:`RID` voxel_gi, :ref:`float` energy **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`voxel_gi_set_interior` **(** :ref:`RID` voxel_gi, :ref:`bool` enable **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`voxel_gi_set_normal_bias` **(** :ref:`RID` voxel_gi, :ref:`float` bias **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`voxel_gi_set_propagation` **(** :ref:`RID` voxel_gi, :ref:`float` amount **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`voxel_gi_set_quality` **(** :ref:`VoxelGIQuality` quality **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`voxel_gi_set_use_two_bounces` **(** :ref:`RID` voxel_gi, :ref:`bool` enable **)** | -+------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Image[]` | :ref:`bake_render_uv2` **(** :ref:`RID` base, :ref:`RID[]` material_overrides, :ref:`Vector2i` image_size **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`camera_attributes_create` **(** **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`camera_attributes_set_auto_exposure` **(** :ref:`RID` camera_attributes, :ref:`bool` enable, :ref:`float` min_sensitivity, :ref:`float` max_sensitivity, :ref:`float` speed, :ref:`float` scale **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`camera_attributes_set_dof_blur` **(** :ref:`RID` camera_attributes, :ref:`bool` far_enable, :ref:`float` far_distance, :ref:`float` far_transition, :ref:`bool` near_enable, :ref:`float` near_distance, :ref:`float` near_transition, :ref:`float` amount **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`camera_attributes_set_dof_blur_bokeh_shape` **(** :ref:`DOFBokehShape` shape **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`camera_attributes_set_dof_blur_quality` **(** :ref:`DOFBlurQuality` quality, :ref:`bool` use_jitter **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`camera_attributes_set_exposure` **(** :ref:`RID` camera_attributes, :ref:`float` multiplier, :ref:`float` normalization **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`camera_create` **(** **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`camera_set_camera_attributes` **(** :ref:`RID` camera, :ref:`RID` effects **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`camera_set_cull_mask` **(** :ref:`RID` camera, :ref:`int` layers **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`camera_set_environment` **(** :ref:`RID` camera, :ref:`RID` env **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`camera_set_frustum` **(** :ref:`RID` camera, :ref:`float` size, :ref:`Vector2` offset, :ref:`float` z_near, :ref:`float` z_far **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`camera_set_orthogonal` **(** :ref:`RID` camera, :ref:`float` size, :ref:`float` z_near, :ref:`float` z_far **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`camera_set_perspective` **(** :ref:`RID` camera, :ref:`float` fovy_degrees, :ref:`float` z_near, :ref:`float` z_far **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`camera_set_transform` **(** :ref:`RID` camera, :ref:`Transform3D` transform **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`camera_set_use_vertical_aspect` **(** :ref:`RID` camera, :ref:`bool` enable **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`canvas_create` **(** **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_animation_slice` **(** :ref:`RID` item, :ref:`float` animation_length, :ref:`float` slice_begin, :ref:`float` slice_end, :ref:`float` offset=0.0 **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_circle` **(** :ref:`RID` item, :ref:`Vector2` pos, :ref:`float` radius, :ref:`Color` color **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_clip_ignore` **(** :ref:`RID` item, :ref:`bool` ignore **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_lcd_texture_rect_region` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`Rect2` src_rect, :ref:`Color` modulate **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_line` **(** :ref:`RID` item, :ref:`Vector2` from, :ref:`Vector2` to, :ref:`Color` color, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_mesh` **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`Transform2D` transform=Transform2D(1, 0, 0, 1, 0, 0), :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`RID` texture **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_msdf_texture_rect_region` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`int` outline_size=0, :ref:`float` px_range=1.0 **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_multimesh` **(** :ref:`RID` item, :ref:`RID` mesh, :ref:`RID` texture **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_nine_patch` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`Rect2` source, :ref:`RID` texture, :ref:`Vector2` topleft, :ref:`Vector2` bottomright, :ref:`NinePatchAxisMode` x_axis_mode=0, :ref:`NinePatchAxisMode` y_axis_mode=0, :ref:`bool` draw_center=true, :ref:`Color` modulate=Color(1, 1, 1, 1) **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_particles` **(** :ref:`RID` item, :ref:`RID` particles, :ref:`RID` texture **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_polygon` **(** :ref:`RID` item, :ref:`PackedVector2Array` points, :ref:`PackedColorArray` colors, :ref:`PackedVector2Array` uvs=PackedVector2Array(), :ref:`RID` texture **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_polyline` **(** :ref:`RID` item, :ref:`PackedVector2Array` points, :ref:`PackedColorArray` colors, :ref:`float` width=1.0, :ref:`bool` antialiased=false **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_primitive` **(** :ref:`RID` item, :ref:`PackedVector2Array` points, :ref:`PackedColorArray` colors, :ref:`PackedVector2Array` uvs, :ref:`RID` texture, :ref:`float` width=1.0 **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_rect` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`Color` color **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_set_transform` **(** :ref:`RID` item, :ref:`Transform2D` transform **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_texture_rect` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`bool` tile=false, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`bool` transpose=false **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_texture_rect_region` **(** :ref:`RID` item, :ref:`Rect2` rect, :ref:`RID` texture, :ref:`Rect2` src_rect, :ref:`Color` modulate=Color(1, 1, 1, 1), :ref:`bool` transpose=false, :ref:`bool` clip_uv=true **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_add_triangle_array` **(** :ref:`RID` item, :ref:`PackedInt32Array` indices, :ref:`PackedVector2Array` points, :ref:`PackedColorArray` colors, :ref:`PackedVector2Array` uvs=PackedVector2Array(), :ref:`PackedInt32Array` bones=PackedInt32Array(), :ref:`PackedFloat32Array` weights=PackedFloat32Array(), :ref:`RID` texture, :ref:`int` count=-1 **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_clear` **(** :ref:`RID` item **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`canvas_item_create` **(** **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_canvas_group_mode` **(** :ref:`RID` item, :ref:`CanvasGroupMode` mode, :ref:`float` clear_margin=5.0, :ref:`bool` fit_empty=false, :ref:`float` fit_margin=0.0, :ref:`bool` blur_mipmaps=false **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_clip` **(** :ref:`RID` item, :ref:`bool` clip **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_copy_to_backbuffer` **(** :ref:`RID` item, :ref:`bool` enabled, :ref:`Rect2` rect **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_custom_rect` **(** :ref:`RID` item, :ref:`bool` use_custom_rect, :ref:`Rect2` rect=Rect2(0, 0, 0, 0) **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_default_texture_filter` **(** :ref:`RID` item, :ref:`CanvasItemTextureFilter` filter **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_default_texture_repeat` **(** :ref:`RID` item, :ref:`CanvasItemTextureRepeat` repeat **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_distance_field_mode` **(** :ref:`RID` item, :ref:`bool` enabled **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_draw_behind_parent` **(** :ref:`RID` item, :ref:`bool` enabled **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_draw_index` **(** :ref:`RID` item, :ref:`int` index **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_light_mask` **(** :ref:`RID` item, :ref:`int` mask **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_material` **(** :ref:`RID` item, :ref:`RID` material **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_modulate` **(** :ref:`RID` item, :ref:`Color` color **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_parent` **(** :ref:`RID` item, :ref:`RID` parent **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_self_modulate` **(** :ref:`RID` item, :ref:`Color` color **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_sort_children_by_y` **(** :ref:`RID` item, :ref:`bool` enabled **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_transform` **(** :ref:`RID` item, :ref:`Transform2D` transform **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_use_parent_material` **(** :ref:`RID` item, :ref:`bool` enabled **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_visibility_notifier` **(** :ref:`RID` item, :ref:`bool` enable, :ref:`Rect2` area, :ref:`Callable` enter_callable, :ref:`Callable` exit_callable **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_visible` **(** :ref:`RID` item, :ref:`bool` visible **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_z_as_relative_to_parent` **(** :ref:`RID` item, :ref:`bool` enabled **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_item_set_z_index` **(** :ref:`RID` item, :ref:`int` z_index **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_attach_to_canvas` **(** :ref:`RID` light, :ref:`RID` canvas **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`canvas_light_create` **(** **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_occluder_attach_to_canvas` **(** :ref:`RID` occluder, :ref:`RID` canvas **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`canvas_light_occluder_create` **(** **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_occluder_set_as_sdf_collision` **(** :ref:`RID` occluder, :ref:`bool` enable **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_occluder_set_enabled` **(** :ref:`RID` occluder, :ref:`bool` enabled **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_occluder_set_light_mask` **(** :ref:`RID` occluder, :ref:`int` mask **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_occluder_set_polygon` **(** :ref:`RID` occluder, :ref:`RID` polygon **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_occluder_set_transform` **(** :ref:`RID` occluder, :ref:`Transform2D` transform **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_color` **(** :ref:`RID` light, :ref:`Color` color **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_enabled` **(** :ref:`RID` light, :ref:`bool` enabled **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_energy` **(** :ref:`RID` light, :ref:`float` energy **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_height` **(** :ref:`RID` light, :ref:`float` height **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_item_cull_mask` **(** :ref:`RID` light, :ref:`int` mask **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_item_shadow_cull_mask` **(** :ref:`RID` light, :ref:`int` mask **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_layer_range` **(** :ref:`RID` light, :ref:`int` min_layer, :ref:`int` max_layer **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_mode` **(** :ref:`RID` light, :ref:`CanvasLightMode` mode **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_shadow_color` **(** :ref:`RID` light, :ref:`Color` color **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_shadow_enabled` **(** :ref:`RID` light, :ref:`bool` enabled **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_shadow_filter` **(** :ref:`RID` light, :ref:`CanvasLightShadowFilter` filter **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_shadow_smooth` **(** :ref:`RID` light, :ref:`float` smooth **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_texture` **(** :ref:`RID` light, :ref:`RID` texture **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_texture_offset` **(** :ref:`RID` light, :ref:`Vector2` offset **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_texture_scale` **(** :ref:`RID` light, :ref:`float` scale **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_transform` **(** :ref:`RID` light, :ref:`Transform2D` transform **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_light_set_z_range` **(** :ref:`RID` light, :ref:`int` min_z, :ref:`int` max_z **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`canvas_occluder_polygon_create` **(** **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_occluder_polygon_set_cull_mode` **(** :ref:`RID` occluder_polygon, :ref:`CanvasOccluderPolygonCullMode` mode **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_occluder_polygon_set_shape` **(** :ref:`RID` occluder_polygon, :ref:`PackedVector2Array` shape, :ref:`bool` closed **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_set_disable_scale` **(** :ref:`bool` disable **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_set_item_mirroring` **(** :ref:`RID` canvas, :ref:`RID` item, :ref:`Vector2` mirroring **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_set_modulate` **(** :ref:`RID` canvas, :ref:`Color` color **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_set_shadow_texture_size` **(** :ref:`int` size **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`canvas_texture_create` **(** **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_texture_set_channel` **(** :ref:`RID` canvas_texture, :ref:`CanvasTextureChannel` channel, :ref:`RID` texture **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_texture_set_shading_parameters` **(** :ref:`RID` canvas_texture, :ref:`Color` base_color, :ref:`float` shininess **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_texture_set_texture_filter` **(** :ref:`RID` canvas_texture, :ref:`CanvasItemTextureFilter` filter **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`canvas_texture_set_texture_repeat` **(** :ref:`RID` canvas_texture, :ref:`CanvasItemTextureRepeat` repeat **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RenderingDevice` | :ref:`create_local_rendering_device` **(** **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`decal_create` **(** **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`decal_set_albedo_mix` **(** :ref:`RID` decal, :ref:`float` albedo_mix **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`decal_set_cull_mask` **(** :ref:`RID` decal, :ref:`int` mask **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`decal_set_distance_fade` **(** :ref:`RID` decal, :ref:`bool` enabled, :ref:`float` begin, :ref:`float` length **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`decal_set_emission_energy` **(** :ref:`RID` decal, :ref:`float` energy **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`decal_set_extents` **(** :ref:`RID` decal, :ref:`Vector3` extents **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`decal_set_fade` **(** :ref:`RID` decal, :ref:`float` above, :ref:`float` below **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`decal_set_modulate` **(** :ref:`RID` decal, :ref:`Color` color **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`decal_set_normal_fade` **(** :ref:`RID` decal, :ref:`float` fade **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`decal_set_texture` **(** :ref:`RID` decal, :ref:`DecalTexture` type, :ref:`RID` texture **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`decals_set_filter` **(** :ref:`DecalFilter` filter **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`directional_light_create` **(** **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`directional_shadow_atlas_set_size` **(** :ref:`int` size, :ref:`bool` is_16bits **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`directional_soft_shadow_filter_set_quality` **(** :ref:`ShadowQuality` quality **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Image` | :ref:`environment_bake_panorama` **(** :ref:`RID` environment, :ref:`bool` bake_irradiance, :ref:`Vector2i` size **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`environment_create` **(** **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_glow_set_use_bicubic_upscale` **(** :ref:`bool` enable **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_glow_set_use_high_quality` **(** :ref:`bool` enable **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_adjustment` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` brightness, :ref:`float` contrast, :ref:`float` saturation, :ref:`bool` use_1d_color_correction, :ref:`RID` color_correction **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_ambient_light` **(** :ref:`RID` env, :ref:`Color` color, :ref:`EnvironmentAmbientSource` ambient=0, :ref:`float` energy=1.0, :ref:`float` sky_contibution=0.0, :ref:`EnvironmentReflectionSource` reflection_source=0 **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_background` **(** :ref:`RID` env, :ref:`EnvironmentBG` bg **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_bg_color` **(** :ref:`RID` env, :ref:`Color` color **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_bg_energy` **(** :ref:`RID` env, :ref:`float` multiplier, :ref:`float` exposure_value **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_canvas_max_layer` **(** :ref:`RID` env, :ref:`int` max_layer **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_fog` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`Color` light_color, :ref:`float` light_energy, :ref:`float` sun_scatter, :ref:`float` density, :ref:`float` height, :ref:`float` height_density, :ref:`float` aerial_perspective, :ref:`float` sky_affect **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_glow` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`PackedFloat32Array` levels, :ref:`float` intensity, :ref:`float` strength, :ref:`float` mix, :ref:`float` bloom_threshold, :ref:`EnvironmentGlowBlendMode` blend_mode, :ref:`float` hdr_bleed_threshold, :ref:`float` hdr_bleed_scale, :ref:`float` hdr_luminance_cap, :ref:`float` glow_map_strength, :ref:`RID` glow_map **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_sdfgi` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`int` cascades, :ref:`float` min_cell_size, :ref:`EnvironmentSDFGIYScale` y_scale, :ref:`bool` use_occlusion, :ref:`float` bounce_feedback, :ref:`bool` read_sky, :ref:`float` energy, :ref:`float` normal_bias, :ref:`float` probe_bias **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_sdfgi_frames_to_converge` **(** :ref:`EnvironmentSDFGIFramesToConverge` frames **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_sdfgi_frames_to_update_light` **(** :ref:`EnvironmentSDFGIFramesToUpdateLight` frames **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_sdfgi_ray_count` **(** :ref:`EnvironmentSDFGIRayCount` ray_count **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_sky` **(** :ref:`RID` env, :ref:`RID` sky **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_sky_custom_fov` **(** :ref:`RID` env, :ref:`float` scale **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_sky_orientation` **(** :ref:`RID` env, :ref:`Basis` orientation **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_ssao` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` radius, :ref:`float` intensity, :ref:`float` power, :ref:`float` detail, :ref:`float` horizon, :ref:`float` sharpness, :ref:`float` light_affect, :ref:`float` ao_channel_affect **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_ssao_quality` **(** :ref:`EnvironmentSSAOQuality` quality, :ref:`bool` half_size, :ref:`float` adaptive_target, :ref:`int` blur_passes, :ref:`float` fadeout_from, :ref:`float` fadeout_to **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_ssil_quality` **(** :ref:`EnvironmentSSILQuality` quality, :ref:`bool` half_size, :ref:`float` adaptive_target, :ref:`int` blur_passes, :ref:`float` fadeout_from, :ref:`float` fadeout_to **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_ssr` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`int` max_steps, :ref:`float` fade_in, :ref:`float` fade_out, :ref:`float` depth_tolerance **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_ssr_roughness_quality` **(** :ref:`EnvironmentSSRRoughnessQuality` quality **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_tonemap` **(** :ref:`RID` env, :ref:`EnvironmentToneMapper` tone_mapper, :ref:`float` exposure, :ref:`float` white **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_volumetric_fog` **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` density, :ref:`Color` albedo, :ref:`Color` emission, :ref:`float` emission_energy, :ref:`float` anisotropy, :ref:`float` length, :ref:`float` p_detail_spread, :ref:`float` gi_inject, :ref:`bool` temporal_reprojection, :ref:`float` temporal_reprojection_amount, :ref:`float` ambient_inject, :ref:`float` sky_affect **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_volumetric_fog_filter_active` **(** :ref:`bool` active **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`environment_set_volumetric_fog_volume_size` **(** :ref:`int` size, :ref:`int` depth **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`fog_volume_create` **(** **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`fog_volume_set_extents` **(** :ref:`RID` fog_volume, :ref:`Vector3` extents **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`fog_volume_set_material` **(** :ref:`RID` fog_volume, :ref:`RID` material **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`fog_volume_set_shape` **(** :ref:`RID` fog_volume, :ref:`FogVolumeShape` shape **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`force_draw` **(** :ref:`bool` swap_buffers=true, :ref:`float` frame_step=0.0 **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`force_sync` **(** **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`free_rid` **(** :ref:`RID` rid **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_frame_setup_time_cpu` **(** **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RenderingDevice` | :ref:`get_rendering_device` **(** **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_rendering_info` **(** :ref:`RenderingInfo` info **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary[]` | :ref:`get_shader_parameter_list` **(** :ref:`RID` shader **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_test_cube` **(** **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_test_texture` **(** **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_video_adapter_api_version` **(** **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_video_adapter_name` **(** **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`DeviceType` | :ref:`get_video_adapter_type` **(** **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_video_adapter_vendor` **(** **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`get_white_texture` **(** **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`gi_set_use_half_resolution` **(** :ref:`bool` half_resolution **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`global_shader_parameter_add` **(** :ref:`StringName` name, :ref:`GlobalShaderParameterType` type, :ref:`Variant` default_value **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`global_shader_parameter_get` **(** :ref:`StringName` name **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`global_shader_parameter_get_list` **(** **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`GlobalShaderParameterType` | :ref:`global_shader_parameter_get_type` **(** :ref:`StringName` name **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`global_shader_parameter_remove` **(** :ref:`StringName` name **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`global_shader_parameter_set` **(** :ref:`StringName` name, :ref:`Variant` value **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`global_shader_parameter_set_override` **(** :ref:`StringName` name, :ref:`Variant` value **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_changed` **(** **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_feature` **(** :ref:`Features` feature **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_os_feature` **(** :ref:`String` feature **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_attach_object_instance_id` **(** :ref:`RID` instance, :ref:`int` id **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_attach_skeleton` **(** :ref:`RID` instance, :ref:`RID` skeleton **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`instance_create` **(** **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`instance_create2` **(** :ref:`RID` base, :ref:`RID` scenario **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`instance_geometry_get_shader_parameter` **(** :ref:`RID` instance, :ref:`StringName` parameter **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`instance_geometry_get_shader_parameter_default_value` **(** :ref:`RID` instance, :ref:`StringName` parameter **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary[]` | :ref:`instance_geometry_get_shader_parameter_list` **(** :ref:`RID` instance **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_geometry_set_cast_shadows_setting` **(** :ref:`RID` instance, :ref:`ShadowCastingSetting` shadow_casting_setting **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_geometry_set_flag` **(** :ref:`RID` instance, :ref:`InstanceFlags` flag, :ref:`bool` enabled **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_geometry_set_lightmap` **(** :ref:`RID` instance, :ref:`RID` lightmap, :ref:`Rect2` lightmap_uv_scale, :ref:`int` lightmap_slice **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_geometry_set_lod_bias` **(** :ref:`RID` instance, :ref:`float` lod_bias **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_geometry_set_material_overlay` **(** :ref:`RID` instance, :ref:`RID` material **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_geometry_set_material_override` **(** :ref:`RID` instance, :ref:`RID` material **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_geometry_set_shader_parameter` **(** :ref:`RID` instance, :ref:`StringName` parameter, :ref:`Variant` value **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_geometry_set_transparency` **(** :ref:`RID` instance, :ref:`float` transparency **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_geometry_set_visibility_range` **(** :ref:`RID` instance, :ref:`float` min, :ref:`float` max, :ref:`float` min_margin, :ref:`float` max_margin, :ref:`VisibilityRangeFadeMode` fade_mode **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_base` **(** :ref:`RID` instance, :ref:`RID` base **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_blend_shape_weight` **(** :ref:`RID` instance, :ref:`int` shape, :ref:`float` weight **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_custom_aabb` **(** :ref:`RID` instance, :ref:`AABB` aabb **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_extra_visibility_margin` **(** :ref:`RID` instance, :ref:`float` margin **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_ignore_culling` **(** :ref:`RID` instance, :ref:`bool` enabled **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_layer_mask` **(** :ref:`RID` instance, :ref:`int` mask **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_scenario` **(** :ref:`RID` instance, :ref:`RID` scenario **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_surface_override_material` **(** :ref:`RID` instance, :ref:`int` surface, :ref:`RID` material **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_transform` **(** :ref:`RID` instance, :ref:`Transform3D` transform **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_visibility_parent` **(** :ref:`RID` instance, :ref:`RID` parent **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`instance_set_visible` **(** :ref:`RID` instance, :ref:`bool` visible **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedInt64Array` | :ref:`instances_cull_aabb` **(** :ref:`AABB` aabb, :ref:`RID` scenario **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedInt64Array` | :ref:`instances_cull_convex` **(** :ref:`Plane[]` convex, :ref:`RID` scenario **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedInt64Array` | :ref:`instances_cull_ray` **(** :ref:`Vector3` from, :ref:`Vector3` to, :ref:`RID` scenario **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_directional_set_blend_splits` **(** :ref:`RID` light, :ref:`bool` enable **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_directional_set_shadow_mode` **(** :ref:`RID` light, :ref:`LightDirectionalShadowMode` mode **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_directional_set_sky_mode` **(** :ref:`RID` light, :ref:`LightDirectionalSkyMode` mode **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_omni_set_shadow_mode` **(** :ref:`RID` light, :ref:`LightOmniShadowMode` mode **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_projectors_set_filter` **(** :ref:`LightProjectorFilter` filter **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_set_bake_mode` **(** :ref:`RID` light, :ref:`LightBakeMode` bake_mode **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_set_color` **(** :ref:`RID` light, :ref:`Color` color **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_set_cull_mask` **(** :ref:`RID` light, :ref:`int` mask **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_set_distance_fade` **(** :ref:`RID` decal, :ref:`bool` enabled, :ref:`float` begin, :ref:`float` shadow, :ref:`float` length **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_set_max_sdfgi_cascade` **(** :ref:`RID` light, :ref:`int` cascade **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_set_negative` **(** :ref:`RID` light, :ref:`bool` enable **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_set_param` **(** :ref:`RID` light, :ref:`LightParam` param, :ref:`float` value **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_set_projector` **(** :ref:`RID` light, :ref:`RID` texture **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_set_reverse_cull_face_mode` **(** :ref:`RID` light, :ref:`bool` enabled **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`light_set_shadow` **(** :ref:`RID` light, :ref:`bool` enabled **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`lightmap_create` **(** **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedInt32Array` | :ref:`lightmap_get_probe_capture_bsp_tree` **(** :ref:`RID` lightmap **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedVector3Array` | :ref:`lightmap_get_probe_capture_points` **(** :ref:`RID` lightmap **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedColorArray` | :ref:`lightmap_get_probe_capture_sh` **(** :ref:`RID` lightmap **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedInt32Array` | :ref:`lightmap_get_probe_capture_tetrahedra` **(** :ref:`RID` lightmap **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`lightmap_set_baked_exposure_normalization` **(** :ref:`RID` lightmap, :ref:`float` baked_exposure **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`lightmap_set_probe_bounds` **(** :ref:`RID` lightmap, :ref:`AABB` bounds **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`lightmap_set_probe_capture_data` **(** :ref:`RID` lightmap, :ref:`PackedVector3Array` points, :ref:`PackedColorArray` point_sh, :ref:`PackedInt32Array` tetrahedra, :ref:`PackedInt32Array` bsp_tree **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`lightmap_set_probe_capture_update_speed` **(** :ref:`float` speed **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`lightmap_set_probe_interior` **(** :ref:`RID` lightmap, :ref:`bool` interior **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`lightmap_set_textures` **(** :ref:`RID` lightmap, :ref:`RID` light, :ref:`bool` uses_sh **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`make_sphere_mesh` **(** :ref:`int` latitudes, :ref:`int` longitudes, :ref:`float` radius **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`material_create` **(** **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`material_get_param` **(** :ref:`RID` material, :ref:`StringName` parameter **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`material_set_next_pass` **(** :ref:`RID` material, :ref:`RID` next_material **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`material_set_param` **(** :ref:`RID` material, :ref:`StringName` parameter, :ref:`Variant` value **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`material_set_render_priority` **(** :ref:`RID` material, :ref:`int` priority **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`material_set_shader` **(** :ref:`RID` shader_material, :ref:`RID` shader **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`mesh_add_surface` **(** :ref:`RID` mesh, :ref:`Dictionary` surface **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`mesh_add_surface_from_arrays` **(** :ref:`RID` mesh, :ref:`PrimitiveType` primitive, :ref:`Array` arrays, :ref:`Array` blend_shapes=[], :ref:`Dictionary` lods={}, :ref:`int` compress_format=0 **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`mesh_clear` **(** :ref:`RID` mesh **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`mesh_create` **(** **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`mesh_create_from_surfaces` **(** :ref:`Dictionary[]` surfaces, :ref:`int` blend_shape_count=0 **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`mesh_get_blend_shape_count` **(** :ref:`RID` mesh **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`BlendShapeMode` | :ref:`mesh_get_blend_shape_mode` **(** :ref:`RID` mesh **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`mesh_get_custom_aabb` **(** :ref:`RID` mesh **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`mesh_get_surface` **(** :ref:`RID` mesh, :ref:`int` surface **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`mesh_get_surface_count` **(** :ref:`RID` mesh **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`mesh_set_blend_shape_mode` **(** :ref:`RID` mesh, :ref:`BlendShapeMode` mode **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`mesh_set_custom_aabb` **(** :ref:`RID` mesh, :ref:`AABB` aabb **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`mesh_set_shadow_mesh` **(** :ref:`RID` mesh, :ref:`RID` shadow_mesh **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`mesh_surface_get_arrays` **(** :ref:`RID` mesh, :ref:`int` surface **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array[]` | :ref:`mesh_surface_get_blend_shape_arrays` **(** :ref:`RID` mesh, :ref:`int` surface **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`mesh_surface_get_format_attribute_stride` **(** :ref:`int` format, :ref:`int` vertex_count **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`mesh_surface_get_format_offset` **(** :ref:`int` format, :ref:`int` vertex_count, :ref:`int` array_index **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`mesh_surface_get_format_skin_stride` **(** :ref:`int` format, :ref:`int` vertex_count **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`mesh_surface_get_format_vertex_stride` **(** :ref:`int` format, :ref:`int` vertex_count **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`mesh_surface_get_material` **(** :ref:`RID` mesh, :ref:`int` surface **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`mesh_surface_set_material` **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`RID` material **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`mesh_surface_update_attribute_region` **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`int` offset, :ref:`PackedByteArray` data **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`mesh_surface_update_skin_region` **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`int` offset, :ref:`PackedByteArray` data **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`mesh_surface_update_vertex_region` **(** :ref:`RID` mesh, :ref:`int` surface, :ref:`int` offset, :ref:`PackedByteArray` data **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`multimesh_allocate_data` **(** :ref:`RID` multimesh, :ref:`int` instances, :ref:`MultimeshTransformFormat` transform_format, :ref:`bool` color_format=false, :ref:`bool` custom_data_format=false **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`multimesh_create` **(** **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`multimesh_get_aabb` **(** :ref:`RID` multimesh **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedFloat32Array` | :ref:`multimesh_get_buffer` **(** :ref:`RID` multimesh **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`multimesh_get_instance_count` **(** :ref:`RID` multimesh **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`multimesh_get_mesh` **(** :ref:`RID` multimesh **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`multimesh_get_visible_instances` **(** :ref:`RID` multimesh **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`multimesh_instance_get_color` **(** :ref:`RID` multimesh, :ref:`int` index **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Color` | :ref:`multimesh_instance_get_custom_data` **(** :ref:`RID` multimesh, :ref:`int` index **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform3D` | :ref:`multimesh_instance_get_transform` **(** :ref:`RID` multimesh, :ref:`int` index **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`multimesh_instance_get_transform_2d` **(** :ref:`RID` multimesh, :ref:`int` index **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`multimesh_instance_set_color` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Color` color **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`multimesh_instance_set_custom_data` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Color` custom_data **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`multimesh_instance_set_transform` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Transform3D` transform **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`multimesh_instance_set_transform_2d` **(** :ref:`RID` multimesh, :ref:`int` index, :ref:`Transform2D` transform **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`multimesh_set_buffer` **(** :ref:`RID` multimesh, :ref:`PackedFloat32Array` buffer **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`multimesh_set_mesh` **(** :ref:`RID` multimesh, :ref:`RID` mesh **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`multimesh_set_visible_instances` **(** :ref:`RID` multimesh, :ref:`int` visible **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`occluder_create` **(** **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`occluder_set_mesh` **(** :ref:`RID` occluder, :ref:`PackedVector3Array` vertices, :ref:`PackedInt32Array` indices **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`omni_light_create` **(** **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`particles_collision_create` **(** **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_collision_height_field_update` **(** :ref:`RID` particles_collision **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_collision_set_attractor_attenuation` **(** :ref:`RID` particles_collision, :ref:`float` curve **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_collision_set_attractor_directionality` **(** :ref:`RID` particles_collision, :ref:`float` amount **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_collision_set_attractor_strength` **(** :ref:`RID` particles_collision, :ref:`float` setrngth **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_collision_set_box_extents` **(** :ref:`RID` particles_collision, :ref:`Vector3` extents **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_collision_set_collision_type` **(** :ref:`RID` particles_collision, :ref:`ParticlesCollisionType` type **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_collision_set_cull_mask` **(** :ref:`RID` particles_collision, :ref:`int` mask **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_collision_set_field_texture` **(** :ref:`RID` particles_collision, :ref:`RID` texture **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_collision_set_height_field_resolution` **(** :ref:`RID` particles_collision, :ref:`ParticlesCollisionHeightfieldResolution` resolution **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_collision_set_sphere_radius` **(** :ref:`RID` particles_collision, :ref:`float` radius **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`particles_create` **(** **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_emit` **(** :ref:`RID` particles, :ref:`Transform3D` transform, :ref:`Vector3` velocity, :ref:`Color` color, :ref:`Color` custom, :ref:`int` emit_flags **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`AABB` | :ref:`particles_get_current_aabb` **(** :ref:`RID` particles **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`particles_get_emitting` **(** :ref:`RID` particles **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`particles_is_inactive` **(** :ref:`RID` particles **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_request_process` **(** :ref:`RID` particles **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_restart` **(** :ref:`RID` particles **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_amount` **(** :ref:`RID` particles, :ref:`int` amount **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_collision_base_size` **(** :ref:`RID` particles, :ref:`float` size **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_custom_aabb` **(** :ref:`RID` particles, :ref:`AABB` aabb **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_draw_order` **(** :ref:`RID` particles, :ref:`ParticlesDrawOrder` order **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_draw_pass_mesh` **(** :ref:`RID` particles, :ref:`int` pass, :ref:`RID` mesh **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_draw_passes` **(** :ref:`RID` particles, :ref:`int` count **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_emission_transform` **(** :ref:`RID` particles, :ref:`Transform3D` transform **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_emitting` **(** :ref:`RID` particles, :ref:`bool` emitting **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_explosiveness_ratio` **(** :ref:`RID` particles, :ref:`float` ratio **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_fixed_fps` **(** :ref:`RID` particles, :ref:`int` fps **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_fractional_delta` **(** :ref:`RID` particles, :ref:`bool` enable **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_interpolate` **(** :ref:`RID` particles, :ref:`bool` enable **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_lifetime` **(** :ref:`RID` particles, :ref:`float` lifetime **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_mode` **(** :ref:`RID` particles, :ref:`ParticlesMode` mode **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_one_shot` **(** :ref:`RID` particles, :ref:`bool` one_shot **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_pre_process_time` **(** :ref:`RID` particles, :ref:`float` time **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_process_material` **(** :ref:`RID` particles, :ref:`RID` material **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_randomness_ratio` **(** :ref:`RID` particles, :ref:`float` ratio **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_speed_scale` **(** :ref:`RID` particles, :ref:`float` scale **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_subemitter` **(** :ref:`RID` particles, :ref:`RID` subemitter_particles **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_trail_bind_poses` **(** :ref:`RID` particles, :ref:`Transform3D[]` bind_poses **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_trails` **(** :ref:`RID` particles, :ref:`bool` enable, :ref:`float` length_sec **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_transform_align` **(** :ref:`RID` particles, :ref:`ParticlesTransformAlign` align **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`particles_set_use_local_coordinates` **(** :ref:`RID` particles, :ref:`bool` enable **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`positional_soft_shadow_filter_set_quality` **(** :ref:`ShadowQuality` quality **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`reflection_probe_create` **(** **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_ambient_color` **(** :ref:`RID` probe, :ref:`Color` color **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_ambient_energy` **(** :ref:`RID` probe, :ref:`float` energy **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_ambient_mode` **(** :ref:`RID` probe, :ref:`ReflectionProbeAmbientMode` mode **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_as_interior` **(** :ref:`RID` probe, :ref:`bool` enable **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_cull_mask` **(** :ref:`RID` probe, :ref:`int` layers **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_enable_box_projection` **(** :ref:`RID` probe, :ref:`bool` enable **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_enable_shadows` **(** :ref:`RID` probe, :ref:`bool` enable **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_extents` **(** :ref:`RID` probe, :ref:`Vector3` extents **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_intensity` **(** :ref:`RID` probe, :ref:`float` intensity **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_max_distance` **(** :ref:`RID` probe, :ref:`float` distance **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_mesh_lod_threshold` **(** :ref:`RID` probe, :ref:`float` pixels **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_origin_offset` **(** :ref:`RID` probe, :ref:`Vector3` offset **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_resolution` **(** :ref:`RID` probe, :ref:`int` resolution **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`reflection_probe_set_update_mode` **(** :ref:`RID` probe, :ref:`ReflectionProbeUpdateMode` mode **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`request_frame_drawn_callback` **(** :ref:`Callable` callable **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`scenario_create` **(** **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`scenario_set_camera_attributes` **(** :ref:`RID` scenario, :ref:`RID` effects **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`scenario_set_environment` **(** :ref:`RID` scenario, :ref:`RID` environment **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`scenario_set_fallback_environment` **(** :ref:`RID` scenario, :ref:`RID` environment **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`screen_space_roughness_limiter_set_active` **(** :ref:`bool` enable, :ref:`float` amount, :ref:`float` limit **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_boot_image` **(** :ref:`Image` image, :ref:`Color` color, :ref:`bool` scale, :ref:`bool` use_filter=true **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_debug_generate_wireframes` **(** :ref:`bool` generate **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_default_clear_color` **(** :ref:`Color` color **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`shader_create` **(** **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`shader_get_code` **(** :ref:`RID` shader **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`shader_get_default_texture_parameter` **(** :ref:`RID` shader, :ref:`StringName` name, :ref:`int` index=0 **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`shader_get_parameter_default` **(** :ref:`RID` shader, :ref:`StringName` name **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shader_set_code` **(** :ref:`RID` shader, :ref:`String` code **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shader_set_default_texture_parameter` **(** :ref:`RID` shader, :ref:`StringName` name, :ref:`RID` texture, :ref:`int` index=0 **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shader_set_path_hint` **(** :ref:`RID` shader, :ref:`String` path **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`skeleton_allocate_data` **(** :ref:`RID` skeleton, :ref:`int` bones, :ref:`bool` is_2d_skeleton=false **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform3D` | :ref:`skeleton_bone_get_transform` **(** :ref:`RID` skeleton, :ref:`int` bone **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`skeleton_bone_get_transform_2d` **(** :ref:`RID` skeleton, :ref:`int` bone **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`skeleton_bone_set_transform` **(** :ref:`RID` skeleton, :ref:`int` bone, :ref:`Transform3D` transform **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`skeleton_bone_set_transform_2d` **(** :ref:`RID` skeleton, :ref:`int` bone, :ref:`Transform2D` transform **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`skeleton_create` **(** **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`skeleton_get_bone_count` **(** :ref:`RID` skeleton **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`skeleton_set_base_transform_2d` **(** :ref:`RID` skeleton, :ref:`Transform2D` base_transform **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Image` | :ref:`sky_bake_panorama` **(** :ref:`RID` sky, :ref:`float` energy, :ref:`bool` bake_irradiance, :ref:`Vector2i` size **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`sky_create` **(** **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`sky_set_material` **(** :ref:`RID` sky, :ref:`RID` material **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`sky_set_mode` **(** :ref:`RID` sky, :ref:`SkyMode` mode **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`sky_set_radiance_size` **(** :ref:`RID` sky, :ref:`int` radiance_size **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`spot_light_create` **(** **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`sub_surface_scattering_set_quality` **(** :ref:`SubSurfaceScatteringQuality` quality **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`sub_surface_scattering_set_scale` **(** :ref:`float` scale, :ref:`float` depth_scale **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`texture_2d_create` **(** :ref:`Image` image **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Image` | :ref:`texture_2d_get` **(** :ref:`RID` texture **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Image` | :ref:`texture_2d_layer_get` **(** :ref:`RID` texture, :ref:`int` layer **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`texture_2d_layered_create` **(** :ref:`Image[]` layers, :ref:`TextureLayeredType` layered_type **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`texture_2d_layered_placeholder_create` **(** :ref:`TextureLayeredType` layered_type **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`texture_2d_placeholder_create` **(** **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`texture_2d_update` **(** :ref:`RID` texture, :ref:`Image` image, :ref:`int` layer **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`texture_3d_create` **(** :ref:`Format` format, :ref:`int` width, :ref:`int` height, :ref:`int` depth, :ref:`bool` mipmaps, :ref:`Image[]` data **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Image[]` | :ref:`texture_3d_get` **(** :ref:`RID` texture **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`texture_3d_placeholder_create` **(** **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`texture_3d_update` **(** :ref:`RID` texture, :ref:`Image[]` data **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`texture_get_path` **(** :ref:`RID` texture **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`texture_proxy_create` **(** :ref:`RID` base **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`texture_proxy_update` **(** :ref:`RID` texture, :ref:`RID` proxy_to **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`texture_replace` **(** :ref:`RID` texture, :ref:`RID` by_texture **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`texture_set_force_redraw_if_visible` **(** :ref:`RID` texture, :ref:`bool` enable **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`texture_set_path` **(** :ref:`RID` texture, :ref:`String` path **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`texture_set_size_override` **(** :ref:`RID` texture, :ref:`int` width, :ref:`int` height **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_attach_camera` **(** :ref:`RID` viewport, :ref:`RID` camera **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_attach_canvas` **(** :ref:`RID` viewport, :ref:`RID` canvas **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_attach_to_screen` **(** :ref:`RID` viewport, :ref:`Rect2` rect=Rect2(0, 0, 0, 0), :ref:`int` screen=0 **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`viewport_create` **(** **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`viewport_get_measured_render_time_cpu` **(** :ref:`RID` viewport **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`viewport_get_measured_render_time_gpu` **(** :ref:`RID` viewport **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`viewport_get_render_info` **(** :ref:`RID` viewport, :ref:`ViewportRenderInfoType` type, :ref:`ViewportRenderInfo` info **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`viewport_get_texture` **(** :ref:`RID` viewport **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_remove_canvas` **(** :ref:`RID` viewport, :ref:`RID` canvas **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_active` **(** :ref:`RID` viewport, :ref:`bool` active **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_canvas_stacking` **(** :ref:`RID` viewport, :ref:`RID` canvas, :ref:`int` layer, :ref:`int` sublayer **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_canvas_transform` **(** :ref:`RID` viewport, :ref:`RID` canvas, :ref:`Transform2D` offset **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_clear_mode` **(** :ref:`RID` viewport, :ref:`ViewportClearMode` clear_mode **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_debug_draw` **(** :ref:`RID` viewport, :ref:`ViewportDebugDraw` draw **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_default_canvas_item_texture_filter` **(** :ref:`RID` viewport, :ref:`CanvasItemTextureFilter` filter **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_default_canvas_item_texture_repeat` **(** :ref:`RID` viewport, :ref:`CanvasItemTextureRepeat` repeat **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_disable_2d` **(** :ref:`RID` viewport, :ref:`bool` disable **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_disable_3d` **(** :ref:`RID` viewport, :ref:`bool` disable **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_disable_environment` **(** :ref:`RID` viewport, :ref:`bool` disabled **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_fsr_sharpness` **(** :ref:`RID` viewport, :ref:`float` sharpness **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_global_canvas_transform` **(** :ref:`RID` viewport, :ref:`Transform2D` transform **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_measure_render_time` **(** :ref:`RID` viewport, :ref:`bool` enable **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_msaa_2d` **(** :ref:`RID` viewport, :ref:`ViewportMSAA` msaa **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_msaa_3d` **(** :ref:`RID` viewport, :ref:`ViewportMSAA` msaa **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_occlusion_culling_build_quality` **(** :ref:`ViewportOcclusionCullingBuildQuality` quality **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_occlusion_rays_per_thread` **(** :ref:`int` rays_per_thread **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_parent_viewport` **(** :ref:`RID` viewport, :ref:`RID` parent_viewport **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_positional_shadow_atlas_quadrant_subdivision` **(** :ref:`RID` viewport, :ref:`int` quadrant, :ref:`int` subdivision **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_positional_shadow_atlas_size` **(** :ref:`RID` viewport, :ref:`int` size, :ref:`bool` use_16_bits=false **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_render_direct_to_screen` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_scaling_3d_mode` **(** :ref:`RID` viewport, :ref:`ViewportScaling3DMode` scaling_3d_mode **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_scaling_3d_scale` **(** :ref:`RID` viewport, :ref:`float` scale **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_scenario` **(** :ref:`RID` viewport, :ref:`RID` scenario **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_screen_space_aa` **(** :ref:`RID` viewport, :ref:`ViewportScreenSpaceAA` mode **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_sdf_oversize_and_scale` **(** :ref:`RID` viewport, :ref:`ViewportSDFOversize` oversize, :ref:`ViewportSDFScale` scale **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_size` **(** :ref:`RID` viewport, :ref:`int` width, :ref:`int` height **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_snap_2d_transforms_to_pixel` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_snap_2d_vertices_to_pixel` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_texture_mipmap_bias` **(** :ref:`RID` viewport, :ref:`float` mipmap_bias **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_transparent_background` **(** :ref:`RID` viewport, :ref:`bool` enabled **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_update_mode` **(** :ref:`RID` viewport, :ref:`ViewportUpdateMode` update_mode **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_use_debanding` **(** :ref:`RID` viewport, :ref:`bool` enable **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_use_occlusion_culling` **(** :ref:`RID` viewport, :ref:`bool` enable **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_use_taa` **(** :ref:`RID` viewport, :ref:`bool` enable **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_use_xr` **(** :ref:`RID` viewport, :ref:`bool` use_xr **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_vrs_mode` **(** :ref:`RID` viewport, :ref:`ViewportVRSMode` mode **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`viewport_set_vrs_texture` **(** :ref:`RID` viewport, :ref:`RID` texture **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`visibility_notifier_create` **(** **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`visibility_notifier_set_aabb` **(** :ref:`RID` notifier, :ref:`AABB` aabb **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`visibility_notifier_set_callbacks` **(** :ref:`RID` notifier, :ref:`Callable` enter_callable, :ref:`Callable` exit_callable **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`voxel_gi_allocate_data` **(** :ref:`RID` voxel_gi, :ref:`Transform3D` to_cell_xform, :ref:`AABB` aabb, :ref:`Vector3i` octree_size, :ref:`PackedByteArray` octree_cells, :ref:`PackedByteArray` data_cells, :ref:`PackedByteArray` distance_field, :ref:`PackedInt32Array` level_counts **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`voxel_gi_create` **(** **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedByteArray` | :ref:`voxel_gi_get_data_cells` **(** :ref:`RID` voxel_gi **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedByteArray` | :ref:`voxel_gi_get_distance_field` **(** :ref:`RID` voxel_gi **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedInt32Array` | :ref:`voxel_gi_get_level_counts` **(** :ref:`RID` voxel_gi **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedByteArray` | :ref:`voxel_gi_get_octree_cells` **(** :ref:`RID` voxel_gi **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector3i` | :ref:`voxel_gi_get_octree_size` **(** :ref:`RID` voxel_gi **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform3D` | :ref:`voxel_gi_get_to_cell_xform` **(** :ref:`RID` voxel_gi **)** |const| | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`voxel_gi_set_baked_exposure_normalization` **(** :ref:`RID` voxel_gi, :ref:`float` baked_exposure **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`voxel_gi_set_bias` **(** :ref:`RID` voxel_gi, :ref:`float` bias **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`voxel_gi_set_dynamic_range` **(** :ref:`RID` voxel_gi, :ref:`float` range **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`voxel_gi_set_energy` **(** :ref:`RID` voxel_gi, :ref:`float` energy **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`voxel_gi_set_interior` **(** :ref:`RID` voxel_gi, :ref:`bool` enable **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`voxel_gi_set_normal_bias` **(** :ref:`RID` voxel_gi, :ref:`float` bias **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`voxel_gi_set_propagation` **(** :ref:`RID` voxel_gi, :ref:`float` amount **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`voxel_gi_set_quality` **(** :ref:`VoxelGIQuality` quality **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`voxel_gi_set_use_two_bounces` **(** :ref:`RID` voxel_gi, :ref:`bool` enable **)** | ++----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -1448,7 +1454,7 @@ enum **LightParam**: - **LIGHT_PARAM_TRANSMITTANCE_BIAS** = **19** -- **LIGHT_PARAM_MAX** = **20** --- Represents the size of the :ref:`LightParam` enum. +- **LIGHT_PARAM_MAX** = **21** --- Represents the size of the :ref:`LightParam` enum. ---- @@ -2908,7 +2914,7 @@ enum **CanvasOccluderPolygonCullMode**: ---- -.. _enum_RenderingServer_GlobalShaderUniformType: +.. _enum_RenderingServer_GlobalShaderParameterType: .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_BOOL: @@ -2968,7 +2974,7 @@ enum **CanvasOccluderPolygonCullMode**: .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_MAX: -enum **GlobalShaderUniformType**: +enum **GlobalShaderParameterType**: - **GLOBAL_VAR_TYPE_BOOL** = **0** @@ -3155,7 +3161,63 @@ Method Descriptions .. _class_RenderingServer_method_bake_render_uv2: -- :ref:`Image[]` **bake_render_uv2** **(** :ref:`RID` base, :ref:`Array` material_overrides, :ref:`Vector2i` image_size **)** +- :ref:`Image[]` **bake_render_uv2** **(** :ref:`RID` base, :ref:`RID[]` material_overrides, :ref:`Vector2i` image_size **)** + +---- + +.. _class_RenderingServer_method_camera_attributes_create: + +- :ref:`RID` **camera_attributes_create** **(** **)** + +Creates a camera attributes object and adds it to the RenderingServer. It can be accessed with the RID that is returned. This RID will be used in all ``camera_attributes_`` RenderingServer functions. + +Once finished with your RID, you will want to free the RID using the RenderingServer's :ref:`free_rid` static method. + +---- + +.. _class_RenderingServer_method_camera_attributes_set_auto_exposure: + +- void **camera_attributes_set_auto_exposure** **(** :ref:`RID` camera_attributes, :ref:`bool` enable, :ref:`float` min_sensitivity, :ref:`float` max_sensitivity, :ref:`float` speed, :ref:`float` scale **)** + +---- + +.. _class_RenderingServer_method_camera_attributes_set_dof_blur: + +- void **camera_attributes_set_dof_blur** **(** :ref:`RID` camera_attributes, :ref:`bool` far_enable, :ref:`float` far_distance, :ref:`float` far_transition, :ref:`bool` near_enable, :ref:`float` near_distance, :ref:`float` near_transition, :ref:`float` amount **)** + +---- + +.. _class_RenderingServer_method_camera_attributes_set_dof_blur_bokeh_shape: + +- void **camera_attributes_set_dof_blur_bokeh_shape** **(** :ref:`DOFBokehShape` shape **)** + +---- + +.. _class_RenderingServer_method_camera_attributes_set_dof_blur_quality: + +- void **camera_attributes_set_dof_blur_quality** **(** :ref:`DOFBlurQuality` quality, :ref:`bool` use_jitter **)** + +---- + +.. _class_RenderingServer_method_camera_attributes_set_exposure: + +- void **camera_attributes_set_exposure** **(** :ref:`RID` camera_attributes, :ref:`float` multiplier, :ref:`float` normalization **)** + +Sets the exposure values that will be used by the renderers. The normalization amount is used to bake a given Exposure Value (EV) into rendering calculations to reduce the dynamic range of the scene. + +The normalization factor can be calculated from exposure value (EV100) as follows: + +:: + + func get_exposure_normalization(float ev100): + return 1.0 / (pow(2.0, ev100) * 1.2) + +The exposure value can be calculated from aperture (in f-stops), shutter speed (in seconds), and sensitivity (in ISO) as follows: + +:: + + func get_exposure(float aperture, float shutter_speed, float sensitivity): + return log2((aperture * aperture) / shutterSpeed * (100.0 / sensitivity)) ---- @@ -3169,39 +3231,9 @@ Once finished with your RID, you will want to free the RID using the RenderingSe ---- -.. _class_RenderingServer_method_camera_effects_create: +.. _class_RenderingServer_method_camera_set_camera_attributes: -- :ref:`RID` **camera_effects_create** **(** **)** - ----- - -.. _class_RenderingServer_method_camera_effects_set_custom_exposure: - -- void **camera_effects_set_custom_exposure** **(** :ref:`RID` camera_effects, :ref:`bool` enable, :ref:`float` exposure **)** - ----- - -.. _class_RenderingServer_method_camera_effects_set_dof_blur: - -- void **camera_effects_set_dof_blur** **(** :ref:`RID` camera_effects, :ref:`bool` far_enable, :ref:`float` far_distance, :ref:`float` far_transition, :ref:`bool` near_enable, :ref:`float` near_distance, :ref:`float` near_transition, :ref:`float` amount **)** - ----- - -.. _class_RenderingServer_method_camera_effects_set_dof_blur_bokeh_shape: - -- void **camera_effects_set_dof_blur_bokeh_shape** **(** :ref:`DOFBokehShape` shape **)** - ----- - -.. _class_RenderingServer_method_camera_effects_set_dof_blur_quality: - -- void **camera_effects_set_dof_blur_quality** **(** :ref:`DOFBlurQuality` quality, :ref:`bool` use_jitter **)** - ----- - -.. _class_RenderingServer_method_camera_set_camera_effects: - -- void **camera_set_camera_effects** **(** :ref:`RID` camera, :ref:`RID` effects **)** +- void **camera_set_camera_attributes** **(** :ref:`RID` camera, :ref:`RID` effects **)** ---- @@ -3983,7 +4015,7 @@ Color displayed for clear areas of the scene (if using Custom color or Color+Sky .. _class_RenderingServer_method_environment_set_bg_energy: -- void **environment_set_bg_energy** **(** :ref:`RID` env, :ref:`float` energy **)** +- void **environment_set_bg_energy** **(** :ref:`RID` env, :ref:`float` multiplier, :ref:`float` exposure_value **)** Sets the intensity of the background color. @@ -3999,7 +4031,7 @@ Sets the maximum layer to use if using Canvas background mode. .. _class_RenderingServer_method_environment_set_fog: -- void **environment_set_fog** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`Color` light_color, :ref:`float` light_energy, :ref:`float` sun_scatter, :ref:`float` density, :ref:`float` height, :ref:`float` height_density, :ref:`float` aerial_perspective **)** +- void **environment_set_fog** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`Color` light_color, :ref:`float` light_energy, :ref:`float` sun_scatter, :ref:`float` density, :ref:`float` height, :ref:`float` height_density, :ref:`float` aerial_perspective, :ref:`float` sky_affect **)** ---- @@ -4097,7 +4129,7 @@ Sets the variables to be used with the "screen space reflections" post-process e .. _class_RenderingServer_method_environment_set_tonemap: -- void **environment_set_tonemap** **(** :ref:`RID` env, :ref:`EnvironmentToneMapper` tone_mapper, :ref:`float` exposure, :ref:`float` white, :ref:`bool` auto_exposure, :ref:`float` min_luminance, :ref:`float` max_luminance, :ref:`float` auto_exp_speed, :ref:`float` auto_exp_grey **)** +- void **environment_set_tonemap** **(** :ref:`RID` env, :ref:`EnvironmentToneMapper` tone_mapper, :ref:`float` exposure, :ref:`float` white **)** Sets the variables to be used with the "tonemap" post-process effect. See :ref:`Environment` for more details. @@ -4105,7 +4137,7 @@ Sets the variables to be used with the "tonemap" post-process effect. See :ref:` .. _class_RenderingServer_method_environment_set_volumetric_fog: -- void **environment_set_volumetric_fog** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` density, :ref:`Color` albedo, :ref:`Color` emission, :ref:`float` emission_energy, :ref:`float` anisotropy, :ref:`float` length, :ref:`float` p_detail_spread, :ref:`float` gi_inject, :ref:`bool` temporal_reprojection, :ref:`float` temporal_reprojection_amount, :ref:`float` ambient_inject **)** +- void **environment_set_volumetric_fog** **(** :ref:`RID` env, :ref:`bool` enable, :ref:`float` density, :ref:`Color` albedo, :ref:`Color` emission, :ref:`float` emission_energy, :ref:`float` anisotropy, :ref:`float` length, :ref:`float` p_detail_spread, :ref:`float` gi_inject, :ref:`bool` temporal_reprojection, :ref:`float` temporal_reprojection_amount, :ref:`float` ambient_inject, :ref:`float` sky_affect **)** ---- @@ -4195,6 +4227,14 @@ Tries to free an object in the RenderingServer. ---- +.. _class_RenderingServer_method_get_shader_parameter_list: + +- :ref:`Dictionary[]` **get_shader_parameter_list** **(** :ref:`RID` shader **)** |const| + +Returns the parameters of a shader. + +---- + .. _class_RenderingServer_method_get_test_cube: - :ref:`RID` **get_test_cube** **(** **)** @@ -4267,45 +4307,45 @@ If ``half_resolution`` is ``true``, renders :ref:`VoxelGI` and SD ---- -.. _class_RenderingServer_method_global_shader_uniform_add: +.. _class_RenderingServer_method_global_shader_parameter_add: -- void **global_shader_uniform_add** **(** :ref:`StringName` name, :ref:`GlobalShaderUniformType` type, :ref:`Variant` default_value **)** +- void **global_shader_parameter_add** **(** :ref:`StringName` name, :ref:`GlobalShaderParameterType` type, :ref:`Variant` default_value **)** ---- -.. _class_RenderingServer_method_global_shader_uniform_get: +.. _class_RenderingServer_method_global_shader_parameter_get: -- :ref:`Variant` **global_shader_uniform_get** **(** :ref:`StringName` name **)** |const| +- :ref:`Variant` **global_shader_parameter_get** **(** :ref:`StringName` name **)** |const| ---- -.. _class_RenderingServer_method_global_shader_uniform_get_list: +.. _class_RenderingServer_method_global_shader_parameter_get_list: -- :ref:`PackedStringArray` **global_shader_uniform_get_list** **(** **)** |const| +- :ref:`PackedStringArray` **global_shader_parameter_get_list** **(** **)** |const| ---- -.. _class_RenderingServer_method_global_shader_uniform_get_type: +.. _class_RenderingServer_method_global_shader_parameter_get_type: -- :ref:`GlobalShaderUniformType` **global_shader_uniform_get_type** **(** :ref:`StringName` name **)** |const| +- :ref:`GlobalShaderParameterType` **global_shader_parameter_get_type** **(** :ref:`StringName` name **)** |const| ---- -.. _class_RenderingServer_method_global_shader_uniform_remove: +.. _class_RenderingServer_method_global_shader_parameter_remove: -- void **global_shader_uniform_remove** **(** :ref:`StringName` name **)** +- void **global_shader_parameter_remove** **(** :ref:`StringName` name **)** ---- -.. _class_RenderingServer_method_global_shader_uniform_set: +.. _class_RenderingServer_method_global_shader_parameter_set: -- void **global_shader_uniform_set** **(** :ref:`StringName` name, :ref:`Variant` value **)** +- void **global_shader_parameter_set** **(** :ref:`StringName` name, :ref:`Variant` value **)** ---- -.. _class_RenderingServer_method_global_shader_uniform_set_override: +.. _class_RenderingServer_method_global_shader_parameter_set_override: -- void **global_shader_uniform_set_override** **(** :ref:`StringName` name, :ref:`Variant` value **)** +- void **global_shader_parameter_set_override** **(** :ref:`StringName` name, :ref:`Variant` value **)** ---- @@ -4371,21 +4411,21 @@ Once finished with your RID, you will want to free the RID using the RenderingSe ---- -.. _class_RenderingServer_method_instance_geometry_get_shader_uniform: +.. _class_RenderingServer_method_instance_geometry_get_shader_parameter: -- :ref:`Variant` **instance_geometry_get_shader_uniform** **(** :ref:`RID` instance, :ref:`StringName` parameter **)** |const| +- :ref:`Variant` **instance_geometry_get_shader_parameter** **(** :ref:`RID` instance, :ref:`StringName` parameter **)** |const| ---- -.. _class_RenderingServer_method_instance_geometry_get_shader_uniform_default_value: +.. _class_RenderingServer_method_instance_geometry_get_shader_parameter_default_value: -- :ref:`Variant` **instance_geometry_get_shader_uniform_default_value** **(** :ref:`RID` instance, :ref:`StringName` parameter **)** |const| +- :ref:`Variant` **instance_geometry_get_shader_parameter_default_value** **(** :ref:`RID` instance, :ref:`StringName` parameter **)** |const| ---- -.. _class_RenderingServer_method_instance_geometry_get_shader_uniform_list: +.. _class_RenderingServer_method_instance_geometry_get_shader_parameter_list: -- :ref:`Dictionary[]` **instance_geometry_get_shader_uniform_list** **(** :ref:`RID` instance **)** |const| +- :ref:`Dictionary[]` **instance_geometry_get_shader_parameter_list** **(** :ref:`RID` instance **)** |const| ---- @@ -4433,9 +4473,9 @@ Sets a material that will override the material for all surfaces on the mesh ass ---- -.. _class_RenderingServer_method_instance_geometry_set_shader_uniform: +.. _class_RenderingServer_method_instance_geometry_set_shader_parameter: -- void **instance_geometry_set_shader_uniform** **(** :ref:`RID` instance, :ref:`StringName` parameter, :ref:`Variant` value **)** +- void **instance_geometry_set_shader_parameter** **(** :ref:`RID` instance, :ref:`StringName` parameter, :ref:`Variant` value **)** ---- @@ -4559,7 +4599,7 @@ Returns an array of object IDs intersecting with the provided AABB. Only visual .. _class_RenderingServer_method_instances_cull_convex: -- :ref:`PackedInt64Array` **instances_cull_convex** **(** :ref:`Array` convex, :ref:`RID` scenario **)** |const| +- :ref:`PackedInt64Array` **instances_cull_convex** **(** :ref:`Plane[]` convex, :ref:`RID` scenario **)** |const| Returns an array of object IDs intersecting with the provided convex shape. Only visual 3D nodes are considered, such as :ref:`MeshInstance3D` or :ref:`DirectionalLight3D`. Use :ref:`@GlobalScope.instance_from_id` to obtain the actual nodes. A scenario RID must be provided, which is available in the :ref:`World3D` you want to query. This forces an update for all resources queued to update. @@ -4721,6 +4761,14 @@ If ``true``, light will cast shadows. Equivalent to :ref:`Light3D.shadow_enabled ---- +.. _class_RenderingServer_method_lightmap_set_baked_exposure_normalization: + +- void **lightmap_set_baked_exposure_normalization** **(** :ref:`RID` lightmap, :ref:`float` baked_exposure **)** + +Used to inform the renderer what exposure normalization value was used while baking the lightmap. This value will be used and modulated at run time to ensure that the lightmap maintains a consistent level of exposure even if the scene-wide exposure normalization is changed at run time. For more information see :ref:`camera_attributes_set_exposure`. + +---- + .. _class_RenderingServer_method_lightmap_set_probe_bounds: - void **lightmap_set_probe_bounds** **(** :ref:`RID` lightmap, :ref:`AABB` bounds **)** @@ -5591,9 +5639,9 @@ The scenario is the 3D world that all the visual instances exist in. ---- -.. _class_RenderingServer_method_scenario_set_camera_effects: +.. _class_RenderingServer_method_scenario_set_camera_attributes: -- void **scenario_set_camera_effects** **(** :ref:`RID` scenario, :ref:`RID` effects **)** +- void **scenario_set_camera_attributes** **(** :ref:`RID` scenario, :ref:`RID` effects **)** ---- @@ -5661,9 +5709,9 @@ Returns a shader's code. ---- -.. _class_RenderingServer_method_shader_get_default_texture_param: +.. _class_RenderingServer_method_shader_get_default_texture_parameter: -- :ref:`RID` **shader_get_default_texture_param** **(** :ref:`RID` shader, :ref:`StringName` param, :ref:`int` index=0 **)** |const| +- :ref:`RID` **shader_get_default_texture_parameter** **(** :ref:`RID` shader, :ref:`StringName` name, :ref:`int` index=0 **)** |const| Returns a default texture from a shader searched by name. @@ -5671,17 +5719,9 @@ Returns a default texture from a shader searched by name. ---- -.. _class_RenderingServer_method_shader_get_param_default: +.. _class_RenderingServer_method_shader_get_parameter_default: -- :ref:`Variant` **shader_get_param_default** **(** :ref:`RID` shader, :ref:`StringName` param **)** |const| - ----- - -.. _class_RenderingServer_method_shader_get_shader_uniform_list: - -- :ref:`Dictionary[]` **shader_get_shader_uniform_list** **(** :ref:`RID` shader **)** |const| - -Returns the parameters of a shader. +- :ref:`Variant` **shader_get_parameter_default** **(** :ref:`RID` shader, :ref:`StringName` name **)** |const| ---- @@ -5691,9 +5731,9 @@ Returns the parameters of a shader. ---- -.. _class_RenderingServer_method_shader_set_default_texture_param: +.. _class_RenderingServer_method_shader_set_default_texture_parameter: -- void **shader_set_default_texture_param** **(** :ref:`RID` shader, :ref:`StringName` param, :ref:`RID` texture, :ref:`int` index=0 **)** +- void **shader_set_default_texture_parameter** **(** :ref:`RID` shader, :ref:`StringName` name, :ref:`RID` texture, :ref:`int` index=0 **)** Sets a shader's default texture. Overwrites the texture given by name. @@ -6378,6 +6418,14 @@ Texture to use when the VRS mode is set to :ref:`VIEWPORT_VRS_TEXTURE` voxel_gi, :ref:`float` baked_exposure **)** + +Used to inform the renderer what exposure normalization value was used while baking the voxel gi. This value will be used and modulated at run time to ensure that the voxel gi maintains a consistent level of exposure even if the scene-wide exposure normalization is changed at run time. For more information see :ref:`camera_attributes_set_exposure`. + +---- + .. _class_RenderingServer_method_voxel_gi_set_bias: - void **voxel_gi_set_bias** **(** :ref:`RID` voxel_gi, :ref:`float` bias **)** diff --git a/classes/class_resource.rst b/classes/class_resource.rst index 464828cd2..98dae4938 100644 --- a/classes/class_resource.rst +++ b/classes/class_resource.rst @@ -12,7 +12,7 @@ Resource **Inherits:** :ref:`RefCounted` **<** :ref:`Object` -**Inherited By:** :ref:`Animation`, :ref:`AnimationLibrary`, :ref:`AnimationNode`, :ref:`AnimationNodeStateMachinePlayback`, :ref:`AnimationNodeStateMachineTransition`, :ref:`AudioBusLayout`, :ref:`AudioEffect`, :ref:`AudioStream`, :ref:`BitMap`, :ref:`BoneMap`, :ref:`ButtonGroup`, :ref:`CameraEffects`, :ref:`CryptoKey`, :ref:`Curve`, :ref:`Curve2D`, :ref:`Curve3D`, :ref:`EditorNode3DGizmoPlugin`, :ref:`EditorSettings`, :ref:`Environment`, :ref:`Font`, :ref:`GLTFAccessor`, :ref:`GLTFAnimation`, :ref:`GLTFBufferView`, :ref:`GLTFCamera`, :ref:`GLTFDocument`, :ref:`GLTFDocumentExtension`, :ref:`GLTFLight`, :ref:`GLTFMesh`, :ref:`GLTFNode`, :ref:`GLTFSkeleton`, :ref:`GLTFSkin`, :ref:`GLTFSpecGloss`, :ref:`GLTFState`, :ref:`GLTFTexture`, :ref:`Gradient`, :ref:`Image`, :ref:`ImporterMesh`, :ref:`InputEvent`, :ref:`LabelSettings`, :ref:`LightmapGIData`, :ref:`Material`, :ref:`Mesh`, :ref:`MeshLibrary`, :ref:`MissingResource`, :ref:`MultiMesh`, :ref:`NativeExtension`, :ref:`NavigationMesh`, :ref:`NavigationPolygon`, :ref:`Noise`, :ref:`Occluder3D`, :ref:`OccluderPolygon2D`, :ref:`OggPacketSequence`, :ref:`OpenXRAction`, :ref:`OpenXRActionMap`, :ref:`OpenXRActionSet`, :ref:`OpenXRIPBinding`, :ref:`OpenXRInteractionProfile`, :ref:`PackedDataContainer`, :ref:`PackedScene`, :ref:`PhysicsMaterial`, :ref:`PolygonPathFinder`, :ref:`RDShaderFile`, :ref:`RDShaderSPIRV`, :ref:`RichTextEffect`, :ref:`SceneReplicationConfig`, :ref:`Script`, :ref:`Shader`, :ref:`ShaderInclude`, :ref:`Shape2D`, :ref:`Shape3D`, :ref:`Shortcut`, :ref:`SkeletonModification2D`, :ref:`SkeletonModification3D`, :ref:`SkeletonModificationStack2D`, :ref:`SkeletonModificationStack3D`, :ref:`SkeletonProfile`, :ref:`Skin`, :ref:`Sky`, :ref:`SpriteFrames`, :ref:`StyleBox`, :ref:`SyntaxHighlighter`, :ref:`Texture`, :ref:`Theme`, :ref:`TileMapPattern`, :ref:`TileSet`, :ref:`TileSetSource`, :ref:`Translation`, :ref:`VideoStream`, :ref:`VisualShaderNode`, :ref:`VoxelGIData`, :ref:`World2D`, :ref:`World3D`, :ref:`X509Certificate` +**Inherited By:** :ref:`Animation`, :ref:`AnimationLibrary`, :ref:`AnimationNode`, :ref:`AnimationNodeStateMachinePlayback`, :ref:`AnimationNodeStateMachineTransition`, :ref:`AudioBusLayout`, :ref:`AudioEffect`, :ref:`AudioStream`, :ref:`BitMap`, :ref:`BoneMap`, :ref:`ButtonGroup`, :ref:`CameraAttributes`, :ref:`CryptoKey`, :ref:`Curve`, :ref:`Curve2D`, :ref:`Curve3D`, :ref:`EditorNode3DGizmoPlugin`, :ref:`EditorSettings`, :ref:`Environment`, :ref:`Font`, :ref:`GLTFAccessor`, :ref:`GLTFAnimation`, :ref:`GLTFBufferView`, :ref:`GLTFCamera`, :ref:`GLTFDocument`, :ref:`GLTFDocumentExtension`, :ref:`GLTFLight`, :ref:`GLTFMesh`, :ref:`GLTFNode`, :ref:`GLTFSkeleton`, :ref:`GLTFSkin`, :ref:`GLTFSpecGloss`, :ref:`GLTFState`, :ref:`GLTFTexture`, :ref:`Gradient`, :ref:`Image`, :ref:`ImporterMesh`, :ref:`InputEvent`, :ref:`LabelSettings`, :ref:`LightmapGIData`, :ref:`Material`, :ref:`Mesh`, :ref:`MeshLibrary`, :ref:`MissingResource`, :ref:`MultiMesh`, :ref:`NativeExtension`, :ref:`NavigationMesh`, :ref:`NavigationPolygon`, :ref:`Noise`, :ref:`Occluder3D`, :ref:`OccluderPolygon2D`, :ref:`OggPacketSequence`, :ref:`OpenXRAction`, :ref:`OpenXRActionMap`, :ref:`OpenXRActionSet`, :ref:`OpenXRIPBinding`, :ref:`OpenXRInteractionProfile`, :ref:`PackedDataContainer`, :ref:`PackedScene`, :ref:`PhysicsMaterial`, :ref:`PolygonPathFinder`, :ref:`RDShaderFile`, :ref:`RDShaderSPIRV`, :ref:`RichTextEffect`, :ref:`SceneReplicationConfig`, :ref:`Script`, :ref:`Shader`, :ref:`ShaderInclude`, :ref:`Shape2D`, :ref:`Shape3D`, :ref:`Shortcut`, :ref:`SkeletonModification2D`, :ref:`SkeletonModification3D`, :ref:`SkeletonModificationStack2D`, :ref:`SkeletonModificationStack3D`, :ref:`SkeletonProfile`, :ref:`Skin`, :ref:`Sky`, :ref:`SpriteFrames`, :ref:`StyleBox`, :ref:`SyntaxHighlighter`, :ref:`Texture`, :ref:`Theme`, :ref:`TileMapPattern`, :ref:`TileSet`, :ref:`TileSetSource`, :ref:`Translation`, :ref:`VideoStream`, :ref:`VisualShaderNode`, :ref:`VoxelGIData`, :ref:`World2D`, :ref:`World3D`, :ref:`X509Certificate` Base class for all resources. diff --git a/classes/class_scenetree.rst b/classes/class_scenetree.rst index 8ef4e5b1d..ca032ff7d 100644 --- a/classes/class_scenetree.rst +++ b/classes/class_scenetree.rst @@ -58,49 +58,49 @@ Properties Methods ------- -+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`call_group` **(** :ref:`StringName` group, :ref:`StringName` method, ... **)** |vararg| | -+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`call_group_flags` **(** :ref:`int` flags, :ref:`StringName` group, :ref:`StringName` method, ... **)** |vararg| | -+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`change_scene` **(** :ref:`String` path **)** | -+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`change_scene_to` **(** :ref:`PackedScene` packed_scene **)** | -+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`SceneTreeTimer` | :ref:`create_timer` **(** :ref:`float` time_sec, :ref:`bool` process_always=true **)** | -+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Tween` | :ref:`create_tween` **(** **)** | -+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node` | :ref:`get_first_node_in_group` **(** :ref:`StringName` group **)** | -+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_frame` **(** **)** |const| | -+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`MultiplayerAPI` | :ref:`get_multiplayer` **(** :ref:`NodePath` for_path=NodePath("") **)** |const| | -+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_node_count` **(** **)** |const| | -+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Node[]` | :ref:`get_nodes_in_group` **(** :ref:`StringName` group **)** | -+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Tween[]` | :ref:`get_processed_tweens` **(** **)** | -+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_group` **(** :ref:`StringName` name **)** |const| | -+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`notify_group` **(** :ref:`StringName` group, :ref:`int` notification **)** | -+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`notify_group_flags` **(** :ref:`int` call_flags, :ref:`StringName` group, :ref:`int` notification **)** | -+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`queue_delete` **(** :ref:`Object` obj **)** | -+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`quit` **(** :ref:`int` exit_code=0 **)** | -+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`reload_current_scene` **(** **)** | -+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_group` **(** :ref:`StringName` group, :ref:`String` property, :ref:`Variant` value **)** | -+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_group_flags` **(** :ref:`int` call_flags, :ref:`StringName` group, :ref:`String` property, :ref:`Variant` value **)** | -+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_multiplayer` **(** :ref:`MultiplayerAPI` multiplayer, :ref:`NodePath` root_path=NodePath("") **)** | -+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`call_group` **(** :ref:`StringName` group, :ref:`StringName` method, ... **)** |vararg| | ++---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`call_group_flags` **(** :ref:`int` flags, :ref:`StringName` group, :ref:`StringName` method, ... **)** |vararg| | ++---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`change_scene_to_file` **(** :ref:`String` path **)** | ++---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`change_scene_to_packed` **(** :ref:`PackedScene` packed_scene **)** | ++---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`SceneTreeTimer` | :ref:`create_timer` **(** :ref:`float` time_sec, :ref:`bool` process_always=true, :ref:`bool` process_in_physics=false, :ref:`bool` ignore_time_scale=false **)** | ++---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Tween` | :ref:`create_tween` **(** **)** | ++---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node` | :ref:`get_first_node_in_group` **(** :ref:`StringName` group **)** | ++---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_frame` **(** **)** |const| | ++---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`MultiplayerAPI` | :ref:`get_multiplayer` **(** :ref:`NodePath` for_path=NodePath("") **)** |const| | ++---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_node_count` **(** **)** |const| | ++---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Node[]` | :ref:`get_nodes_in_group` **(** :ref:`StringName` group **)** | ++---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Tween[]` | :ref:`get_processed_tweens` **(** **)** | ++---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_group` **(** :ref:`StringName` name **)** |const| | ++---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`notify_group` **(** :ref:`StringName` group, :ref:`int` notification **)** | ++---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`notify_group_flags` **(** :ref:`int` call_flags, :ref:`StringName` group, :ref:`int` notification **)** | ++---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`queue_delete` **(** :ref:`Object` obj **)** | ++---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`quit` **(** :ref:`int` exit_code=0 **)** | ++---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`reload_current_scene` **(** **)** | ++---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_group` **(** :ref:`StringName` group, :ref:`String` property, :ref:`Variant` value **)** | ++---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_group_flags` **(** :ref:`int` call_flags, :ref:`StringName` group, :ref:`String` property, :ref:`Variant` value **)** | ++---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_multiplayer` **(** :ref:`MultiplayerAPI` multiplayer, :ref:`NodePath` root_path=NodePath("") **)** | ++---------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -387,35 +387,41 @@ Calls ``method`` on each member of the given group, respecting the given :ref:`G ---- -.. _class_SceneTree_method_change_scene: +.. _class_SceneTree_method_change_scene_to_file: -- :ref:`Error` **change_scene** **(** :ref:`String` path **)** +- :ref:`Error` **change_scene_to_file** **(** :ref:`String` path **)** Changes the running scene to the one at the given ``path``, after loading it into a :ref:`PackedScene` and creating a new instance. Returns :ref:`@GlobalScope.OK` on success, :ref:`@GlobalScope.ERR_CANT_OPEN` if the ``path`` cannot be loaded into a :ref:`PackedScene`, or :ref:`@GlobalScope.ERR_CANT_CREATE` if that scene cannot be instantiated. -\ **Note:** The scene change is deferred, which means that the new scene node is added on the next idle frame. You won't be able to access it immediately after the :ref:`change_scene` call. +\ **Note:** The scene change is deferred, which means that the new scene node is added on the next idle frame. You won't be able to access it immediately after the :ref:`change_scene_to_file` call. ---- -.. _class_SceneTree_method_change_scene_to: +.. _class_SceneTree_method_change_scene_to_packed: -- :ref:`Error` **change_scene_to** **(** :ref:`PackedScene` packed_scene **)** +- :ref:`Error` **change_scene_to_packed** **(** :ref:`PackedScene` packed_scene **)** Changes the running scene to a new instance of the given :ref:`PackedScene`. Returns :ref:`@GlobalScope.OK` on success or :ref:`@GlobalScope.ERR_CANT_CREATE` if the scene cannot be instantiated. -\ **Note:** The scene change is deferred, which means that the new scene node is added on the next idle frame. You won't be able to access it immediately after the :ref:`change_scene_to` call. +\ **Note:** The scene change is deferred, which means that the new scene node is added on the next idle frame. You won't be able to access it immediately after the :ref:`change_scene_to_packed` call. ---- .. _class_SceneTree_method_create_timer: -- :ref:`SceneTreeTimer` **create_timer** **(** :ref:`float` time_sec, :ref:`bool` process_always=true **)** +- :ref:`SceneTreeTimer` **create_timer** **(** :ref:`float` time_sec, :ref:`bool` process_always=true, :ref:`bool` process_in_physics=false, :ref:`bool` ignore_time_scale=false **)** -Returns a :ref:`SceneTreeTimer` which will :ref:`SceneTreeTimer.timeout` after the given time in seconds elapsed in this ``SceneTree``. If ``process_always`` is set to ``false``, pausing the ``SceneTree`` will also pause the timer. +Returns a :ref:`SceneTreeTimer` which will :ref:`SceneTreeTimer.timeout` after the given time in seconds elapsed in this ``SceneTree``. + +If ``process_always`` is set to ``false``, pausing the ``SceneTree`` will also pause the timer. + +If ``process_in_physics`` is set to ``true``, will update the :ref:`SceneTreeTimer` during the physics frame instead of the process frame (fixed framerate processing). + +If ``ignore_time_scale`` is set to ``true``, will ignore :ref:`Engine.time_scale` and update the :ref:`SceneTreeTimer` with the actual frame delta. Commonly used to create a one-shot delay timer as in the following example: diff --git a/classes/class_scrollcontainer.rst b/classes/class_scrollcontainer.rst index c699db046..f99c339b1 100644 --- a/classes/class_scrollcontainer.rst +++ b/classes/class_scrollcontainer.rst @@ -63,9 +63,9 @@ Methods Theme Properties ---------------- -+---------------------------------+-------------------------------------------------+ -| :ref:`StyleBox` | :ref:`bg` | -+---------------------------------+-------------------------------------------------+ ++---------------------------------+-------------------------------------------------------+ +| :ref:`StyleBox` | :ref:`panel` | ++---------------------------------+-------------------------------------------------------+ Signals ------- @@ -242,9 +242,9 @@ Returns the vertical scrollbar :ref:`VScrollBar` of this ``Scr Theme Property Descriptions --------------------------- -.. _class_ScrollContainer_theme_style_bg: +.. _class_ScrollContainer_theme_style_panel: -- :ref:`StyleBox` **bg** +- :ref:`StyleBox` **panel** The background :ref:`StyleBox` of the ``ScrollContainer``. diff --git a/classes/class_shader.rst b/classes/class_shader.rst index adb531d64..1c924479b 100644 --- a/classes/class_shader.rst +++ b/classes/class_shader.rst @@ -36,15 +36,15 @@ Properties Methods ------- -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Texture2D` | :ref:`get_default_texture_param` **(** :ref:`StringName` param, :ref:`int` index=0 **)** |const| | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Mode` | :ref:`get_mode` **(** **)** |const| | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_uniform` **(** :ref:`StringName` name **)** |const| | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_default_texture_param` **(** :ref:`StringName` param, :ref:`Texture2D` texture, :ref:`int` index=0 **)** | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Texture2D` | :ref:`get_default_texture_parameter` **(** :ref:`StringName` name, :ref:`int` index=0 **)** |const| | ++-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Mode` | :ref:`get_mode` **(** **)** |const| | ++-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_parameter` **(** :ref:`StringName` name **)** |const| | ++-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_default_texture_parameter` **(** :ref:`StringName` name, :ref:`Texture2D` texture, :ref:`int` index=0 **)** | ++-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ @@ -93,13 +93,13 @@ Returns the shader's code as the user has written it, not the full generated cod Method Descriptions ------------------- -.. _class_Shader_method_get_default_texture_param: +.. _class_Shader_method_get_default_texture_parameter: -- :ref:`Texture2D` **get_default_texture_param** **(** :ref:`StringName` param, :ref:`int` index=0 **)** |const| +- :ref:`Texture2D` **get_default_texture_parameter** **(** :ref:`StringName` name, :ref:`int` index=0 **)** |const| Returns the texture that is set as default for the specified parameter. -\ **Note:** ``param`` must match the name of the uniform in the code exactly. +\ **Note:** ``name`` must match the name of the uniform in the code exactly. \ **Note:** If the sampler array is used use ``index`` to access the specified texture. @@ -113,9 +113,9 @@ Returns the shader mode for the shader, either :ref:`MODE_CANVAS_ITEM` **has_uniform** **(** :ref:`StringName` name **)** |const| +- :ref:`bool` **has_parameter** **(** :ref:`StringName` name **)** |const| Returns ``true`` if the shader has this param defined as a uniform in its code. @@ -123,13 +123,13 @@ Returns ``true`` if the shader has this param defined as a uniform in its code. ---- -.. _class_Shader_method_set_default_texture_param: +.. _class_Shader_method_set_default_texture_parameter: -- void **set_default_texture_param** **(** :ref:`StringName` param, :ref:`Texture2D` texture, :ref:`int` index=0 **)** +- void **set_default_texture_parameter** **(** :ref:`StringName` name, :ref:`Texture2D` texture, :ref:`int` index=0 **)** Sets the default texture to be used with a texture uniform. The default is used if a texture is not set in the :ref:`ShaderMaterial`. -\ **Note:** ``param`` must match the name of the uniform in the code exactly. +\ **Note:** ``name`` must match the name of the uniform in the code exactly. \ **Note:** If the sampler array is used use ``index`` to access the specified texture. diff --git a/classes/class_shadermaterial.rst b/classes/class_shadermaterial.rst index 432307536..a72c14b56 100644 --- a/classes/class_shadermaterial.rst +++ b/classes/class_shadermaterial.rst @@ -34,11 +34,11 @@ Properties Methods ------- -+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`get_shader_uniform` **(** :ref:`StringName` param **)** |const| | -+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_shader_uniform` **(** :ref:`StringName` param, :ref:`Variant` value **)** | -+-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`get_shader_parameter` **(** :ref:`StringName` param **)** |const| | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_shader_parameter` **(** :ref:`StringName` param, :ref:`Variant` value **)** | ++-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- @@ -58,17 +58,17 @@ The :ref:`Shader` program used to render this material. Method Descriptions ------------------- -.. _class_ShaderMaterial_method_get_shader_uniform: +.. _class_ShaderMaterial_method_get_shader_parameter: -- :ref:`Variant` **get_shader_uniform** **(** :ref:`StringName` param **)** |const| +- :ref:`Variant` **get_shader_parameter** **(** :ref:`StringName` param **)** |const| Returns the current value set for this material of a uniform in the shader. ---- -.. _class_ShaderMaterial_method_set_shader_uniform: +.. _class_ShaderMaterial_method_set_shader_parameter: -- void **set_shader_uniform** **(** :ref:`StringName` param, :ref:`Variant` value **)** +- void **set_shader_parameter** **(** :ref:`StringName` param, :ref:`Variant` value **)** Changes the value set for this material of a uniform in the shader. diff --git a/classes/class_splitcontainer.rst b/classes/class_splitcontainer.rst index 92235c8c4..75a92b2da 100644 --- a/classes/class_splitcontainer.rst +++ b/classes/class_splitcontainer.rst @@ -36,6 +36,8 @@ Properties +-----------------------------------------------------------------+-----------------------------------------------------------------------------+-----------+ | :ref:`int` | :ref:`split_offset` | ``0`` | +-----------------------------------------------------------------+-----------------------------------------------------------------------------+-----------+ +| :ref:`bool` | :ref:`vertical` | ``false`` | ++-----------------------------------------------------------------+-----------------------------------------------------------------------------+-----------+ Methods ------- @@ -44,6 +46,21 @@ Methods | void | :ref:`clamp_split_offset` **(** **)** | +------+---------------------------------------------------------------------------------------+ +Theme Properties +---------------- + ++-----------------------------------+-------------------------------------------------------------------------------------------+--------+ +| :ref:`int` | :ref:`autohide` | ``1`` | ++-----------------------------------+-------------------------------------------------------------------------------------------+--------+ +| :ref:`int` | :ref:`minimum_grab_thickness` | ``6`` | ++-----------------------------------+-------------------------------------------------------------------------------------------+--------+ +| :ref:`int` | :ref:`separation` | ``12`` | ++-----------------------------------+-------------------------------------------------------------------------------------------+--------+ +| :ref:`Texture2D` | :ref:`h_grabber` | | ++-----------------------------------+-------------------------------------------------------------------------------------------+--------+ +| :ref:`Texture2D` | :ref:`v_grabber` | | ++-----------------------------------+-------------------------------------------------------------------------------------------+--------+ + Signals ------- @@ -121,6 +138,24 @@ Determines the dragger's visibility. See :ref:`DraggerVisibility`\ s, with ``0`` being at the end of the first :ref:`Control`. +---- + +.. _class_SplitContainer_property_vertical: + +- :ref:`bool` **vertical** + ++-----------+---------------------+ +| *Default* | ``false`` | ++-----------+---------------------+ +| *Setter* | set_vertical(value) | ++-----------+---------------------+ +| *Getter* | is_vertical() | ++-----------+---------------------+ + +If ``true``, the ``SplitContainer`` will arrange its children vertically, rather than horizontally. + +Can't be changed when using :ref:`HSplitContainer` and :ref:`VSplitContainer`. + Method Descriptions ------------------- @@ -130,6 +165,59 @@ Method Descriptions Clamps the :ref:`split_offset` value to not go outside the currently possible minimal and maximum values. +Theme Property Descriptions +--------------------------- + +.. _class_SplitContainer_theme_constant_autohide: + +- :ref:`int` **autohide** + ++-----------+-------+ +| *Default* | ``1`` | ++-----------+-------+ + +Boolean value. If 1 (``true``), the grabber will hide automatically when it isn't under the cursor. If 0 (``false``), it's always visible. + +---- + +.. _class_SplitContainer_theme_constant_minimum_grab_thickness: + +- :ref:`int` **minimum_grab_thickness** + ++-----------+-------+ +| *Default* | ``6`` | ++-----------+-------+ + +The minimum thickness of the area users can click on to grab the splitting line. If :ref:`separation` or :ref:`h_grabber` / :ref:`v_grabber`'s thickness are too small, this ensure that the splitting line can still be dragged. + +---- + +.. _class_SplitContainer_theme_constant_separation: + +- :ref:`int` **separation** + ++-----------+--------+ +| *Default* | ``12`` | ++-----------+--------+ + +The space between sides of the container. + +---- + +.. _class_SplitContainer_theme_icon_h_grabber: + +- :ref:`Texture2D` **h_grabber** + +The icon used for the grabber drawn in the middle area when :ref:`vertical` is ``false``. + +---- + +.. _class_SplitContainer_theme_icon_v_grabber: + +- :ref:`Texture2D` **v_grabber** + +The icon used for the grabber drawn in the middle area when :ref:`vertical` is ``true``. + .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_streampeer.rst b/classes/class_streampeer.rst index 7fc5e91ce..b02448700 100644 --- a/classes/class_streampeer.rst +++ b/classes/class_streampeer.rst @@ -12,7 +12,7 @@ StreamPeer **Inherits:** :ref:`RefCounted` **<** :ref:`Object` -**Inherited By:** :ref:`StreamPeerBuffer`, :ref:`StreamPeerExtension`, :ref:`StreamPeerSSL`, :ref:`StreamPeerTCP` +**Inherited By:** :ref:`StreamPeerBuffer`, :ref:`StreamPeerExtension`, :ref:`StreamPeerTCP`, :ref:`StreamPeerTLS` Abstraction and base class for stream-based protocols. diff --git a/classes/class_streampeerextension.rst b/classes/class_streampeerextension.rst index 4c6eea6a7..0280777b7 100644 --- a/classes/class_streampeerextension.rst +++ b/classes/class_streampeerextension.rst @@ -17,17 +17,17 @@ StreamPeerExtension Methods ------- -+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_available_bytes` **(** **)** |virtual| |const| | -+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_data` **(** uint8_t* r_buffer, :ref:`int` r_bytes, int32_t* r_received **)** |virtual| | -+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_partial_data` **(** uint8_t* r_buffer, :ref:`int` r_bytes, int32_t* r_received **)** |virtual| | -+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_put_data` **(** const uint8_t* p_data, :ref:`int` p_bytes, int32_t* r_sent **)** |virtual| | -+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_put_partial_data` **(** const uint8_t* p_data, :ref:`int` p_bytes, int32_t* r_sent **)** |virtual| | -+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_available_bytes` **(** **)** |virtual| |const| | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`_get_data` **(** uint8_t* r_buffer, :ref:`int` r_bytes, int32_t* r_received **)** |virtual| | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`_get_partial_data` **(** uint8_t* r_buffer, :ref:`int` r_bytes, int32_t* r_received **)** |virtual| | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`_put_data` **(** const uint8_t* p_data, :ref:`int` p_bytes, int32_t* r_sent **)** |virtual| | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`_put_partial_data` **(** const uint8_t* p_data, :ref:`int` p_bytes, int32_t* r_sent **)** |virtual| | ++---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- @@ -40,25 +40,25 @@ Method Descriptions .. _class_StreamPeerExtension_method__get_data: -- :ref:`int` **_get_data** **(** uint8_t* r_buffer, :ref:`int` r_bytes, int32_t* r_received **)** |virtual| +- :ref:`Error` **_get_data** **(** uint8_t* r_buffer, :ref:`int` r_bytes, int32_t* r_received **)** |virtual| ---- .. _class_StreamPeerExtension_method__get_partial_data: -- :ref:`int` **_get_partial_data** **(** uint8_t* r_buffer, :ref:`int` r_bytes, int32_t* r_received **)** |virtual| +- :ref:`Error` **_get_partial_data** **(** uint8_t* r_buffer, :ref:`int` r_bytes, int32_t* r_received **)** |virtual| ---- .. _class_StreamPeerExtension_method__put_data: -- :ref:`int` **_put_data** **(** const uint8_t* p_data, :ref:`int` p_bytes, int32_t* r_sent **)** |virtual| +- :ref:`Error` **_put_data** **(** const uint8_t* p_data, :ref:`int` p_bytes, int32_t* r_sent **)** |virtual| ---- .. _class_StreamPeerExtension_method__put_partial_data: -- :ref:`int` **_put_partial_data** **(** const uint8_t* p_data, :ref:`int` p_bytes, int32_t* r_sent **)** |virtual| +- :ref:`Error` **_put_partial_data** **(** const uint8_t* p_data, :ref:`int` p_bytes, int32_t* r_sent **)** |virtual| .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_streampeerssl.rst b/classes/class_streampeertls.rst similarity index 81% rename from classes/class_streampeerssl.rst rename to classes/class_streampeertls.rst index 8aeee2ad2..b496ccf7b 100644 --- a/classes/class_streampeerssl.rst +++ b/classes/class_streampeertls.rst @@ -3,84 +3,84 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/StreamPeerSSL.xml. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/StreamPeerTLS.xml. -.. _class_StreamPeerSSL: +.. _class_StreamPeerTLS: -StreamPeerSSL +StreamPeerTLS ============= **Inherits:** :ref:`StreamPeer` **<** :ref:`RefCounted` **<** :ref:`Object` -SSL stream peer. +TLS stream peer. Description ----------- -SSL stream peer. This object can be used to connect to an SSL server or accept a single SSL client connection. +TLS stream peer. This object can be used to connect to an TLS server or accept a single TLS client connection. \ **Note:** When exporting to Android, make sure to enable the ``INTERNET`` permission in the Android export preset before exporting the project or using one-click deploy. Otherwise, network communication of any kind will be blocked by Android. Tutorials --------- -- :doc:`SSL certificates <../tutorials/networking/ssl_certificates>` +- :doc:`TLS certificates <../tutorials/networking/ssl_certificates>` Properties ---------- +-------------------------+----------------------------------------------------------------------------+----------+ -| :ref:`bool` | :ref:`blocking_handshake` | ``true`` | +| :ref:`bool` | :ref:`blocking_handshake` | ``true`` | +-------------------------+----------------------------------------------------------------------------+----------+ Methods ------- +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`accept_stream` **(** :ref:`StreamPeer` stream, :ref:`CryptoKey` private_key, :ref:`X509Certificate` certificate, :ref:`X509Certificate` chain=null **)** | +| :ref:`Error` | :ref:`accept_stream` **(** :ref:`StreamPeer` stream, :ref:`CryptoKey` private_key, :ref:`X509Certificate` certificate, :ref:`X509Certificate` chain=null **)** | +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Error` | :ref:`connect_to_stream` **(** :ref:`StreamPeer` stream, :ref:`bool` validate_certs=false, :ref:`String` for_hostname="", :ref:`X509Certificate` valid_certificate=null **)** | +| :ref:`Error` | :ref:`connect_to_stream` **(** :ref:`StreamPeer` stream, :ref:`bool` validate_certs=false, :ref:`String` for_hostname="", :ref:`X509Certificate` valid_certificate=null **)** | +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`disconnect_from_stream` **(** **)** | +| void | :ref:`disconnect_from_stream` **(** **)** | +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Status` | :ref:`get_status` **(** **)** |const| | +| :ref:`Status` | :ref:`get_status` **(** **)** |const| | +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`StreamPeer` | :ref:`get_stream` **(** **)** |const| | +| :ref:`StreamPeer` | :ref:`get_stream` **(** **)** |const| | +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`poll` **(** **)** | +| void | :ref:`poll` **(** **)** | +------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ -.. _enum_StreamPeerSSL_Status: +.. _enum_StreamPeerTLS_Status: -.. _class_StreamPeerSSL_constant_STATUS_DISCONNECTED: +.. _class_StreamPeerTLS_constant_STATUS_DISCONNECTED: -.. _class_StreamPeerSSL_constant_STATUS_HANDSHAKING: +.. _class_StreamPeerTLS_constant_STATUS_HANDSHAKING: -.. _class_StreamPeerSSL_constant_STATUS_CONNECTED: +.. _class_StreamPeerTLS_constant_STATUS_CONNECTED: -.. _class_StreamPeerSSL_constant_STATUS_ERROR: +.. _class_StreamPeerTLS_constant_STATUS_ERROR: -.. _class_StreamPeerSSL_constant_STATUS_ERROR_HOSTNAME_MISMATCH: +.. _class_StreamPeerTLS_constant_STATUS_ERROR_HOSTNAME_MISMATCH: enum **Status**: -- **STATUS_DISCONNECTED** = **0** --- A status representing a ``StreamPeerSSL`` that is disconnected. +- **STATUS_DISCONNECTED** = **0** --- A status representing a ``StreamPeerTLS`` that is disconnected. -- **STATUS_HANDSHAKING** = **1** --- A status representing a ``StreamPeerSSL`` during handshaking. +- **STATUS_HANDSHAKING** = **1** --- A status representing a ``StreamPeerTLS`` during handshaking. -- **STATUS_CONNECTED** = **2** --- A status representing a ``StreamPeerSSL`` that is connected to a host. +- **STATUS_CONNECTED** = **2** --- A status representing a ``StreamPeerTLS`` that is connected to a host. -- **STATUS_ERROR** = **3** --- A status representing a ``StreamPeerSSL`` in error state. +- **STATUS_ERROR** = **3** --- A status representing a ``StreamPeerTLS`` in error state. -- **STATUS_ERROR_HOSTNAME_MISMATCH** = **4** --- An error status that shows a mismatch in the SSL certificate domain presented by the host and the domain requested for validation. +- **STATUS_ERROR_HOSTNAME_MISMATCH** = **4** --- An error status that shows a mismatch in the TLS certificate domain presented by the host and the domain requested for validation. Property Descriptions --------------------- -.. _class_StreamPeerSSL_property_blocking_handshake: +.. _class_StreamPeerTLS_property_blocking_handshake: - :ref:`bool` **blocking_handshake** @@ -95,7 +95,7 @@ Property Descriptions Method Descriptions ------------------- -.. _class_StreamPeerSSL_method_accept_stream: +.. _class_StreamPeerTLS_method_accept_stream: - :ref:`Error` **accept_stream** **(** :ref:`StreamPeer` stream, :ref:`CryptoKey` private_key, :ref:`X509Certificate` certificate, :ref:`X509Certificate` chain=null **)** @@ -103,17 +103,17 @@ Accepts a peer connection as a server using the given ``private_key`` and provid ---- -.. _class_StreamPeerSSL_method_connect_to_stream: +.. _class_StreamPeerTLS_method_connect_to_stream: - :ref:`Error` **connect_to_stream** **(** :ref:`StreamPeer` stream, :ref:`bool` validate_certs=false, :ref:`String` for_hostname="", :ref:`X509Certificate` valid_certificate=null **)** -Connects to a peer using an underlying :ref:`StreamPeer` ``stream``. If ``validate_certs`` is ``true``, ``StreamPeerSSL`` will validate that the certificate presented by the peer matches the ``for_hostname``. +Connects to a peer using an underlying :ref:`StreamPeer` ``stream``. If ``validate_certs`` is ``true``, ``StreamPeerTLS`` will validate that the certificate presented by the peer matches the ``for_hostname``. \ **Note:** Specifying a custom ``valid_certificate`` is not supported in Web exports due to browsers restrictions. ---- -.. _class_StreamPeerSSL_method_disconnect_from_stream: +.. _class_StreamPeerTLS_method_disconnect_from_stream: - void **disconnect_from_stream** **(** **)** @@ -121,23 +121,23 @@ Disconnects from host. ---- -.. _class_StreamPeerSSL_method_get_status: +.. _class_StreamPeerTLS_method_get_status: -- :ref:`Status` **get_status** **(** **)** |const| +- :ref:`Status` **get_status** **(** **)** |const| -Returns the status of the connection. See :ref:`Status` for values. +Returns the status of the connection. See :ref:`Status` for values. ---- -.. _class_StreamPeerSSL_method_get_stream: +.. _class_StreamPeerTLS_method_get_stream: - :ref:`StreamPeer` **get_stream** **(** **)** |const| -Returns the underlying :ref:`StreamPeer` connection, used in :ref:`accept_stream` or :ref:`connect_to_stream`. +Returns the underlying :ref:`StreamPeer` connection, used in :ref:`accept_stream` or :ref:`connect_to_stream`. ---- -.. _class_StreamPeerSSL_method_poll: +.. _class_StreamPeerTLS_method_poll: - void **poll** **(** **)** diff --git a/classes/class_stylebox.rst b/classes/class_stylebox.rst index e73c90c1f..b4509de21 100644 --- a/classes/class_stylebox.rst +++ b/classes/class_stylebox.rst @@ -66,6 +66,8 @@ Methods +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_default_margin` **(** :ref:`Side` margin, :ref:`float` offset **)** | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_default_margin_all` **(** :ref:`float` offset **)** | ++-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`test_mask` **(** :ref:`Vector2` point, :ref:`Rect2` rect **)** |const| | +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -239,6 +241,14 @@ Sets the default value of the specified :ref:`Side` to ` ---- +.. _class_StyleBox_method_set_default_margin_all: + +- void **set_default_margin_all** **(** :ref:`float` offset **)** + +Sets the default margin to ``offset`` pixels for all sides. + +---- + .. _class_StyleBox_method_test_mask: - :ref:`bool` **test_mask** **(** :ref:`Vector2` point, :ref:`Rect2` rect **)** |const| diff --git a/classes/class_styleboxflat.rst b/classes/class_styleboxflat.rst index 4a6c2a69e..1dff13281 100644 --- a/classes/class_styleboxflat.rst +++ b/classes/class_styleboxflat.rst @@ -96,31 +96,27 @@ Properties Methods ------- -+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_border_width` **(** :ref:`Side` margin **)** |const| | -+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_border_width_min` **(** **)** |const| | -+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_corner_radius` **(** :ref:`Corner` corner **)** |const| | -+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_expand_margin` **(** :ref:`Side` margin **)** |const| | -+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_border_width` **(** :ref:`Side` margin, :ref:`int` width **)** | -+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_border_width_all` **(** :ref:`int` width **)** | -+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_corner_radius` **(** :ref:`Corner` corner, :ref:`int` radius **)** | -+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_corner_radius_all` **(** :ref:`int` radius **)** | -+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_corner_radius_individual` **(** :ref:`int` radius_top_left, :ref:`int` radius_top_right, :ref:`int` radius_bottom_right, :ref:`int` radius_bottom_left **)** | -+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_expand_margin` **(** :ref:`Side` margin, :ref:`float` size **)** | -+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_expand_margin_all` **(** :ref:`float` size **)** | -+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_expand_margin_individual` **(** :ref:`float` size_left, :ref:`float` size_top, :ref:`float` size_right, :ref:`float` size_bottom **)** | -+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_border_width` **(** :ref:`Side` margin **)** |const| | ++---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_border_width_min` **(** **)** |const| | ++---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_corner_radius` **(** :ref:`Corner` corner **)** |const| | ++---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_expand_margin` **(** :ref:`Side` margin **)** |const| | ++---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_border_width` **(** :ref:`Side` margin, :ref:`int` width **)** | ++---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_border_width_all` **(** :ref:`int` width **)** | ++---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_corner_radius` **(** :ref:`Corner` corner, :ref:`int` radius **)** | ++---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_corner_radius_all` **(** :ref:`int` radius **)** | ++---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_expand_margin` **(** :ref:`Side` margin, :ref:`float` size **)** | ++---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_expand_margin_all` **(** :ref:`float` size **)** | ++---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ Property Descriptions --------------------- @@ -574,14 +570,6 @@ Sets the corner radius to ``radius`` pixels for all corners. ---- -.. _class_StyleBoxFlat_method_set_corner_radius_individual: - -- void **set_corner_radius_individual** **(** :ref:`int` radius_top_left, :ref:`int` radius_top_right, :ref:`int` radius_bottom_right, :ref:`int` radius_bottom_left **)** - -Sets the corner radius for each corner to ``radius_top_left``, ``radius_top_right``, ``radius_bottom_right``, and ``radius_bottom_left`` pixels. - ----- - .. _class_StyleBoxFlat_method_set_expand_margin: - void **set_expand_margin** **(** :ref:`Side` margin, :ref:`float` size **)** @@ -596,14 +584,6 @@ Sets the expand margin to ``size`` pixels for the specified :ref:`Side` size_left, :ref:`float` size_top, :ref:`float` size_right, :ref:`float` size_bottom **)** - -Sets the expand margin for each margin to ``size_left``, ``size_top``, ``size_right``, and ``size_bottom`` pixels. - .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_styleboxtexture.rst b/classes/class_styleboxtexture.rst index 869920225..263c517b0 100644 --- a/classes/class_styleboxtexture.rst +++ b/classes/class_styleboxtexture.rst @@ -55,19 +55,19 @@ Properties Methods ------- -+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_expand_margin_size` **(** :ref:`Side` margin **)** |const| | -+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`get_margin_size` **(** :ref:`Side` margin **)** |const| | -+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_expand_margin_all` **(** :ref:`float` size **)** | -+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_expand_margin_individual` **(** :ref:`float` size_left, :ref:`float` size_top, :ref:`float` size_right, :ref:`float` size_bottom **)** | -+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_expand_margin_size` **(** :ref:`Side` margin, :ref:`float` size **)** | -+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`set_margin_size` **(** :ref:`Side` margin, :ref:`float` size **)** | -+---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_expand_margin_size` **(** :ref:`Side` margin **)** |const| | ++---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`get_margin_size` **(** :ref:`Side` margin **)** |const| | ++---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_expand_margin_all` **(** :ref:`float` size **)** | ++---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_expand_margin_size` **(** :ref:`Side` margin, :ref:`float` size **)** | ++---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_margin_size` **(** :ref:`Side` margin, :ref:`float` size **)** | ++---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`set_margin_size_all` **(** :ref:`float` size **)** | ++---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Enumerations ------------ @@ -356,14 +356,6 @@ Sets the expand margin to ``size`` pixels for all margins. ---- -.. _class_StyleBoxTexture_method_set_expand_margin_individual: - -- void **set_expand_margin_individual** **(** :ref:`float` size_left, :ref:`float` size_top, :ref:`float` size_right, :ref:`float` size_bottom **)** - -Sets the expand margin for each margin to ``size_left``, ``size_top``, ``size_right``, and ``size_bottom`` pixels. - ----- - .. _class_StyleBoxTexture_method_set_expand_margin_size: - void **set_expand_margin_size** **(** :ref:`Side` margin, :ref:`float` size **)** @@ -378,6 +370,14 @@ Sets the expand margin to ``size`` pixels for the specified :ref:`Side`. +---- + +.. _class_StyleBoxTexture_method_set_margin_size_all: + +- void **set_margin_size_all** **(** :ref:`float` size **)** + +Sets the margin to ``size`` pixels for all sides. + .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_textedit.rst b/classes/class_textedit.rst index 6dcc1ac60..7ab42cb74 100644 --- a/classes/class_textedit.rst +++ b/classes/class_textedit.rst @@ -29,7 +29,7 @@ Properties +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`caret_blink` | ``false`` | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`caret_blink_speed` | ``0.65`` | +| :ref:`float` | :ref:`caret_blink_interval` | ``0.65`` | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`caret_mid_grapheme` | ``true`` | +-------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+ @@ -699,17 +699,17 @@ Sets if the caret should blink. ---- -.. _class_TextEdit_property_caret_blink_speed: +.. _class_TextEdit_property_caret_blink_interval: -- :ref:`float` **caret_blink_speed** +- :ref:`float` **caret_blink_interval** -+-----------+------------------------------+ -| *Default* | ``0.65`` | -+-----------+------------------------------+ -| *Setter* | set_caret_blink_speed(value) | -+-----------+------------------------------+ -| *Getter* | get_caret_blink_speed() | -+-----------+------------------------------+ ++-----------+---------------------------------+ +| *Default* | ``0.65`` | ++-----------+---------------------------------+ +| *Setter* | set_caret_blink_interval(value) | ++-----------+---------------------------------+ +| *Getter* | get_caret_blink_interval() | ++-----------+---------------------------------+ Duration (in seconds) of a caret's blinking cycle. diff --git a/classes/class_textserver.rst b/classes/class_textserver.rst index 33615cd5c..14b130ab9 100644 --- a/classes/class_textserver.rst +++ b/classes/class_textserver.rst @@ -271,11 +271,11 @@ Methods +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`shaped_get_span_meta` **(** :ref:`RID` shaped, :ref:`int` index **)** |const| | +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shaped_set_span_update_font` **(** :ref:`RID` shaped, :ref:`int` index, :ref:`Array` fonts, :ref:`int` size, :ref:`Dictionary` opentype_features={} **)** | +| void | :ref:`shaped_set_span_update_font` **(** :ref:`RID` shaped, :ref:`int` index, :ref:`RID[]` fonts, :ref:`int` size, :ref:`Dictionary` opentype_features={} **)** | +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`shaped_text_add_object` **(** :ref:`RID` shaped, :ref:`Variant` key, :ref:`Vector2` size, :ref:`InlineAlignment` inline_align=5, :ref:`int` length=1 **)** | +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`shaped_text_add_string` **(** :ref:`RID` shaped, :ref:`String` text, :ref:`Array` fonts, :ref:`int` size, :ref:`Dictionary` opentype_features={}, :ref:`String` language="", :ref:`Variant` meta=null **)** | +| :ref:`bool` | :ref:`shaped_text_add_string` **(** :ref:`RID` shaped, :ref:`String` text, :ref:`RID[]` fonts, :ref:`int` size, :ref:`Dictionary` opentype_features={}, :ref:`String` language="", :ref:`Variant` meta=null **)** | +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`shaped_text_clear` **(** :ref:`RID` rid **)** | +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -543,6 +543,8 @@ enum **AutowrapMode**: .. _class_TextServer_constant_BREAK_ADAPTIVE: +.. _class_TextServer_constant_BREAK_TRIM_EDGE_SPACES: + flags **LineBreakFlag**: - **BREAK_NONE** = **0** --- Do not break the line. @@ -553,7 +555,9 @@ flags **LineBreakFlag**: - **BREAK_GRAPHEME_BOUND** = **4** --- Break the line between any unconnected graphemes. -- **BREAK_ADAPTIVE** = **8** +- **BREAK_ADAPTIVE** = **8** --- Should be used only in conjunction with :ref:`BREAK_WORD_BOUND`, break the line between any unconnected graphemes, if it's impossible to break it between the words. + +- **BREAK_TRIM_EDGE_SPACES** = **16** --- Remove edge spaces from the broken line segments. ---- @@ -1962,7 +1966,7 @@ Returns text span metadata. .. _class_TextServer_method_shaped_set_span_update_font: -- void **shaped_set_span_update_font** **(** :ref:`RID` shaped, :ref:`int` index, :ref:`Array` fonts, :ref:`int` size, :ref:`Dictionary` opentype_features={} **)** +- void **shaped_set_span_update_font** **(** :ref:`RID` shaped, :ref:`int` index, :ref:`RID[]` fonts, :ref:`int` size, :ref:`Dictionary` opentype_features={} **)** Changes text span font, font size and OpenType features, without changing the text. @@ -1978,7 +1982,7 @@ Adds inline object to the text buffer, ``key`` must be unique. In the text, obje .. _class_TextServer_method_shaped_text_add_string: -- :ref:`bool` **shaped_text_add_string** **(** :ref:`RID` shaped, :ref:`String` text, :ref:`Array` fonts, :ref:`int` size, :ref:`Dictionary` opentype_features={}, :ref:`String` language="", :ref:`Variant` meta=null **)** +- :ref:`bool` **shaped_text_add_string** **(** :ref:`RID` shaped, :ref:`String` text, :ref:`RID[]` fonts, :ref:`int` size, :ref:`Dictionary` opentype_features={}, :ref:`String` language="", :ref:`Variant` meta=null **)** Adds text span and font to draw it to the text buffer. diff --git a/classes/class_textserverextension.rst b/classes/class_textserverextension.rst index 04662c318..52bfceb22 100644 --- a/classes/class_textserverextension.rst +++ b/classes/class_textserverextension.rst @@ -24,381 +24,381 @@ External TextServer implementations should inherit from this class. Methods ------- -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`create_font` **(** **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`create_shaped_text` **(** :ref:`Direction` direction, :ref:`Orientation` orientation **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`draw_hex_code_box` **(** :ref:`RID` canvas, :ref:`int` size, :ref:`Vector2` pos, :ref:`int` index, :ref:`Color` color **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_clear_glyphs` **(** :ref:`RID` font_rid, :ref:`Vector2i` size **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_clear_kerning_map` **(** :ref:`RID` font_rid, :ref:`int` size **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_clear_size_cache` **(** :ref:`RID` font_rid **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_clear_textures` **(** :ref:`RID` font_rid, :ref:`Vector2i` size **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_draw_glyph` **(** :ref:`RID` font_rid, :ref:`RID` canvas, :ref:`int` size, :ref:`Vector2` pos, :ref:`int` index, :ref:`Color` color **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_draw_glyph_outline` **(** :ref:`RID` font_rid, :ref:`RID` canvas, :ref:`int` size, :ref:`int` outline_size, :ref:`Vector2` pos, :ref:`int` index, :ref:`Color` color **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`FontAntialiasing` | :ref:`font_get_antialiasing` **(** :ref:`RID` font_rid **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`font_get_ascent` **(** :ref:`RID` font_rid, :ref:`int` size **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`font_get_descent` **(** :ref:`RID` font_rid, :ref:`int` size **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`font_get_embolden` **(** :ref:`RID` font_rid **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`font_get_face_count` **(** :ref:`RID` font_rid **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`font_get_face_index` **(** :ref:`RID` font_rid **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`font_get_fixed_size` **(** :ref:`RID` font_rid **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`font_get_generate_mipmaps` **(** :ref:`RID` font_rid **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`font_get_global_oversampling` **(** **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`font_get_glyph_advance` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`int` glyph **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`font_get_glyph_contours` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`int` index **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`font_get_glyph_index` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`int` char, :ref:`int` variation_selector **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedInt32Array` | :ref:`font_get_glyph_list` **(** :ref:`RID` font_rid, :ref:`Vector2i` size **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`font_get_glyph_offset` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`font_get_glyph_size` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`font_get_glyph_texture_idx` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`font_get_glyph_texture_rid` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`font_get_glyph_texture_size` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`font_get_glyph_uv_rect` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Hinting` | :ref:`font_get_hinting` **(** :ref:`RID` font_rid **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`font_get_kerning` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`Vector2i` glyph_pair **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2i[]` | :ref:`font_get_kerning_list` **(** :ref:`RID` font_rid, :ref:`int` size **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`font_get_language_support_override` **(** :ref:`RID` font_rid, :ref:`String` language **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedStringArray` | :ref:`font_get_language_support_overrides` **(** :ref:`RID` font_rid **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`font_get_msdf_pixel_range` **(** :ref:`RID` font_rid **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`font_get_msdf_size` **(** :ref:`RID` font_rid **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`font_get_name` **(** :ref:`RID` font_rid **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`font_get_opentype_feature_overrides` **(** :ref:`RID` font_rid **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`font_get_oversampling` **(** :ref:`RID` font_rid **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`font_get_scale` **(** :ref:`RID` font_rid, :ref:`int` size **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`font_get_script_support_override` **(** :ref:`RID` font_rid, :ref:`String` script **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedStringArray` | :ref:`font_get_script_support_overrides` **(** :ref:`RID` font_rid **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2i[]` | :ref:`font_get_size_cache_list` **(** :ref:`RID` font_rid **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`FontStyle` | :ref:`font_get_style` **(** :ref:`RID` font_rid **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`font_get_style_name` **(** :ref:`RID` font_rid **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`SubpixelPositioning` | :ref:`font_get_subpixel_positioning` **(** :ref:`RID` font_rid **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`font_get_supported_chars` **(** :ref:`RID` font_rid **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`font_get_texture_count` **(** :ref:`RID` font_rid, :ref:`Vector2i` size **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Image` | :ref:`font_get_texture_image` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` texture_index **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedInt32Array` | :ref:`font_get_texture_offsets` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` texture_index **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Transform2D` | :ref:`font_get_transform` **(** :ref:`RID` font_rid **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`font_get_underline_position` **(** :ref:`RID` font_rid, :ref:`int` size **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`font_get_underline_thickness` **(** :ref:`RID` font_rid, :ref:`int` size **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`font_get_variation_coordinates` **(** :ref:`RID` font_rid **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`font_has_char` **(** :ref:`RID` font_rid, :ref:`int` char **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`font_is_force_autohinter` **(** :ref:`RID` font_rid **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`font_is_language_supported` **(** :ref:`RID` font_rid, :ref:`String` language **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`font_is_multichannel_signed_distance_field` **(** :ref:`RID` font_rid **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`font_is_script_supported` **(** :ref:`RID` font_rid, :ref:`String` script **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_remove_glyph` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_remove_kerning` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`Vector2i` glyph_pair **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_remove_language_support_override` **(** :ref:`RID` font_rid, :ref:`String` language **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_remove_script_support_override` **(** :ref:`RID` font_rid, :ref:`String` script **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_remove_size_cache` **(** :ref:`RID` font_rid, :ref:`Vector2i` size **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_remove_texture` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` texture_index **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_render_glyph` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` index **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_render_range` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` start, :ref:`int` end **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_set_antialiasing` **(** :ref:`RID` font_rid, :ref:`FontAntialiasing` antialiasing **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_set_ascent` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`float` ascent **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_set_data` **(** :ref:`RID` font_rid, :ref:`PackedByteArray` data **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_set_data_ptr` **(** :ref:`RID` font_rid, const uint8_t* data_ptr, :ref:`int` data_size **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_set_descent` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`float` descent **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_set_embolden` **(** :ref:`RID` font_rid, :ref:`float` strength **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_set_face_index` **(** :ref:`RID` font_rid, :ref:`int` face_index **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_set_fixed_size` **(** :ref:`RID` font_rid, :ref:`int` fixed_size **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_set_force_autohinter` **(** :ref:`RID` font_rid, :ref:`bool` force_autohinter **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_set_generate_mipmaps` **(** :ref:`RID` font_rid, :ref:`bool` generate_mipmaps **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_set_global_oversampling` **(** :ref:`float` oversampling **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_set_glyph_advance` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`int` glyph, :ref:`Vector2` advance **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_set_glyph_offset` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph, :ref:`Vector2` offset **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_set_glyph_size` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph, :ref:`Vector2` gl_size **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_set_glyph_texture_idx` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph, :ref:`int` texture_idx **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_set_glyph_uv_rect` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph, :ref:`Rect2` uv_rect **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_set_hinting` **(** :ref:`RID` font_rid, :ref:`Hinting` hinting **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_set_kerning` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`Vector2i` glyph_pair, :ref:`Vector2` kerning **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_set_language_support_override` **(** :ref:`RID` font_rid, :ref:`String` language, :ref:`bool` supported **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_set_msdf_pixel_range` **(** :ref:`RID` font_rid, :ref:`int` msdf_pixel_range **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_set_msdf_size` **(** :ref:`RID` font_rid, :ref:`int` msdf_size **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_set_multichannel_signed_distance_field` **(** :ref:`RID` font_rid, :ref:`bool` msdf **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_set_name` **(** :ref:`RID` font_rid, :ref:`String` name **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_set_opentype_feature_overrides` **(** :ref:`RID` font_rid, :ref:`Dictionary` overrides **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_set_oversampling` **(** :ref:`RID` font_rid, :ref:`float` oversampling **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_set_scale` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`float` scale **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_set_script_support_override` **(** :ref:`RID` font_rid, :ref:`String` script, :ref:`bool` supported **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_set_style` **(** :ref:`RID` font_rid, :ref:`FontStyle` style **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_set_style_name` **(** :ref:`RID` font_rid, :ref:`String` name_style **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_set_subpixel_positioning` **(** :ref:`RID` font_rid, :ref:`SubpixelPositioning` subpixel_positioning **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_set_texture_image` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` texture_index, :ref:`Image` image **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_set_texture_offsets` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` texture_index, :ref:`PackedInt32Array` offset **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_set_transform` **(** :ref:`RID` font_rid, :ref:`Transform2D` transform **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_set_underline_position` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`float` underline_position **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_set_underline_thickness` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`float` underline_thickness **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`font_set_variation_coordinates` **(** :ref:`RID` font_rid, :ref:`Dictionary` variation_coordinates **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`font_supported_feature_list` **(** :ref:`RID` font_rid **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Dictionary` | :ref:`font_supported_variation_list` **(** :ref:`RID` font_rid **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`format_number` **(** :ref:`String` string, :ref:`String` language **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`free_rid` **(** :ref:`RID` rid **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`get_features` **(** **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`get_hex_code_box_size` **(** :ref:`int` size, :ref:`int` index **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_name` **(** **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_support_data_filename` **(** **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`get_support_data_info` **(** **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has` **(** :ref:`RID` rid **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`has_feature` **(** :ref:`Feature` feature **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`is_confusable` **(** :ref:`String` string, :ref:`PackedStringArray` dict **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_locale_right_to_left` **(** :ref:`String` locale **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`is_valid_identifier` **(** :ref:`String` string **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`load_support_data` **(** :ref:`String` filename **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`name_to_tag` **(** :ref:`String` name **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`parse_number` **(** :ref:`String` string, :ref:`String` language **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2i[]` | :ref:`parse_structured_text` **(** :ref:`StructuredTextParser` parser_type, :ref:`Array` args, :ref:`String` text **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`percent_sign` **(** :ref:`String` language **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`save_support_data` **(** :ref:`String` filename **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`shaped_get_span_count` **(** :ref:`RID` shaped **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Variant` | :ref:`shaped_get_span_meta` **(** :ref:`RID` shaped, :ref:`int` index **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shaped_set_span_update_font` **(** :ref:`RID` shaped, :ref:`int` index, :ref:`Array` fonts, :ref:`int` size, :ref:`Dictionary` opentype_features **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`shaped_text_add_object` **(** :ref:`RID` shaped, :ref:`Variant` key, :ref:`Vector2` size, :ref:`InlineAlignment` inline_align, :ref:`int` length **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`shaped_text_add_string` **(** :ref:`RID` shaped, :ref:`String` text, :ref:`Array` fonts, :ref:`int` size, :ref:`Dictionary` opentype_features, :ref:`String` language, :ref:`Variant` meta **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shaped_text_clear` **(** :ref:`RID` shaped **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shaped_text_draw` **(** :ref:`RID` shaped, :ref:`RID` canvas, :ref:`Vector2` pos, :ref:`float` clip_l, :ref:`float` clip_r, :ref:`Color` color **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shaped_text_draw_outline` **(** :ref:`RID` shaped, :ref:`RID` canvas, :ref:`Vector2` pos, :ref:`float` clip_l, :ref:`float` clip_r, :ref:`int` outline_size, :ref:`Color` color **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`shaped_text_fit_to_width` **(** :ref:`RID` shaped, :ref:`float` width, :ref:`JustificationFlag` jst_flags **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`shaped_text_get_ascent` **(** :ref:`RID` shaped **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shaped_text_get_carets` **(** :ref:`RID` shaped, :ref:`int` position, CaretInfo* caret **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`shaped_text_get_custom_punctuation` **(** :ref:`RID` shaped **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`shaped_text_get_descent` **(** :ref:`RID` shaped **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Direction` | :ref:`shaped_text_get_direction` **(** :ref:`RID` shaped **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`shaped_text_get_dominant_direction_in_range` **(** :ref:`RID` shaped, :ref:`int` start, :ref:`int` end **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`shaped_text_get_ellipsis_glyph_count` **(** :ref:`RID` shaped **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| const Glyph* | :ref:`shaped_text_get_ellipsis_glyphs` **(** :ref:`RID` shaped **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`shaped_text_get_ellipsis_pos` **(** :ref:`RID` shaped **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`shaped_text_get_glyph_count` **(** :ref:`RID` shaped **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| const Glyph* | :ref:`shaped_text_get_glyphs` **(** :ref:`RID` shaped **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`shaped_text_get_grapheme_bounds` **(** :ref:`RID` shaped, :ref:`int` pos **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Direction` | :ref:`shaped_text_get_inferred_direction` **(** :ref:`RID` shaped **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedInt32Array` | :ref:`shaped_text_get_line_breaks` **(** :ref:`RID` shaped, :ref:`float` width, :ref:`int` start, :ref:`LineBreakFlag` break_flags **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedInt32Array` | :ref:`shaped_text_get_line_breaks_adv` **(** :ref:`RID` shaped, :ref:`PackedFloat32Array` width, :ref:`int` start, :ref:`bool` once, :ref:`LineBreakFlag` break_flags **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Rect2` | :ref:`shaped_text_get_object_rect` **(** :ref:`RID` shaped, :ref:`Variant` key **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Array` | :ref:`shaped_text_get_objects` **(** :ref:`RID` shaped **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Orientation` | :ref:`shaped_text_get_orientation` **(** :ref:`RID` shaped **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`shaped_text_get_parent` **(** :ref:`RID` shaped **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`shaped_text_get_preserve_control` **(** :ref:`RID` shaped **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`shaped_text_get_preserve_invalid` **(** :ref:`RID` shaped **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2i` | :ref:`shaped_text_get_range` **(** :ref:`RID` shaped **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedVector2Array` | :ref:`shaped_text_get_selection` **(** :ref:`RID` shaped, :ref:`int` start, :ref:`int` end **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`shaped_text_get_size` **(** :ref:`RID` shaped **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`shaped_text_get_spacing` **(** :ref:`RID` shaped, :ref:`SpacingType` spacing **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`shaped_text_get_trim_pos` **(** :ref:`RID` shaped **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`shaped_text_get_underline_position` **(** :ref:`RID` shaped **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`shaped_text_get_underline_thickness` **(** :ref:`RID` shaped **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`shaped_text_get_width` **(** :ref:`RID` shaped **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedInt32Array` | :ref:`shaped_text_get_word_breaks` **(** :ref:`RID` shaped, :ref:`GraphemeFlag` grapheme_flags **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`shaped_text_hit_test_grapheme` **(** :ref:`RID` shaped, :ref:`float` coord **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`shaped_text_hit_test_position` **(** :ref:`RID` shaped, :ref:`float` coord **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`shaped_text_is_ready` **(** :ref:`RID` shaped **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`shaped_text_next_grapheme_pos` **(** :ref:`RID` shaped, :ref:`int` pos **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shaped_text_overrun_trim_to_width` **(** :ref:`RID` shaped, :ref:`float` width, :ref:`TextOverrunFlag` trim_flags **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`shaped_text_prev_grapheme_pos` **(** :ref:`RID` shaped, :ref:`int` pos **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`shaped_text_resize_object` **(** :ref:`RID` shaped, :ref:`Variant` key, :ref:`Vector2` size, :ref:`InlineAlignment` inline_align **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shaped_text_set_bidi_override` **(** :ref:`RID` shaped, :ref:`Array` override **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shaped_text_set_custom_punctuation` **(** :ref:`RID` shaped, :ref:`String` punct **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shaped_text_set_direction` **(** :ref:`RID` shaped, :ref:`Direction` direction **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shaped_text_set_orientation` **(** :ref:`RID` shaped, :ref:`Orientation` orientation **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shaped_text_set_preserve_control` **(** :ref:`RID` shaped, :ref:`bool` enabled **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shaped_text_set_preserve_invalid` **(** :ref:`RID` shaped, :ref:`bool` enabled **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`shaped_text_set_spacing` **(** :ref:`RID` shaped, :ref:`SpacingType` spacing, :ref:`int` value **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`shaped_text_shape` **(** :ref:`RID` shaped **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| const Glyph* | :ref:`shaped_text_sort_logical` **(** :ref:`RID` shaped **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`RID` | :ref:`shaped_text_substr` **(** :ref:`RID` shaped, :ref:`int` start, :ref:`int` length **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`float` | :ref:`shaped_text_tab_align` **(** :ref:`RID` shaped, :ref:`PackedFloat32Array` tab_stops **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`shaped_text_update_breaks` **(** :ref:`RID` shaped **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`shaped_text_update_justification_ops` **(** :ref:`RID` shaped **)** |virtual| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`spoof_check` **(** :ref:`String` string **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`PackedInt32Array` | :ref:`string_get_word_breaks` **(** :ref:`String` string, :ref:`String` language **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`string_to_lower` **(** :ref:`String` string, :ref:`String` language **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`string_to_upper` **(** :ref:`String` string, :ref:`String` language **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`strip_diacritics` **(** :ref:`String` string **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`tag_to_name` **(** :ref:`int` tag **)** |virtual| |const| | -+-----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`create_font` **(** **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`create_shaped_text` **(** :ref:`Direction` direction, :ref:`Orientation` orientation **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`draw_hex_code_box` **(** :ref:`RID` canvas, :ref:`int` size, :ref:`Vector2` pos, :ref:`int` index, :ref:`Color` color **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_clear_glyphs` **(** :ref:`RID` font_rid, :ref:`Vector2i` size **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_clear_kerning_map` **(** :ref:`RID` font_rid, :ref:`int` size **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_clear_size_cache` **(** :ref:`RID` font_rid **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_clear_textures` **(** :ref:`RID` font_rid, :ref:`Vector2i` size **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_draw_glyph` **(** :ref:`RID` font_rid, :ref:`RID` canvas, :ref:`int` size, :ref:`Vector2` pos, :ref:`int` index, :ref:`Color` color **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_draw_glyph_outline` **(** :ref:`RID` font_rid, :ref:`RID` canvas, :ref:`int` size, :ref:`int` outline_size, :ref:`Vector2` pos, :ref:`int` index, :ref:`Color` color **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`FontAntialiasing` | :ref:`font_get_antialiasing` **(** :ref:`RID` font_rid **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`font_get_ascent` **(** :ref:`RID` font_rid, :ref:`int` size **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`font_get_descent` **(** :ref:`RID` font_rid, :ref:`int` size **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`font_get_embolden` **(** :ref:`RID` font_rid **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`font_get_face_count` **(** :ref:`RID` font_rid **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`font_get_face_index` **(** :ref:`RID` font_rid **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`font_get_fixed_size` **(** :ref:`RID` font_rid **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`font_get_generate_mipmaps` **(** :ref:`RID` font_rid **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`font_get_global_oversampling` **(** **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`font_get_glyph_advance` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`int` glyph **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`font_get_glyph_contours` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`int` index **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`font_get_glyph_index` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`int` char, :ref:`int` variation_selector **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedInt32Array` | :ref:`font_get_glyph_list` **(** :ref:`RID` font_rid, :ref:`Vector2i` size **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`font_get_glyph_offset` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`font_get_glyph_size` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`font_get_glyph_texture_idx` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`font_get_glyph_texture_rid` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`font_get_glyph_texture_size` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`font_get_glyph_uv_rect` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Hinting` | :ref:`font_get_hinting` **(** :ref:`RID` font_rid **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`font_get_kerning` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`Vector2i` glyph_pair **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2i[]` | :ref:`font_get_kerning_list` **(** :ref:`RID` font_rid, :ref:`int` size **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`font_get_language_support_override` **(** :ref:`RID` font_rid, :ref:`String` language **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`font_get_language_support_overrides` **(** :ref:`RID` font_rid **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`font_get_msdf_pixel_range` **(** :ref:`RID` font_rid **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`font_get_msdf_size` **(** :ref:`RID` font_rid **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`font_get_name` **(** :ref:`RID` font_rid **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`font_get_opentype_feature_overrides` **(** :ref:`RID` font_rid **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`font_get_oversampling` **(** :ref:`RID` font_rid **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`font_get_scale` **(** :ref:`RID` font_rid, :ref:`int` size **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`font_get_script_support_override` **(** :ref:`RID` font_rid, :ref:`String` script **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedStringArray` | :ref:`font_get_script_support_overrides` **(** :ref:`RID` font_rid **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2i[]` | :ref:`font_get_size_cache_list` **(** :ref:`RID` font_rid **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`FontStyle` | :ref:`font_get_style` **(** :ref:`RID` font_rid **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`font_get_style_name` **(** :ref:`RID` font_rid **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`SubpixelPositioning` | :ref:`font_get_subpixel_positioning` **(** :ref:`RID` font_rid **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`font_get_supported_chars` **(** :ref:`RID` font_rid **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`font_get_texture_count` **(** :ref:`RID` font_rid, :ref:`Vector2i` size **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Image` | :ref:`font_get_texture_image` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` texture_index **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedInt32Array` | :ref:`font_get_texture_offsets` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` texture_index **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Transform2D` | :ref:`font_get_transform` **(** :ref:`RID` font_rid **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`font_get_underline_position` **(** :ref:`RID` font_rid, :ref:`int` size **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`font_get_underline_thickness` **(** :ref:`RID` font_rid, :ref:`int` size **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`font_get_variation_coordinates` **(** :ref:`RID` font_rid **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`font_has_char` **(** :ref:`RID` font_rid, :ref:`int` char **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`font_is_force_autohinter` **(** :ref:`RID` font_rid **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`font_is_language_supported` **(** :ref:`RID` font_rid, :ref:`String` language **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`font_is_multichannel_signed_distance_field` **(** :ref:`RID` font_rid **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`font_is_script_supported` **(** :ref:`RID` font_rid, :ref:`String` script **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_remove_glyph` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_remove_kerning` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`Vector2i` glyph_pair **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_remove_language_support_override` **(** :ref:`RID` font_rid, :ref:`String` language **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_remove_script_support_override` **(** :ref:`RID` font_rid, :ref:`String` script **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_remove_size_cache` **(** :ref:`RID` font_rid, :ref:`Vector2i` size **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_remove_texture` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` texture_index **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_render_glyph` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` index **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_render_range` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` start, :ref:`int` end **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_set_antialiasing` **(** :ref:`RID` font_rid, :ref:`FontAntialiasing` antialiasing **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_set_ascent` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`float` ascent **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_set_data` **(** :ref:`RID` font_rid, :ref:`PackedByteArray` data **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_set_data_ptr` **(** :ref:`RID` font_rid, const uint8_t* data_ptr, :ref:`int` data_size **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_set_descent` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`float` descent **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_set_embolden` **(** :ref:`RID` font_rid, :ref:`float` strength **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_set_face_index` **(** :ref:`RID` font_rid, :ref:`int` face_index **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_set_fixed_size` **(** :ref:`RID` font_rid, :ref:`int` fixed_size **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_set_force_autohinter` **(** :ref:`RID` font_rid, :ref:`bool` force_autohinter **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_set_generate_mipmaps` **(** :ref:`RID` font_rid, :ref:`bool` generate_mipmaps **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_set_global_oversampling` **(** :ref:`float` oversampling **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_set_glyph_advance` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`int` glyph, :ref:`Vector2` advance **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_set_glyph_offset` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph, :ref:`Vector2` offset **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_set_glyph_size` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph, :ref:`Vector2` gl_size **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_set_glyph_texture_idx` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph, :ref:`int` texture_idx **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_set_glyph_uv_rect` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` glyph, :ref:`Rect2` uv_rect **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_set_hinting` **(** :ref:`RID` font_rid, :ref:`Hinting` hinting **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_set_kerning` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`Vector2i` glyph_pair, :ref:`Vector2` kerning **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_set_language_support_override` **(** :ref:`RID` font_rid, :ref:`String` language, :ref:`bool` supported **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_set_msdf_pixel_range` **(** :ref:`RID` font_rid, :ref:`int` msdf_pixel_range **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_set_msdf_size` **(** :ref:`RID` font_rid, :ref:`int` msdf_size **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_set_multichannel_signed_distance_field` **(** :ref:`RID` font_rid, :ref:`bool` msdf **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_set_name` **(** :ref:`RID` font_rid, :ref:`String` name **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_set_opentype_feature_overrides` **(** :ref:`RID` font_rid, :ref:`Dictionary` overrides **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_set_oversampling` **(** :ref:`RID` font_rid, :ref:`float` oversampling **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_set_scale` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`float` scale **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_set_script_support_override` **(** :ref:`RID` font_rid, :ref:`String` script, :ref:`bool` supported **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_set_style` **(** :ref:`RID` font_rid, :ref:`FontStyle` style **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_set_style_name` **(** :ref:`RID` font_rid, :ref:`String` name_style **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_set_subpixel_positioning` **(** :ref:`RID` font_rid, :ref:`SubpixelPositioning` subpixel_positioning **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_set_texture_image` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` texture_index, :ref:`Image` image **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_set_texture_offsets` **(** :ref:`RID` font_rid, :ref:`Vector2i` size, :ref:`int` texture_index, :ref:`PackedInt32Array` offset **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_set_transform` **(** :ref:`RID` font_rid, :ref:`Transform2D` transform **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_set_underline_position` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`float` underline_position **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_set_underline_thickness` **(** :ref:`RID` font_rid, :ref:`int` size, :ref:`float` underline_thickness **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`font_set_variation_coordinates` **(** :ref:`RID` font_rid, :ref:`Dictionary` variation_coordinates **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`font_supported_feature_list` **(** :ref:`RID` font_rid **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Dictionary` | :ref:`font_supported_variation_list` **(** :ref:`RID` font_rid **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`format_number` **(** :ref:`String` string, :ref:`String` language **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`free_rid` **(** :ref:`RID` rid **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`get_features` **(** **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`get_hex_code_box_size` **(** :ref:`int` size, :ref:`int` index **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_name` **(** **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_support_data_filename` **(** **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`get_support_data_info` **(** **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has` **(** :ref:`RID` rid **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`has_feature` **(** :ref:`Feature` feature **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`is_confusable` **(** :ref:`String` string, :ref:`PackedStringArray` dict **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_locale_right_to_left` **(** :ref:`String` locale **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_valid_identifier` **(** :ref:`String` string **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`load_support_data` **(** :ref:`String` filename **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`name_to_tag` **(** :ref:`String` name **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`parse_number` **(** :ref:`String` string, :ref:`String` language **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2i[]` | :ref:`parse_structured_text` **(** :ref:`StructuredTextParser` parser_type, :ref:`Array` args, :ref:`String` text **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`percent_sign` **(** :ref:`String` language **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`save_support_data` **(** :ref:`String` filename **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`shaped_get_span_count` **(** :ref:`RID` shaped **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Variant` | :ref:`shaped_get_span_meta` **(** :ref:`RID` shaped, :ref:`int` index **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shaped_set_span_update_font` **(** :ref:`RID` shaped, :ref:`int` index, :ref:`RID[]` fonts, :ref:`int` size, :ref:`Dictionary` opentype_features **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`shaped_text_add_object` **(** :ref:`RID` shaped, :ref:`Variant` key, :ref:`Vector2` size, :ref:`InlineAlignment` inline_align, :ref:`int` length **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`shaped_text_add_string` **(** :ref:`RID` shaped, :ref:`String` text, :ref:`RID[]` fonts, :ref:`int` size, :ref:`Dictionary` opentype_features, :ref:`String` language, :ref:`Variant` meta **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shaped_text_clear` **(** :ref:`RID` shaped **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shaped_text_draw` **(** :ref:`RID` shaped, :ref:`RID` canvas, :ref:`Vector2` pos, :ref:`float` clip_l, :ref:`float` clip_r, :ref:`Color` color **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shaped_text_draw_outline` **(** :ref:`RID` shaped, :ref:`RID` canvas, :ref:`Vector2` pos, :ref:`float` clip_l, :ref:`float` clip_r, :ref:`int` outline_size, :ref:`Color` color **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`shaped_text_fit_to_width` **(** :ref:`RID` shaped, :ref:`float` width, :ref:`JustificationFlag` jst_flags **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`shaped_text_get_ascent` **(** :ref:`RID` shaped **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shaped_text_get_carets` **(** :ref:`RID` shaped, :ref:`int` position, CaretInfo* caret **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`shaped_text_get_custom_punctuation` **(** :ref:`RID` shaped **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`shaped_text_get_descent` **(** :ref:`RID` shaped **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Direction` | :ref:`shaped_text_get_direction` **(** :ref:`RID` shaped **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`shaped_text_get_dominant_direction_in_range` **(** :ref:`RID` shaped, :ref:`int` start, :ref:`int` end **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`shaped_text_get_ellipsis_glyph_count` **(** :ref:`RID` shaped **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| const Glyph* | :ref:`shaped_text_get_ellipsis_glyphs` **(** :ref:`RID` shaped **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`shaped_text_get_ellipsis_pos` **(** :ref:`RID` shaped **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`shaped_text_get_glyph_count` **(** :ref:`RID` shaped **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| const Glyph* | :ref:`shaped_text_get_glyphs` **(** :ref:`RID` shaped **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`shaped_text_get_grapheme_bounds` **(** :ref:`RID` shaped, :ref:`int` pos **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Direction` | :ref:`shaped_text_get_inferred_direction` **(** :ref:`RID` shaped **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedInt32Array` | :ref:`shaped_text_get_line_breaks` **(** :ref:`RID` shaped, :ref:`float` width, :ref:`int` start, :ref:`LineBreakFlag` break_flags **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedInt32Array` | :ref:`shaped_text_get_line_breaks_adv` **(** :ref:`RID` shaped, :ref:`PackedFloat32Array` width, :ref:`int` start, :ref:`bool` once, :ref:`LineBreakFlag` break_flags **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Rect2` | :ref:`shaped_text_get_object_rect` **(** :ref:`RID` shaped, :ref:`Variant` key **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Array` | :ref:`shaped_text_get_objects` **(** :ref:`RID` shaped **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Orientation` | :ref:`shaped_text_get_orientation` **(** :ref:`RID` shaped **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`shaped_text_get_parent` **(** :ref:`RID` shaped **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`shaped_text_get_preserve_control` **(** :ref:`RID` shaped **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`shaped_text_get_preserve_invalid` **(** :ref:`RID` shaped **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2i` | :ref:`shaped_text_get_range` **(** :ref:`RID` shaped **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedVector2Array` | :ref:`shaped_text_get_selection` **(** :ref:`RID` shaped, :ref:`int` start, :ref:`int` end **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2` | :ref:`shaped_text_get_size` **(** :ref:`RID` shaped **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`shaped_text_get_spacing` **(** :ref:`RID` shaped, :ref:`SpacingType` spacing **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`shaped_text_get_trim_pos` **(** :ref:`RID` shaped **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`shaped_text_get_underline_position` **(** :ref:`RID` shaped **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`shaped_text_get_underline_thickness` **(** :ref:`RID` shaped **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`shaped_text_get_width` **(** :ref:`RID` shaped **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedInt32Array` | :ref:`shaped_text_get_word_breaks` **(** :ref:`RID` shaped, :ref:`GraphemeFlag` grapheme_flags **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`shaped_text_hit_test_grapheme` **(** :ref:`RID` shaped, :ref:`float` coord **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`shaped_text_hit_test_position` **(** :ref:`RID` shaped, :ref:`float` coord **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`shaped_text_is_ready` **(** :ref:`RID` shaped **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`shaped_text_next_grapheme_pos` **(** :ref:`RID` shaped, :ref:`int` pos **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shaped_text_overrun_trim_to_width` **(** :ref:`RID` shaped, :ref:`float` width, :ref:`TextOverrunFlag` trim_flags **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`shaped_text_prev_grapheme_pos` **(** :ref:`RID` shaped, :ref:`int` pos **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`shaped_text_resize_object` **(** :ref:`RID` shaped, :ref:`Variant` key, :ref:`Vector2` size, :ref:`InlineAlignment` inline_align **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shaped_text_set_bidi_override` **(** :ref:`RID` shaped, :ref:`Array` override **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shaped_text_set_custom_punctuation` **(** :ref:`RID` shaped, :ref:`String` punct **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shaped_text_set_direction` **(** :ref:`RID` shaped, :ref:`Direction` direction **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shaped_text_set_orientation` **(** :ref:`RID` shaped, :ref:`Orientation` orientation **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shaped_text_set_preserve_control` **(** :ref:`RID` shaped, :ref:`bool` enabled **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shaped_text_set_preserve_invalid` **(** :ref:`RID` shaped, :ref:`bool` enabled **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`shaped_text_set_spacing` **(** :ref:`RID` shaped, :ref:`SpacingType` spacing, :ref:`int` value **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`shaped_text_shape` **(** :ref:`RID` shaped **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| const Glyph* | :ref:`shaped_text_sort_logical` **(** :ref:`RID` shaped **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`RID` | :ref:`shaped_text_substr` **(** :ref:`RID` shaped, :ref:`int` start, :ref:`int` length **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`float` | :ref:`shaped_text_tab_align` **(** :ref:`RID` shaped, :ref:`PackedFloat32Array` tab_stops **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`shaped_text_update_breaks` **(** :ref:`RID` shaped **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`shaped_text_update_justification_ops` **(** :ref:`RID` shaped **)** |virtual| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`spoof_check` **(** :ref:`String` string **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`PackedInt32Array` | :ref:`string_get_word_breaks` **(** :ref:`String` string, :ref:`String` language **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`string_to_lower` **(** :ref:`String` string, :ref:`String` language **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`string_to_upper` **(** :ref:`String` string, :ref:`String` language **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`strip_diacritics` **(** :ref:`String` string **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`tag_to_name` **(** :ref:`int` tag **)** |virtual| |const| | ++-----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- @@ -1413,7 +1413,7 @@ Returns text span metadata. .. _class_TextServerExtension_method_shaped_set_span_update_font: -- void **shaped_set_span_update_font** **(** :ref:`RID` shaped, :ref:`int` index, :ref:`Array` fonts, :ref:`int` size, :ref:`Dictionary` opentype_features **)** |virtual| +- void **shaped_set_span_update_font** **(** :ref:`RID` shaped, :ref:`int` index, :ref:`RID[]` fonts, :ref:`int` size, :ref:`Dictionary` opentype_features **)** |virtual| Changes text span font, font size and OpenType features, without changing the text. @@ -1429,7 +1429,7 @@ Adds inline object to the text buffer, ``key`` must be unique. In the text, obje .. _class_TextServerExtension_method_shaped_text_add_string: -- :ref:`bool` **shaped_text_add_string** **(** :ref:`RID` shaped, :ref:`String` text, :ref:`Array` fonts, :ref:`int` size, :ref:`Dictionary` opentype_features, :ref:`String` language, :ref:`Variant` meta **)** |virtual| +- :ref:`bool` **shaped_text_add_string** **(** :ref:`RID` shaped, :ref:`String` text, :ref:`RID[]` fonts, :ref:`int` size, :ref:`Dictionary` opentype_features, :ref:`String` language, :ref:`Variant` meta **)** |virtual| Adds text span and font to draw it to the text buffer. diff --git a/classes/class_tilemap.rst b/classes/class_tilemap.rst index fc74d7d29..6d12a022d 100644 --- a/classes/class_tilemap.rst +++ b/classes/class_tilemap.rst @@ -105,9 +105,11 @@ Methods +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_layer_y_sort_enabled` **(** :ref:`int` layer **)** |const| | +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Vector2i` | :ref:`local_to_map` **(** :ref:`Vector2` local_position **)** |const| | ++---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2i` | :ref:`map_pattern` **(** :ref:`Vector2i` position_in_tilemap, :ref:`Vector2i` coords_in_pattern, :ref:`TileMapPattern` pattern **)** | +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2` | :ref:`map_to_world` **(** :ref:`Vector2i` map_position **)** |const| | +| :ref:`Vector2` | :ref:`map_to_local` **(** :ref:`Vector2i` map_position **)** |const| | +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`move_layer` **(** :ref:`int` layer, :ref:`int` to_position **)** | +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -133,8 +135,6 @@ Methods +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_pattern` **(** :ref:`int` layer, :ref:`Vector2i` position, :ref:`TileMapPattern` pattern **)** | +---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Vector2i` | :ref:`world_to_map` **(** :ref:`Vector2` world_position **)** |const| | -+---------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Signals ------- @@ -460,6 +460,14 @@ Returns if a layer Y-sorts its tiles. ---- +.. _class_TileMap_method_local_to_map: + +- :ref:`Vector2i` **local_to_map** **(** :ref:`Vector2` local_position **)** |const| + +Returns the map coordinates of the cell containing the given ``local_position``. If ``local_position`` is in global coordinates, consider using :ref:`Node2D.to_local` before passing it to this method. See also :ref:`map_to_local`. + +---- + .. _class_TileMap_method_map_pattern: - :ref:`Vector2i` **map_pattern** **(** :ref:`Vector2i` position_in_tilemap, :ref:`Vector2i` coords_in_pattern, :ref:`TileMapPattern` pattern **)** @@ -468,13 +476,13 @@ Returns for the given coordinate ``coords_in_pattern`` in a :ref:`TileMapPattern ---- -.. _class_TileMap_method_map_to_world: +.. _class_TileMap_method_map_to_local: -- :ref:`Vector2` **map_to_world** **(** :ref:`Vector2i` map_position **)** |const| +- :ref:`Vector2` **map_to_local** **(** :ref:`Vector2i` map_position **)** |const| -Returns a local position of the center of the cell at the given tilemap (grid-based) coordinates. +Returns the centered position of a cell in the TileMap's local coordinate space. To convert the returned value into global coordinates, use :ref:`Node2D.to_global`. See also :ref:`local_to_map`. -\ **Note:** This doesn't correspond to the visual position of the tile, i.e. it ignores the :ref:`TileData.texture_offset` property of individual tiles. +\ **Note:** This may not correspond to the visual position of the tile, i.e. it ignores the :ref:`TileData.texture_offset` property of individual tiles. ---- @@ -602,14 +610,6 @@ If ``layer`` is negative, the layers are accessed from the last one. Paste the given :ref:`TileMapPattern` at the given ``position`` and ``layer`` in the tile map. ----- - -.. _class_TileMap_method_world_to_map: - -- :ref:`Vector2i` **world_to_map** **(** :ref:`Vector2` world_position **)** |const| - -Returns the tilemap (grid-based) coordinates corresponding to the given local position. - .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_tree.rst b/classes/class_tree.rst index 34686221b..c4fc61edc 100644 --- a/classes/class_tree.rst +++ b/classes/class_tree.rst @@ -226,10 +226,6 @@ Theme Properties +-----------------------------------+------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`Texture2D` | :ref:`updown` | | +-----------------------------------+------------------------------------------------------------------------------------------+-----------------------------------+ -| :ref:`StyleBox` | :ref:`bg` | | -+-----------------------------------+------------------------------------------------------------------------------------------+-----------------------------------+ -| :ref:`StyleBox` | :ref:`bg_focus` | | -+-----------------------------------+------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`StyleBox` | :ref:`button_pressed` | | +-----------------------------------+------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`StyleBox` | :ref:`cursor` | | @@ -242,6 +238,10 @@ Theme Properties +-----------------------------------+------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`StyleBox` | :ref:`custom_button_pressed` | | +-----------------------------------+------------------------------------------------------------------------------------------+-----------------------------------+ +| :ref:`StyleBox` | :ref:`focus` | | ++-----------------------------------+------------------------------------------------------------------------------------------+-----------------------------------+ +| :ref:`StyleBox` | :ref:`panel` | | ++-----------------------------------+------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`StyleBox` | :ref:`selected` | | +-----------------------------------+------------------------------------------------------------------------------------------+-----------------------------------+ | :ref:`StyleBox` | :ref:`selected_focus` | | @@ -1263,22 +1263,6 @@ The updown arrow icon to display for the :ref:`TreeItem.CELL_MODE_RANGE` **bg** - -Default :ref:`StyleBox` for the ``Tree``, i.e. used when the control is not being focused. - ----- - -.. _class_Tree_theme_style_bg_focus: - -- :ref:`StyleBox` **bg_focus** - -:ref:`StyleBox` used when the ``Tree`` is being focused. - ----- - .. _class_Tree_theme_style_button_pressed: - :ref:`StyleBox` **button_pressed** @@ -1327,6 +1311,22 @@ Default :ref:`StyleBox` for a :ref:`TreeItem.CELL_MODE_CUSTOM` **focus** + +The focused style for the ``Tree``, drawn on top of everything. + +---- + +.. _class_Tree_theme_style_panel: + +- :ref:`StyleBox` **panel** + +The background style for the ``Tree``. + +---- + .. _class_Tree_theme_style_selected: - :ref:`StyleBox` **selected** diff --git a/classes/class_vector2.rst b/classes/class_vector2.rst index e78b80430..2afc4ee8b 100644 --- a/classes/class_vector2.rst +++ b/classes/class_vector2.rst @@ -102,6 +102,8 @@ Methods +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_normalized` **(** **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_zero_approx` **(** **)** |const| | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`length` **(** **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`length_squared` **(** **)** |const| | @@ -468,6 +470,16 @@ Returns ``true`` if the vector is normalized, ``false`` otherwise. ---- +.. _class_Vector2_method_is_zero_approx: + +- :ref:`bool` **is_zero_approx** **(** **)** |const| + +Returns ``true`` if this vector's values are approximately zero, by running :ref:`@GlobalScope.is_zero_approx` on each component. + +This method is faster than using :ref:`is_equal_approx` with one value as a zero vector. + +---- + .. _class_Vector2_method_length: - :ref:`float` **length** **(** **)** |const| diff --git a/classes/class_vector3.rst b/classes/class_vector3.rst index 2d339bac0..9c32f4f79 100644 --- a/classes/class_vector3.rst +++ b/classes/class_vector3.rst @@ -98,6 +98,8 @@ Methods +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_normalized` **(** **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_zero_approx` **(** **)** |const| | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`length` **(** **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`length_squared` **(** **)** |const| | @@ -452,6 +454,16 @@ Returns ``true`` if the vector is normalized, ``false`` otherwise. ---- +.. _class_Vector3_method_is_zero_approx: + +- :ref:`bool` **is_zero_approx** **(** **)** |const| + +Returns ``true`` if this vector's values are approximately zero, by running :ref:`@GlobalScope.is_zero_approx` on each component. + +This method is faster than using :ref:`is_equal_approx` with one value as a zero vector. + +---- + .. _class_Vector3_method_length: - :ref:`float` **length** **(** **)** |const| diff --git a/classes/class_vector4.rst b/classes/class_vector4.rst index 8e2ffce39..8f0a76a18 100644 --- a/classes/class_vector4.rst +++ b/classes/class_vector4.rst @@ -77,6 +77,8 @@ Methods +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_normalized` **(** **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`is_zero_approx` **(** **)** |const| | ++-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`length` **(** **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`length_squared` **(** **)** |const| | @@ -240,7 +242,7 @@ Constructs a ``Vector4`` as a copy of the given ``Vector4``. - :ref:`Vector4` **Vector4** **(** :ref:`Vector4i` from **)** -Constructs a new ``Vector4`` from :ref:`Vector4i`. +Constructs a new ``Vector4`` from the given :ref:`Vector4i`. ---- @@ -359,6 +361,16 @@ Returns ``true`` if the vector is normalized, i.e. its length is equal to 1. ---- +.. _class_Vector4_method_is_zero_approx: + +- :ref:`bool` **is_zero_approx** **(** **)** |const| + +Returns ``true`` if this vector's values are approximately zero, by running :ref:`@GlobalScope.is_zero_approx` on each component. + +This method is faster than using :ref:`is_equal_approx` with one value as a zero vector. + +---- + .. _class_Vector4_method_length: - :ref:`float` **length** **(** **)** |const| diff --git a/classes/class_vector4i.rst b/classes/class_vector4i.rst index 079453b35..b685c8b3c 100644 --- a/classes/class_vector4i.rst +++ b/classes/class_vector4i.rst @@ -10,7 +10,14 @@ Vector4i ======== +Vector used for 4D math using integer coordinates. +Description +----------- + +4-element structure that can be used to represent 4D grid coordinates or sets of integers. + +It uses integer coordinates. See :ref:`Vector4` for its floating-point counterpart. Properties ---------- @@ -115,17 +122,17 @@ Constants .. _class_Vector4i_constant_ONE: -- **AXIS_X** = **0** +- **AXIS_X** = **0** --- Enumerated value for the X axis. Returned by :ref:`max_axis_index` and :ref:`min_axis_index`. -- **AXIS_Y** = **1** +- **AXIS_Y** = **1** --- Enumerated value for the Y axis. Returned by :ref:`max_axis_index` and :ref:`min_axis_index`. -- **AXIS_Z** = **2** +- **AXIS_Z** = **2** --- Enumerated value for the Z axis. Returned by :ref:`max_axis_index` and :ref:`min_axis_index`. -- **AXIS_W** = **3** +- **AXIS_W** = **3** --- Enumerated value for the W axis. Returned by :ref:`max_axis_index` and :ref:`min_axis_index`. -- **ZERO** = **Vector4i(0, 0, 0, 0)** +- **ZERO** = **Vector4i(0, 0, 0, 0)** --- Zero vector, a vector with all components set to ``0``. -- **ONE** = **Vector4i(1, 1, 1, 1)** +- **ONE** = **Vector4i(1, 1, 1, 1)** --- One vector, a vector with all components set to ``1``. Property Descriptions --------------------- @@ -138,6 +145,8 @@ Property Descriptions | *Default* | ``0`` | +-----------+-------+ +The vector's W component. Also accessible by using the index position ``[3]``. + ---- .. _class_Vector4i_property_x: @@ -148,6 +157,8 @@ Property Descriptions | *Default* | ``0`` | +-----------+-------+ +The vector's X component. Also accessible by using the index position ``[0]``. + ---- .. _class_Vector4i_property_y: @@ -158,6 +169,8 @@ Property Descriptions | *Default* | ``0`` | +-----------+-------+ +The vector's Y component. Also accessible by using the index position ``[1]``. + ---- .. _class_Vector4i_property_z: @@ -168,6 +181,8 @@ Property Descriptions | *Default* | ``0`` | +-----------+-------+ +The vector's Z component. Also accessible by using the index position ``[2]``. + Constructor Descriptions ------------------------ @@ -175,18 +190,26 @@ Constructor Descriptions - :ref:`Vector4i` **Vector4i** **(** **)** +Constructs a default-initialized ``Vector4i`` with all components set to ``0``. + ---- - :ref:`Vector4i` **Vector4i** **(** :ref:`Vector4i` from **)** +Constructs a ``Vector4i`` as a copy of the given ``Vector4i``. + ---- - :ref:`Vector4i` **Vector4i** **(** :ref:`Vector4` from **)** +Constructs a new ``Vector4i`` from the given :ref:`Vector4`. + ---- - :ref:`Vector4i` **Vector4i** **(** :ref:`int` x, :ref:`int` y, :ref:`int` z, :ref:`int` w **)** +Returns a ``Vector4i`` with the given components. + Method Descriptions ------------------- @@ -194,42 +217,56 @@ Method Descriptions - :ref:`Vector4i` **abs** **(** **)** |const| +Returns a new vector with all components in absolute values (i.e. positive). + ---- .. _class_Vector4i_method_clamp: - :ref:`Vector4i` **clamp** **(** :ref:`Vector4i` min, :ref:`Vector4i` max **)** |const| +Returns a new vector with all components clamped between the components of ``min`` and ``max``, by running :ref:`@GlobalScope.clamp` on each component. + ---- .. _class_Vector4i_method_length: - :ref:`float` **length** **(** **)** |const| +Returns the length (magnitude) of this vector. + ---- .. _class_Vector4i_method_length_squared: - :ref:`int` **length_squared** **(** **)** |const| +Returns the squared length (squared magnitude) of this vector. This method runs faster than :ref:`length`. + ---- .. _class_Vector4i_method_max_axis_index: - :ref:`int` **max_axis_index** **(** **)** |const| +Returns the axis of the vector's highest value. See ``AXIS_*`` constants. If all components are equal, this method returns :ref:`AXIS_X`. + ---- .. _class_Vector4i_method_min_axis_index: - :ref:`int` **min_axis_index** **(** **)** |const| +Returns the axis of the vector's lowest value. See ``AXIS_*`` constants. If all components are equal, this method returns :ref:`AXIS_W`. + ---- .. _class_Vector4i_method_sign: - :ref:`Vector4i` **sign** **(** **)** |const| +Returns a new vector with each component set to one or negative one, depending on the signs of the components, or zero if the component is zero, by calling :ref:`@GlobalScope.sign` on each component. + Operator Descriptions --------------------- @@ -237,6 +274,8 @@ Operator Descriptions - :ref:`bool` **operator !=** **(** :ref:`Vector4i` right **)** +Returns ``true`` if the vectors are not equal. + ---- .. _class_Vector4i_operator_mod_Vector4i: @@ -253,88 +292,148 @@ Operator Descriptions - :ref:`Vector4i` **operator *** **(** :ref:`Vector4i` right **)** +Multiplies each component of the ``Vector4i`` by the components of the given ``Vector4i``. + +:: + + print(Vector4i(10, 20, 30, 40) * Vector4i(3, 4, 5, 6)) # Prints "(30, 80, 150, 240)" + ---- - :ref:`Vector4` **operator *** **(** :ref:`float` right **)** +Multiplies each component of the ``Vector4i`` by the given :ref:`float`. + +Returns a Vector4 value due to floating-point operations. + +:: + + print(Vector4i(10, 20, 30, 40) * 2) # Prints "(20, 40, 60, 80)" + ---- - :ref:`Vector4i` **operator *** **(** :ref:`int` right **)** +Multiplies each component of the ``Vector4i`` by the given :ref:`int`. + ---- .. _class_Vector4i_operator_sum_Vector4i: - :ref:`Vector4i` **operator +** **(** :ref:`Vector4i` right **)** +Adds each component of the ``Vector4i`` by the components of the given ``Vector4i``. + +:: + + print(Vector4i(10, 20, 30, 40) + Vector4i(3, 4, 5, 6)) # Prints "(13, 24, 35, 46)" + ---- .. _class_Vector4i_operator_dif_Vector4i: - :ref:`Vector4i` **operator -** **(** :ref:`Vector4i` right **)** +Subtracts each component of the ``Vector4i`` by the components of the given ``Vector4i``. + +:: + + print(Vector4i(10, 20, 30, 40) - Vector4i(3, 4, 5, 6)) # Prints "(7, 16, 25, 34)" + ---- .. _class_Vector4i_operator_div_Vector4i: - :ref:`Vector4i` **operator /** **(** :ref:`Vector4i` right **)** +Divides each component of the ``Vector4i`` by the components of the given ``Vector4i``. + +:: + + print(Vector4i(10, 20, 30, 40) / Vector4i(2, 5, 3, 4)) # Prints "(5, 4, 10, 10)" + ---- - :ref:`Vector4` **operator /** **(** :ref:`float` right **)** +Divides each component of the ``Vector4i`` by the given :ref:`float`. + +Returns a Vector4 value due to floating-point operations. + +:: + + print(Vector4i(10, 20, 30, 40) / 2 # Prints "(5, 10, 15, 20)" + ---- - :ref:`Vector4i` **operator /** **(** :ref:`int` right **)** +Divides each component of the ``Vector4i`` by the given :ref:`int`. + ---- .. _class_Vector4i_operator_lt_bool: - :ref:`bool` **operator <** **(** :ref:`Vector4i` right **)** +Compares two ``Vector4i`` vectors by first checking if the X value of the left vector is less than the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors. + ---- .. _class_Vector4i_operator_lte_bool: - :ref:`bool` **operator <=** **(** :ref:`Vector4i` right **)** +Compares two ``Vector4i`` vectors by first checking if the X value of the left vector is less than or equal to the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors. + ---- .. _class_Vector4i_operator_eq_bool: - :ref:`bool` **operator ==** **(** :ref:`Vector4i` right **)** +Returns ``true`` if the vectors are exactly equal. + ---- .. _class_Vector4i_operator_gt_bool: - :ref:`bool` **operator >** **(** :ref:`Vector4i` right **)** +Compares two ``Vector4i`` vectors by first checking if the X value of the left vector is greater than the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors. + ---- .. _class_Vector4i_operator_gte_bool: - :ref:`bool` **operator >=** **(** :ref:`Vector4i` right **)** +Compares two ``Vector4i`` vectors by first checking if the X value of the left vector is greater than or equal to the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors. + ---- .. _class_Vector4i_operator_idx_int: - :ref:`int` **operator []** **(** :ref:`int` index **)** +Access vector components using their ``index``. ``v[0]`` is equivalent to ``v.x``, ``v[1]`` is equivalent to ``v.y``, ``v[2]`` is equivalent to ``v.z``, and ``v[3]`` is equivalent to ``v.w``. + ---- .. _class_Vector4i_operator_unplus_Vector4i: - :ref:`Vector4i` **operator unary+** **(** **)** +Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, but sometimes it can make your code more readable. + ---- .. _class_Vector4i_operator_unminus_Vector4i: - :ref:`Vector4i` **operator unary-** **(** **)** +Returns the negative value of the ``Vector4i``. This is the same as writing ``Vector4i(-v.x, -v.y, -v.z, -v.w)``. This operation flips the direction of the vector while keeping the same magnitude. + .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` diff --git a/classes/class_visualshadernode.rst b/classes/class_visualshadernode.rst index faa3b1b57..2bd27e9a4 100644 --- a/classes/class_visualshadernode.rst +++ b/classes/class_visualshadernode.rst @@ -12,7 +12,7 @@ VisualShaderNode **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -**Inherited By:** :ref:`VisualShaderNodeBillboard`, :ref:`VisualShaderNodeClamp`, :ref:`VisualShaderNodeColorFunc`, :ref:`VisualShaderNodeColorOp`, :ref:`VisualShaderNodeCompare`, :ref:`VisualShaderNodeConstant`, :ref:`VisualShaderNodeCubemap`, :ref:`VisualShaderNodeCustom`, :ref:`VisualShaderNodeDerivativeFunc`, :ref:`VisualShaderNodeDeterminant`, :ref:`VisualShaderNodeDistanceFade`, :ref:`VisualShaderNodeDotProduct`, :ref:`VisualShaderNodeFloatFunc`, :ref:`VisualShaderNodeFloatOp`, :ref:`VisualShaderNodeFresnel`, :ref:`VisualShaderNodeIf`, :ref:`VisualShaderNodeInput`, :ref:`VisualShaderNodeIntFunc`, :ref:`VisualShaderNodeIntOp`, :ref:`VisualShaderNodeIs`, :ref:`VisualShaderNodeLinearSceneDepth`, :ref:`VisualShaderNodeMix`, :ref:`VisualShaderNodeMultiplyAdd`, :ref:`VisualShaderNodeOuterProduct`, :ref:`VisualShaderNodeOutput`, :ref:`VisualShaderNodeParticleAccelerator`, :ref:`VisualShaderNodeParticleConeVelocity`, :ref:`VisualShaderNodeParticleEmit`, :ref:`VisualShaderNodeParticleEmitter`, :ref:`VisualShaderNodeParticleMultiplyByAxisAngle`, :ref:`VisualShaderNodeParticleRandomness`, :ref:`VisualShaderNodeProximityFade`, :ref:`VisualShaderNodeRandomRange`, :ref:`VisualShaderNodeRemap`, :ref:`VisualShaderNodeResizableBase`, :ref:`VisualShaderNodeSDFRaymarch`, :ref:`VisualShaderNodeSDFToScreenUV`, :ref:`VisualShaderNodeSample3D`, :ref:`VisualShaderNodeScreenUVToSDF`, :ref:`VisualShaderNodeSmoothStep`, :ref:`VisualShaderNodeStep`, :ref:`VisualShaderNodeSwitch`, :ref:`VisualShaderNodeTexture`, :ref:`VisualShaderNodeTextureSDF`, :ref:`VisualShaderNodeTextureSDFNormal`, :ref:`VisualShaderNodeTransformCompose`, :ref:`VisualShaderNodeTransformDecompose`, :ref:`VisualShaderNodeTransformFunc`, :ref:`VisualShaderNodeTransformOp`, :ref:`VisualShaderNodeTransformVecMult`, :ref:`VisualShaderNodeUVFunc`, :ref:`VisualShaderNodeUVPolarCoord`, :ref:`VisualShaderNodeUniform`, :ref:`VisualShaderNodeUniformRef`, :ref:`VisualShaderNodeVarying`, :ref:`VisualShaderNodeVectorBase` +**Inherited By:** :ref:`VisualShaderNodeBillboard`, :ref:`VisualShaderNodeClamp`, :ref:`VisualShaderNodeColorFunc`, :ref:`VisualShaderNodeColorOp`, :ref:`VisualShaderNodeCompare`, :ref:`VisualShaderNodeConstant`, :ref:`VisualShaderNodeCubemap`, :ref:`VisualShaderNodeCustom`, :ref:`VisualShaderNodeDerivativeFunc`, :ref:`VisualShaderNodeDeterminant`, :ref:`VisualShaderNodeDistanceFade`, :ref:`VisualShaderNodeDotProduct`, :ref:`VisualShaderNodeFloatFunc`, :ref:`VisualShaderNodeFloatOp`, :ref:`VisualShaderNodeFresnel`, :ref:`VisualShaderNodeIf`, :ref:`VisualShaderNodeInput`, :ref:`VisualShaderNodeIntFunc`, :ref:`VisualShaderNodeIntOp`, :ref:`VisualShaderNodeIs`, :ref:`VisualShaderNodeLinearSceneDepth`, :ref:`VisualShaderNodeMix`, :ref:`VisualShaderNodeMultiplyAdd`, :ref:`VisualShaderNodeOuterProduct`, :ref:`VisualShaderNodeOutput`, :ref:`VisualShaderNodeParameter`, :ref:`VisualShaderNodeParameterRef`, :ref:`VisualShaderNodeParticleAccelerator`, :ref:`VisualShaderNodeParticleConeVelocity`, :ref:`VisualShaderNodeParticleEmit`, :ref:`VisualShaderNodeParticleEmitter`, :ref:`VisualShaderNodeParticleMultiplyByAxisAngle`, :ref:`VisualShaderNodeParticleRandomness`, :ref:`VisualShaderNodeProximityFade`, :ref:`VisualShaderNodeRandomRange`, :ref:`VisualShaderNodeRemap`, :ref:`VisualShaderNodeResizableBase`, :ref:`VisualShaderNodeSDFRaymarch`, :ref:`VisualShaderNodeSDFToScreenUV`, :ref:`VisualShaderNodeSample3D`, :ref:`VisualShaderNodeScreenUVToSDF`, :ref:`VisualShaderNodeSmoothStep`, :ref:`VisualShaderNodeStep`, :ref:`VisualShaderNodeSwitch`, :ref:`VisualShaderNodeTexture`, :ref:`VisualShaderNodeTextureSDF`, :ref:`VisualShaderNodeTextureSDFNormal`, :ref:`VisualShaderNodeTransformCompose`, :ref:`VisualShaderNodeTransformDecompose`, :ref:`VisualShaderNodeTransformFunc`, :ref:`VisualShaderNodeTransformOp`, :ref:`VisualShaderNodeTransformVecMult`, :ref:`VisualShaderNodeUVFunc`, :ref:`VisualShaderNodeUVPolarCoord`, :ref:`VisualShaderNodeVarying`, :ref:`VisualShaderNodeVectorBase` Base class for nodes in a visual shader graph. diff --git a/classes/class_visualshadernodebooleanuniform.rst b/classes/class_visualshadernodebooleanparameter.rst similarity index 68% rename from classes/class_visualshadernodebooleanuniform.rst rename to classes/class_visualshadernodebooleanparameter.rst index 0a6df7812..6bc329196 100644 --- a/classes/class_visualshadernodebooleanuniform.rst +++ b/classes/class_visualshadernodebooleanparameter.rst @@ -3,16 +3,16 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeBooleanUniform.xml. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeBooleanParameter.xml. -.. _class_VisualShaderNodeBooleanUniform: +.. _class_VisualShaderNodeBooleanParameter: -VisualShaderNodeBooleanUniform -============================== +VisualShaderNodeBooleanParameter +================================ -**Inherits:** :ref:`VisualShaderNodeUniform` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +**Inherits:** :ref:`VisualShaderNodeParameter` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -A boolean uniform to be used within the visual shader graph. +A boolean parameter to be used within the visual shader graph. Description ----------- @@ -22,16 +22,16 @@ Translated to ``uniform bool`` in the shader language. Properties ---------- -+-------------------------+---------------------------------------------------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`default_value` | ``false`` | -+-------------------------+---------------------------------------------------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`default_value_enabled` | ``false`` | -+-------------------------+---------------------------------------------------------------------------------------------------+-----------+ ++-------------------------+-----------------------------------------------------------------------------------------------------+-----------+ +| :ref:`bool` | :ref:`default_value` | ``false`` | ++-------------------------+-----------------------------------------------------------------------------------------------------+-----------+ +| :ref:`bool` | :ref:`default_value_enabled` | ``false`` | ++-------------------------+-----------------------------------------------------------------------------------------------------+-----------+ Property Descriptions --------------------- -.. _class_VisualShaderNodeBooleanUniform_property_default_value: +.. _class_VisualShaderNodeBooleanParameter_property_default_value: - :ref:`bool` **default_value** @@ -47,7 +47,7 @@ A default value to be assigned within the shader. ---- -.. _class_VisualShaderNodeBooleanUniform_property_default_value_enabled: +.. _class_VisualShaderNodeBooleanParameter_property_default_value_enabled: - :ref:`bool` **default_value_enabled** @@ -59,7 +59,7 @@ A default value to be assigned within the shader. | *Getter* | is_default_value_enabled() | +-----------+----------------------------------+ -Enables usage of the :ref:`default_value`. +Enables usage of the :ref:`default_value`. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_visualshadernodecoloruniform.rst b/classes/class_visualshadernodecolorparameter.rst similarity index 67% rename from classes/class_visualshadernodecoloruniform.rst rename to classes/class_visualshadernodecolorparameter.rst index 537dda572..f1fe9b91e 100644 --- a/classes/class_visualshadernodecoloruniform.rst +++ b/classes/class_visualshadernodecolorparameter.rst @@ -3,16 +3,16 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeColorUniform.xml. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeColorParameter.xml. -.. _class_VisualShaderNodeColorUniform: +.. _class_VisualShaderNodeColorParameter: -VisualShaderNodeColorUniform -============================ +VisualShaderNodeColorParameter +============================== -**Inherits:** :ref:`VisualShaderNodeUniform` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +**Inherits:** :ref:`VisualShaderNodeParameter` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -A :ref:`Color` uniform to be used within the visual shader graph. +A :ref:`Color` parameter to be used within the visual shader graph. Description ----------- @@ -22,16 +22,16 @@ Translated to ``uniform vec4`` in the shader language. Properties ---------- -+---------------------------+-------------------------------------------------------------------------------------------------+-----------------------+ -| :ref:`Color` | :ref:`default_value` | ``Color(1, 1, 1, 1)`` | -+---------------------------+-------------------------------------------------------------------------------------------------+-----------------------+ -| :ref:`bool` | :ref:`default_value_enabled` | ``false`` | -+---------------------------+-------------------------------------------------------------------------------------------------+-----------------------+ ++---------------------------+---------------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`Color` | :ref:`default_value` | ``Color(1, 1, 1, 1)`` | ++---------------------------+---------------------------------------------------------------------------------------------------+-----------------------+ +| :ref:`bool` | :ref:`default_value_enabled` | ``false`` | ++---------------------------+---------------------------------------------------------------------------------------------------+-----------------------+ Property Descriptions --------------------- -.. _class_VisualShaderNodeColorUniform_property_default_value: +.. _class_VisualShaderNodeColorParameter_property_default_value: - :ref:`Color` **default_value** @@ -47,7 +47,7 @@ A default value to be assigned within the shader. ---- -.. _class_VisualShaderNodeColorUniform_property_default_value_enabled: +.. _class_VisualShaderNodeColorParameter_property_default_value_enabled: - :ref:`bool` **default_value_enabled** @@ -59,7 +59,7 @@ A default value to be assigned within the shader. | *Getter* | is_default_value_enabled() | +-----------+----------------------------------+ -Enables usage of the :ref:`default_value`. +Enables usage of the :ref:`default_value`. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_visualshadernodecubemapuniform.rst b/classes/class_visualshadernodecubemapparameter.rst similarity index 66% rename from classes/class_visualshadernodecubemapuniform.rst rename to classes/class_visualshadernodecubemapparameter.rst index 4cb2f4b42..96443a1f9 100644 --- a/classes/class_visualshadernodecubemapuniform.rst +++ b/classes/class_visualshadernodecubemapparameter.rst @@ -3,16 +3,16 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeCubemapUniform.xml. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeCubemapParameter.xml. -.. _class_VisualShaderNodeCubemapUniform: +.. _class_VisualShaderNodeCubemapParameter: -VisualShaderNodeCubemapUniform -============================== +VisualShaderNodeCubemapParameter +================================ -**Inherits:** :ref:`VisualShaderNodeTextureUniform` **<** :ref:`VisualShaderNodeUniform` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +**Inherits:** :ref:`VisualShaderNodeTextureParameter` **<** :ref:`VisualShaderNodeParameter` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -A :ref:`Cubemap` uniform node to be used within the visual shader graph. +A :ref:`Cubemap` parameter node to be used within the visual shader graph. Description ----------- diff --git a/classes/class_visualshadernodefloatuniform.rst b/classes/class_visualshadernodefloatparameter.rst similarity index 50% rename from classes/class_visualshadernodefloatuniform.rst rename to classes/class_visualshadernodefloatparameter.rst index e02324586..fe6ef0b4b 100644 --- a/classes/class_visualshadernodefloatuniform.rst +++ b/classes/class_visualshadernodefloatparameter.rst @@ -3,16 +3,16 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeFloatUniform.xml. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeFloatParameter.xml. -.. _class_VisualShaderNodeFloatUniform: +.. _class_VisualShaderNodeFloatParameter: -VisualShaderNodeFloatUniform -============================ +VisualShaderNodeFloatParameter +============================== -**Inherits:** :ref:`VisualShaderNodeUniform` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +**Inherits:** :ref:`VisualShaderNodeParameter` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -A scalar float uniform to be used within the visual shader graph. +A scalar float parameter to be used within the visual shader graph. Description ----------- @@ -22,47 +22,47 @@ Translated to ``uniform float`` in the shader language. Properties ---------- -+-----------------------------------------------------+-------------------------------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`default_value` | ``0.0`` | -+-----------------------------------------------------+-------------------------------------------------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`default_value_enabled` | ``false`` | -+-----------------------------------------------------+-------------------------------------------------------------------------------------------------+-----------+ -| :ref:`Hint` | :ref:`hint` | ``0`` | -+-----------------------------------------------------+-------------------------------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`max` | ``1.0`` | -+-----------------------------------------------------+-------------------------------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`min` | ``0.0`` | -+-----------------------------------------------------+-------------------------------------------------------------------------------------------------+-----------+ -| :ref:`float` | :ref:`step` | ``0.1`` | -+-----------------------------------------------------+-------------------------------------------------------------------------------------------------+-----------+ ++-------------------------------------------------------+---------------------------------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`default_value` | ``0.0`` | ++-------------------------------------------------------+---------------------------------------------------------------------------------------------------+-----------+ +| :ref:`bool` | :ref:`default_value_enabled` | ``false`` | ++-------------------------------------------------------+---------------------------------------------------------------------------------------------------+-----------+ +| :ref:`Hint` | :ref:`hint` | ``0`` | ++-------------------------------------------------------+---------------------------------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`max` | ``1.0`` | ++-------------------------------------------------------+---------------------------------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`min` | ``0.0`` | ++-------------------------------------------------------+---------------------------------------------------------------------------------------------------+-----------+ +| :ref:`float` | :ref:`step` | ``0.1`` | ++-------------------------------------------------------+---------------------------------------------------------------------------------------------------+-----------+ Enumerations ------------ -.. _enum_VisualShaderNodeFloatUniform_Hint: +.. _enum_VisualShaderNodeFloatParameter_Hint: -.. _class_VisualShaderNodeFloatUniform_constant_HINT_NONE: +.. _class_VisualShaderNodeFloatParameter_constant_HINT_NONE: -.. _class_VisualShaderNodeFloatUniform_constant_HINT_RANGE: +.. _class_VisualShaderNodeFloatParameter_constant_HINT_RANGE: -.. _class_VisualShaderNodeFloatUniform_constant_HINT_RANGE_STEP: +.. _class_VisualShaderNodeFloatParameter_constant_HINT_RANGE_STEP: -.. _class_VisualShaderNodeFloatUniform_constant_HINT_MAX: +.. _class_VisualShaderNodeFloatParameter_constant_HINT_MAX: enum **Hint**: - **HINT_NONE** = **0** --- No hint used. -- **HINT_RANGE** = **1** --- A range hint for scalar value, which limits possible input values between :ref:`min` and :ref:`max`. Translated to ``hint_range(min, max)`` in shader code. +- **HINT_RANGE** = **1** --- A range hint for scalar value, which limits possible input values between :ref:`min` and :ref:`max`. Translated to ``hint_range(min, max)`` in shader code. -- **HINT_RANGE_STEP** = **2** --- A range hint for scalar value with step, which limits possible input values between :ref:`min` and :ref:`max`, with a step (increment) of :ref:`step`). Translated to ``hint_range(min, max, step)`` in shader code. +- **HINT_RANGE_STEP** = **2** --- A range hint for scalar value with step, which limits possible input values between :ref:`min` and :ref:`max`, with a step (increment) of :ref:`step`). Translated to ``hint_range(min, max, step)`` in shader code. -- **HINT_MAX** = **3** --- Represents the size of the :ref:`Hint` enum. +- **HINT_MAX** = **3** --- Represents the size of the :ref:`Hint` enum. Property Descriptions --------------------- -.. _class_VisualShaderNodeFloatUniform_property_default_value: +.. _class_VisualShaderNodeFloatParameter_property_default_value: - :ref:`float` **default_value** @@ -78,7 +78,7 @@ A default value to be assigned within the shader. ---- -.. _class_VisualShaderNodeFloatUniform_property_default_value_enabled: +.. _class_VisualShaderNodeFloatParameter_property_default_value_enabled: - :ref:`bool` **default_value_enabled** @@ -90,13 +90,13 @@ A default value to be assigned within the shader. | *Getter* | is_default_value_enabled() | +-----------+----------------------------------+ -Enables usage of the :ref:`default_value`. +Enables usage of the :ref:`default_value`. ---- -.. _class_VisualShaderNodeFloatUniform_property_hint: +.. _class_VisualShaderNodeFloatParameter_property_hint: -- :ref:`Hint` **hint** +- :ref:`Hint` **hint** +-----------+-----------------+ | *Default* | ``0`` | @@ -110,7 +110,7 @@ A hint applied to the uniform, which controls the values it can take when set th ---- -.. _class_VisualShaderNodeFloatUniform_property_max: +.. _class_VisualShaderNodeFloatParameter_property_max: - :ref:`float` **max** @@ -122,11 +122,11 @@ A hint applied to the uniform, which controls the values it can take when set th | *Getter* | get_max() | +-----------+----------------+ -Minimum value for range hints. Used if :ref:`hint` is set to :ref:`HINT_RANGE` or :ref:`HINT_RANGE_STEP`. +Minimum value for range hints. Used if :ref:`hint` is set to :ref:`HINT_RANGE` or :ref:`HINT_RANGE_STEP`. ---- -.. _class_VisualShaderNodeFloatUniform_property_min: +.. _class_VisualShaderNodeFloatParameter_property_min: - :ref:`float` **min** @@ -138,11 +138,11 @@ Minimum value for range hints. Used if :ref:`hint` is set to :ref:`HINT_RANGE` or :ref:`HINT_RANGE_STEP`. +Maximum value for range hints. Used if :ref:`hint` is set to :ref:`HINT_RANGE` or :ref:`HINT_RANGE_STEP`. ---- -.. _class_VisualShaderNodeFloatUniform_property_step: +.. _class_VisualShaderNodeFloatParameter_property_step: - :ref:`float` **step** @@ -154,7 +154,7 @@ Maximum value for range hints. Used if :ref:`hint` is set to :ref:`HINT_RANGE_STEP`. +Step (increment) value for the range hint with step. Used if :ref:`hint` is set to :ref:`HINT_RANGE_STEP`. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_visualshadernodeintparameter.rst b/classes/class_visualshadernodeintparameter.rst new file mode 100644 index 000000000..b3edac9c2 --- /dev/null +++ b/classes/class_visualshadernodeintparameter.rst @@ -0,0 +1,147 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeIntParameter.xml. + +.. _class_VisualShaderNodeIntParameter: + +VisualShaderNodeIntParameter +============================ + +**Inherits:** :ref:`VisualShaderNodeParameter` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` + + + +Properties +---------- + ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------+-----------+ +| :ref:`int` | :ref:`default_value` | ``0`` | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------+-----------+ +| :ref:`bool` | :ref:`default_value_enabled` | ``false`` | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------+-----------+ +| :ref:`Hint` | :ref:`hint` | ``0`` | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------+-----------+ +| :ref:`int` | :ref:`max` | ``100`` | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------+-----------+ +| :ref:`int` | :ref:`min` | ``0`` | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------+-----------+ +| :ref:`int` | :ref:`step` | ``1`` | ++-----------------------------------------------------+-------------------------------------------------------------------------------------------------+-----------+ + +Enumerations +------------ + +.. _enum_VisualShaderNodeIntParameter_Hint: + +.. _class_VisualShaderNodeIntParameter_constant_HINT_NONE: + +.. _class_VisualShaderNodeIntParameter_constant_HINT_RANGE: + +.. _class_VisualShaderNodeIntParameter_constant_HINT_RANGE_STEP: + +.. _class_VisualShaderNodeIntParameter_constant_HINT_MAX: + +enum **Hint**: + +- **HINT_NONE** = **0** + +- **HINT_RANGE** = **1** + +- **HINT_RANGE_STEP** = **2** + +- **HINT_MAX** = **3** + +Property Descriptions +--------------------- + +.. _class_VisualShaderNodeIntParameter_property_default_value: + +- :ref:`int` **default_value** + ++-----------+--------------------------+ +| *Default* | ``0`` | ++-----------+--------------------------+ +| *Setter* | set_default_value(value) | ++-----------+--------------------------+ +| *Getter* | get_default_value() | ++-----------+--------------------------+ + +---- + +.. _class_VisualShaderNodeIntParameter_property_default_value_enabled: + +- :ref:`bool` **default_value_enabled** + ++-----------+----------------------------------+ +| *Default* | ``false`` | ++-----------+----------------------------------+ +| *Setter* | set_default_value_enabled(value) | ++-----------+----------------------------------+ +| *Getter* | is_default_value_enabled() | ++-----------+----------------------------------+ + +---- + +.. _class_VisualShaderNodeIntParameter_property_hint: + +- :ref:`Hint` **hint** + ++-----------+-----------------+ +| *Default* | ``0`` | ++-----------+-----------------+ +| *Setter* | set_hint(value) | ++-----------+-----------------+ +| *Getter* | get_hint() | ++-----------+-----------------+ + +---- + +.. _class_VisualShaderNodeIntParameter_property_max: + +- :ref:`int` **max** + ++-----------+----------------+ +| *Default* | ``100`` | ++-----------+----------------+ +| *Setter* | set_max(value) | ++-----------+----------------+ +| *Getter* | get_max() | ++-----------+----------------+ + +---- + +.. _class_VisualShaderNodeIntParameter_property_min: + +- :ref:`int` **min** + ++-----------+----------------+ +| *Default* | ``0`` | ++-----------+----------------+ +| *Setter* | set_min(value) | ++-----------+----------------+ +| *Getter* | get_min() | ++-----------+----------------+ + +---- + +.. _class_VisualShaderNodeIntParameter_property_step: + +- :ref:`int` **step** + ++-----------+-----------------+ +| *Default* | ``1`` | ++-----------+-----------------+ +| *Setter* | set_step(value) | ++-----------+-----------------+ +| *Getter* | get_step() | ++-----------+-----------------+ + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` diff --git a/classes/class_visualshadernodeintuniform.rst b/classes/class_visualshadernodeintuniform.rst deleted file mode 100644 index a0aaff6c8..000000000 --- a/classes/class_visualshadernodeintuniform.rst +++ /dev/null @@ -1,164 +0,0 @@ -:github_url: hide - -.. DO NOT EDIT THIS FILE!!! -.. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeIntUniform.xml. - -.. _class_VisualShaderNodeIntUniform: - -VisualShaderNodeIntUniform -========================== - -**Inherits:** :ref:`VisualShaderNodeUniform` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` - -A scalar integer uniform to be used within the visual shader graph. - -Description ------------ - -Translated to ``uniform int`` in the shader language. - -Properties ----------- - -+---------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+ -| :ref:`int` | :ref:`default_value` | ``0`` | -+---------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+ -| :ref:`bool` | :ref:`default_value_enabled` | ``false`` | -+---------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+ -| :ref:`Hint` | :ref:`hint` | ``0`` | -+---------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+ -| :ref:`int` | :ref:`max` | ``100`` | -+---------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+ -| :ref:`int` | :ref:`min` | ``0`` | -+---------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+ -| :ref:`int` | :ref:`step` | ``1`` | -+---------------------------------------------------+-----------------------------------------------------------------------------------------------+-----------+ - -Enumerations ------------- - -.. _enum_VisualShaderNodeIntUniform_Hint: - -.. _class_VisualShaderNodeIntUniform_constant_HINT_NONE: - -.. _class_VisualShaderNodeIntUniform_constant_HINT_RANGE: - -.. _class_VisualShaderNodeIntUniform_constant_HINT_RANGE_STEP: - -.. _class_VisualShaderNodeIntUniform_constant_HINT_MAX: - -enum **Hint**: - -- **HINT_NONE** = **0** --- No hint used. - -- **HINT_RANGE** = **1** --- A range hint for scalar value, which limits possible input values between :ref:`min` and :ref:`max`. Translated to ``hint_range(min, max)`` in shader code. - -- **HINT_RANGE_STEP** = **2** --- A range hint for scalar value with step, which limits possible input values between :ref:`min` and :ref:`max`, with a step (increment) of :ref:`step`). Translated to ``hint_range(min, max, step)`` in shader code. - -- **HINT_MAX** = **3** --- Represents the size of the :ref:`Hint` enum. - -Property Descriptions ---------------------- - -.. _class_VisualShaderNodeIntUniform_property_default_value: - -- :ref:`int` **default_value** - -+-----------+--------------------------+ -| *Default* | ``0`` | -+-----------+--------------------------+ -| *Setter* | set_default_value(value) | -+-----------+--------------------------+ -| *Getter* | get_default_value() | -+-----------+--------------------------+ - -A default value to be assigned within the shader. - ----- - -.. _class_VisualShaderNodeIntUniform_property_default_value_enabled: - -- :ref:`bool` **default_value_enabled** - -+-----------+----------------------------------+ -| *Default* | ``false`` | -+-----------+----------------------------------+ -| *Setter* | set_default_value_enabled(value) | -+-----------+----------------------------------+ -| *Getter* | is_default_value_enabled() | -+-----------+----------------------------------+ - -Enables usage of the :ref:`default_value`. - ----- - -.. _class_VisualShaderNodeIntUniform_property_hint: - -- :ref:`Hint` **hint** - -+-----------+-----------------+ -| *Default* | ``0`` | -+-----------+-----------------+ -| *Setter* | set_hint(value) | -+-----------+-----------------+ -| *Getter* | get_hint() | -+-----------+-----------------+ - -A hint applied to the uniform, which controls the values it can take when set through the inspector. - ----- - -.. _class_VisualShaderNodeIntUniform_property_max: - -- :ref:`int` **max** - -+-----------+----------------+ -| *Default* | ``100`` | -+-----------+----------------+ -| *Setter* | set_max(value) | -+-----------+----------------+ -| *Getter* | get_max() | -+-----------+----------------+ - -Minimum value for range hints. Used if :ref:`hint` is set to :ref:`HINT_RANGE` or :ref:`HINT_RANGE_STEP`. - ----- - -.. _class_VisualShaderNodeIntUniform_property_min: - -- :ref:`int` **min** - -+-----------+----------------+ -| *Default* | ``0`` | -+-----------+----------------+ -| *Setter* | set_min(value) | -+-----------+----------------+ -| *Getter* | get_min() | -+-----------+----------------+ - -Maximum value for range hints. Used if :ref:`hint` is set to :ref:`HINT_RANGE` or :ref:`HINT_RANGE_STEP`. - ----- - -.. _class_VisualShaderNodeIntUniform_property_step: - -- :ref:`int` **step** - -+-----------+-----------------+ -| *Default* | ``1`` | -+-----------+-----------------+ -| *Setter* | set_step(value) | -+-----------+-----------------+ -| *Getter* | get_step() | -+-----------+-----------------+ - -Step (increment) value for the range hint with step. Used if :ref:`hint` is set to :ref:`HINT_RANGE_STEP`. - -.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` -.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` -.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` -.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` -.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` -.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` diff --git a/classes/class_visualshadernodeparameter.rst b/classes/class_visualshadernodeparameter.rst new file mode 100644 index 000000000..cbe59869f --- /dev/null +++ b/classes/class_visualshadernodeparameter.rst @@ -0,0 +1,92 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeParameter.xml. + +.. _class_VisualShaderNodeParameter: + +VisualShaderNodeParameter +========================= + +**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` + +**Inherited By:** :ref:`VisualShaderNodeBooleanParameter`, :ref:`VisualShaderNodeColorParameter`, :ref:`VisualShaderNodeFloatParameter`, :ref:`VisualShaderNodeIntParameter`, :ref:`VisualShaderNodeTextureParameter`, :ref:`VisualShaderNodeTransformParameter`, :ref:`VisualShaderNodeVec2Parameter`, :ref:`VisualShaderNodeVec3Parameter`, :ref:`VisualShaderNodeVec4Parameter` + +A base type for the parameters within the visual shader graph. + +Description +----------- + +A parameter represents a variable in the shader which is set externally, i.e. from the :ref:`ShaderMaterial`. Parameters are exposed as properties in the :ref:`ShaderMaterial` and can be assigned from the inspector or from a script. + +Properties +---------- + ++------------------------------------------------------------+--------------------------------------------------------------------------------+--------+ +| :ref:`String` | :ref:`parameter_name` | ``""`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------+--------+ +| :ref:`Qualifier` | :ref:`qualifier` | ``0`` | ++------------------------------------------------------------+--------------------------------------------------------------------------------+--------+ + +Enumerations +------------ + +.. _enum_VisualShaderNodeParameter_Qualifier: + +.. _class_VisualShaderNodeParameter_constant_QUAL_NONE: + +.. _class_VisualShaderNodeParameter_constant_QUAL_GLOBAL: + +.. _class_VisualShaderNodeParameter_constant_QUAL_INSTANCE: + +.. _class_VisualShaderNodeParameter_constant_QUAL_MAX: + +enum **Qualifier**: + +- **QUAL_NONE** = **0** + +- **QUAL_GLOBAL** = **1** + +- **QUAL_INSTANCE** = **2** + +- **QUAL_MAX** = **3** --- Represents the size of the :ref:`Qualifier` enum. + +Property Descriptions +--------------------- + +.. _class_VisualShaderNodeParameter_property_parameter_name: + +- :ref:`String` **parameter_name** + ++-----------+---------------------------+ +| *Default* | ``""`` | ++-----------+---------------------------+ +| *Setter* | set_parameter_name(value) | ++-----------+---------------------------+ +| *Getter* | get_parameter_name() | ++-----------+---------------------------+ + +Name of the parameter, by which it can be accessed through the :ref:`ShaderMaterial` properties. + +---- + +.. _class_VisualShaderNodeParameter_property_qualifier: + +- :ref:`Qualifier` **qualifier** + ++-----------+----------------------+ +| *Default* | ``0`` | ++-----------+----------------------+ +| *Setter* | set_qualifier(value) | ++-----------+----------------------+ +| *Getter* | get_qualifier() | ++-----------+----------------------+ + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` diff --git a/classes/class_visualshadernodeuniformref.rst b/classes/class_visualshadernodeparameterref.rst similarity index 54% rename from classes/class_visualshadernodeuniformref.rst rename to classes/class_visualshadernodeparameterref.rst index a77e19b1a..4f9d7a643 100644 --- a/classes/class_visualshadernodeuniformref.rst +++ b/classes/class_visualshadernodeparameterref.rst @@ -3,45 +3,45 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeUniformRef.xml. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeParameterRef.xml. -.. _class_VisualShaderNodeUniformRef: +.. _class_VisualShaderNodeParameterRef: -VisualShaderNodeUniformRef -========================== +VisualShaderNodeParameterRef +============================ **Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -A reference to an existing :ref:`VisualShaderNodeUniform`. +A reference to an existing :ref:`VisualShaderNodeParameter`. Description ----------- -Creating a reference to a :ref:`VisualShaderNodeUniform` allows you to reuse this uniform in different shaders or shader stages easily. +Creating a reference to a :ref:`VisualShaderNodeParameter` allows you to reuse this parameter in different shaders or shader stages easily. Properties ---------- -+-----------------------------+-----------------------------------------------------------------------------+--------------+ -| :ref:`String` | :ref:`uniform_name` | ``"[None]"`` | -+-----------------------------+-----------------------------------------------------------------------------+--------------+ ++-----------------------------+-----------------------------------------------------------------------------------+--------------+ +| :ref:`String` | :ref:`parameter_name` | ``"[None]"`` | ++-----------------------------+-----------------------------------------------------------------------------------+--------------+ Property Descriptions --------------------- -.. _class_VisualShaderNodeUniformRef_property_uniform_name: +.. _class_VisualShaderNodeParameterRef_property_parameter_name: -- :ref:`String` **uniform_name** +- :ref:`String` **parameter_name** -+-----------+-------------------------+ -| *Default* | ``"[None]"`` | -+-----------+-------------------------+ -| *Setter* | set_uniform_name(value) | -+-----------+-------------------------+ -| *Getter* | get_uniform_name() | -+-----------+-------------------------+ ++-----------+---------------------------+ +| *Default* | ``"[None]"`` | ++-----------+---------------------------+ +| *Setter* | set_parameter_name(value) | ++-----------+---------------------------+ +| *Getter* | get_parameter_name() | ++-----------+---------------------------+ -The name of the uniform which this reference points to. +The name of the parameter which this reference points to. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_visualshadernodetexture2darrayparameter.rst b/classes/class_visualshadernodetexture2darrayparameter.rst new file mode 100644 index 000000000..20502f2a0 --- /dev/null +++ b/classes/class_visualshadernodetexture2darrayparameter.rst @@ -0,0 +1,22 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeTexture2DArrayParameter.xml. + +.. _class_VisualShaderNodeTexture2DArrayParameter: + +VisualShaderNodeTexture2DArrayParameter +======================================= + +**Inherits:** :ref:`VisualShaderNodeTextureParameter` **<** :ref:`VisualShaderNodeParameter` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` + + + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` diff --git a/classes/class_visualshadernodetexture2dparameter.rst b/classes/class_visualshadernodetexture2dparameter.rst new file mode 100644 index 000000000..214d1deaa --- /dev/null +++ b/classes/class_visualshadernodetexture2dparameter.rst @@ -0,0 +1,27 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeTexture2DParameter.xml. + +.. _class_VisualShaderNodeTexture2DParameter: + +VisualShaderNodeTexture2DParameter +================================== + +**Inherits:** :ref:`VisualShaderNodeTextureParameter` **<** :ref:`VisualShaderNodeParameter` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` + +Provides a 2D texture parameter within the visual shader graph. + +Description +----------- + +Translated to ``uniform sampler2D`` in the shader language. + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` diff --git a/classes/class_visualshadernodetexture3duniform.rst b/classes/class_visualshadernodetexture3dparameter.rst similarity index 65% rename from classes/class_visualshadernodetexture3duniform.rst rename to classes/class_visualshadernodetexture3dparameter.rst index d5d3cfc81..9f2ed506b 100644 --- a/classes/class_visualshadernodetexture3duniform.rst +++ b/classes/class_visualshadernodetexture3dparameter.rst @@ -3,16 +3,16 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeTexture3DUniform.xml. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeTexture3DParameter.xml. -.. _class_VisualShaderNodeTexture3DUniform: +.. _class_VisualShaderNodeTexture3DParameter: -VisualShaderNodeTexture3DUniform -================================ +VisualShaderNodeTexture3DParameter +================================== -**Inherits:** :ref:`VisualShaderNodeTextureUniform` **<** :ref:`VisualShaderNodeUniform` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +**Inherits:** :ref:`VisualShaderNodeTextureParameter` **<** :ref:`VisualShaderNodeParameter` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -Provides a 3D texture uniform within the visual shader graph. +Provides a 3D texture parameter within the visual shader graph. Description ----------- diff --git a/classes/class_visualshadernodetextureparameter.rst b/classes/class_visualshadernodetextureparameter.rst new file mode 100644 index 000000000..5298db8ab --- /dev/null +++ b/classes/class_visualshadernodetextureparameter.rst @@ -0,0 +1,216 @@ +:github_url: hide + +.. DO NOT EDIT THIS FILE!!! +.. Generated automatically from Godot engine sources. +.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeTextureParameter.xml. + +.. _class_VisualShaderNodeTextureParameter: + +VisualShaderNodeTextureParameter +================================ + +**Inherits:** :ref:`VisualShaderNodeParameter` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` + +**Inherited By:** :ref:`VisualShaderNodeCubemapParameter`, :ref:`VisualShaderNodeTexture2DArrayParameter`, :ref:`VisualShaderNodeTexture2DParameter`, :ref:`VisualShaderNodeTexture3DParameter`, :ref:`VisualShaderNodeTextureParameterTriplanar` + +Performs a uniform texture lookup within the visual shader graph. + +Description +----------- + +Performs a lookup operation on the texture provided as a uniform for the shader. + +Properties +---------- + ++---------------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------+ +| :ref:`ColorDefault` | :ref:`color_default` | ``0`` | ++---------------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------+ +| :ref:`TextureFilter` | :ref:`texture_filter` | ``0`` | ++---------------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------+ +| :ref:`TextureRepeat` | :ref:`texture_repeat` | ``0`` | ++---------------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------+ +| :ref:`TextureType` | :ref:`texture_type` | ``0`` | ++---------------------------------------------------------------------------+---------------------------------------------------------------------------------------+-------+ + +Enumerations +------------ + +.. _enum_VisualShaderNodeTextureParameter_TextureType: + +.. _class_VisualShaderNodeTextureParameter_constant_TYPE_DATA: + +.. _class_VisualShaderNodeTextureParameter_constant_TYPE_COLOR: + +.. _class_VisualShaderNodeTextureParameter_constant_TYPE_NORMAL_MAP: + +.. _class_VisualShaderNodeTextureParameter_constant_TYPE_ANISOTROPY: + +.. _class_VisualShaderNodeTextureParameter_constant_TYPE_MAX: + +enum **TextureType**: + +- **TYPE_DATA** = **0** --- No hints are added to the uniform declaration. + +- **TYPE_COLOR** = **1** --- Adds ``source_color`` as hint to the uniform declaration for proper sRGB to linear conversion. + +- **TYPE_NORMAL_MAP** = **2** --- Adds ``hint_normal`` as hint to the uniform declaration, which internally converts the texture for proper usage as normal map. + +- **TYPE_ANISOTROPY** = **3** --- Adds ``hint_anisotropy`` as hint to the uniform declaration to use for a flowmap. + +- **TYPE_MAX** = **4** --- Represents the size of the :ref:`TextureType` enum. + +---- + +.. _enum_VisualShaderNodeTextureParameter_ColorDefault: + +.. _class_VisualShaderNodeTextureParameter_constant_COLOR_DEFAULT_WHITE: + +.. _class_VisualShaderNodeTextureParameter_constant_COLOR_DEFAULT_BLACK: + +.. _class_VisualShaderNodeTextureParameter_constant_COLOR_DEFAULT_TRANSPARENT: + +.. _class_VisualShaderNodeTextureParameter_constant_COLOR_DEFAULT_MAX: + +enum **ColorDefault**: + +- **COLOR_DEFAULT_WHITE** = **0** --- Defaults to fully opaque white color. + +- **COLOR_DEFAULT_BLACK** = **1** --- Defaults to fully opaque black color. + +- **COLOR_DEFAULT_TRANSPARENT** = **2** --- Defaults to fully transparent black color. + +- **COLOR_DEFAULT_MAX** = **3** --- Represents the size of the :ref:`ColorDefault` enum. + +---- + +.. _enum_VisualShaderNodeTextureParameter_TextureFilter: + +.. _class_VisualShaderNodeTextureParameter_constant_FILTER_DEFAULT: + +.. _class_VisualShaderNodeTextureParameter_constant_FILTER_NEAREST: + +.. _class_VisualShaderNodeTextureParameter_constant_FILTER_LINEAR: + +.. _class_VisualShaderNodeTextureParameter_constant_FILTER_NEAREST_MIPMAP: + +.. _class_VisualShaderNodeTextureParameter_constant_FILTER_LINEAR_MIPMAP: + +.. _class_VisualShaderNodeTextureParameter_constant_FILTER_NEAREST_MIPMAP_ANISOTROPIC: + +.. _class_VisualShaderNodeTextureParameter_constant_FILTER_LINEAR_MIPMAP_ANISOTROPIC: + +.. _class_VisualShaderNodeTextureParameter_constant_FILTER_MAX: + +enum **TextureFilter**: + +- **FILTER_DEFAULT** = **0** + +- **FILTER_NEAREST** = **1** + +- **FILTER_LINEAR** = **2** + +- **FILTER_NEAREST_MIPMAP** = **3** + +- **FILTER_LINEAR_MIPMAP** = **4** + +- **FILTER_NEAREST_MIPMAP_ANISOTROPIC** = **5** + +- **FILTER_LINEAR_MIPMAP_ANISOTROPIC** = **6** + +- **FILTER_MAX** = **7** --- Represents the size of the :ref:`TextureFilter` enum. + +---- + +.. _enum_VisualShaderNodeTextureParameter_TextureRepeat: + +.. _class_VisualShaderNodeTextureParameter_constant_REPEAT_DEFAULT: + +.. _class_VisualShaderNodeTextureParameter_constant_REPEAT_ENABLED: + +.. _class_VisualShaderNodeTextureParameter_constant_REPEAT_DISABLED: + +.. _class_VisualShaderNodeTextureParameter_constant_REPEAT_MAX: + +enum **TextureRepeat**: + +- **REPEAT_DEFAULT** = **0** + +- **REPEAT_ENABLED** = **1** + +- **REPEAT_DISABLED** = **2** + +- **REPEAT_MAX** = **3** --- Represents the size of the :ref:`TextureRepeat` enum. + +Property Descriptions +--------------------- + +.. _class_VisualShaderNodeTextureParameter_property_color_default: + +- :ref:`ColorDefault` **color_default** + ++-----------+--------------------------+ +| *Default* | ``0`` | ++-----------+--------------------------+ +| *Setter* | set_color_default(value) | ++-----------+--------------------------+ +| *Getter* | get_color_default() | ++-----------+--------------------------+ + +Sets the default color if no texture is assigned to the uniform. + +---- + +.. _class_VisualShaderNodeTextureParameter_property_texture_filter: + +- :ref:`TextureFilter` **texture_filter** + ++-----------+---------------------------+ +| *Default* | ``0`` | ++-----------+---------------------------+ +| *Setter* | set_texture_filter(value) | ++-----------+---------------------------+ +| *Getter* | get_texture_filter() | ++-----------+---------------------------+ + +Sets the texture filtering mode. See :ref:`TextureFilter` for options. + +---- + +.. _class_VisualShaderNodeTextureParameter_property_texture_repeat: + +- :ref:`TextureRepeat` **texture_repeat** + ++-----------+---------------------------+ +| *Default* | ``0`` | ++-----------+---------------------------+ +| *Setter* | set_texture_repeat(value) | ++-----------+---------------------------+ +| *Getter* | get_texture_repeat() | ++-----------+---------------------------+ + +Sets the texture repeating mode. See :ref:`TextureRepeat` for options. + +---- + +.. _class_VisualShaderNodeTextureParameter_property_texture_type: + +- :ref:`TextureType` **texture_type** + ++-----------+-------------------------+ +| *Default* | ``0`` | ++-----------+-------------------------+ +| *Setter* | set_texture_type(value) | ++-----------+-------------------------+ +| *Getter* | get_texture_type() | ++-----------+-------------------------+ + +Defines the type of data provided by the source texture. See :ref:`TextureType` for options. + +.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` +.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` +.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` +.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` +.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` +.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` diff --git a/classes/class_visualshadernodetextureuniformtriplanar.rst b/classes/class_visualshadernodetextureparametertriplanar.rst similarity index 69% rename from classes/class_visualshadernodetextureuniformtriplanar.rst rename to classes/class_visualshadernodetextureparametertriplanar.rst index 894bc586e..e83ff2359 100644 --- a/classes/class_visualshadernodetextureuniformtriplanar.rst +++ b/classes/class_visualshadernodetextureparametertriplanar.rst @@ -3,14 +3,14 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeTextureUniformTriplanar.xml. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeTextureParameterTriplanar.xml. -.. _class_VisualShaderNodeTextureUniformTriplanar: +.. _class_VisualShaderNodeTextureParameterTriplanar: -VisualShaderNodeTextureUniformTriplanar -======================================= +VisualShaderNodeTextureParameterTriplanar +========================================= -**Inherits:** :ref:`VisualShaderNodeTextureUniform` **<** :ref:`VisualShaderNodeUniform` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +**Inherits:** :ref:`VisualShaderNodeTextureParameter` **<** :ref:`VisualShaderNodeParameter` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` Performs a uniform texture lookup with triplanar within the visual shader graph. diff --git a/classes/class_visualshadernodetextureuniform.rst b/classes/class_visualshadernodetextureuniform.rst deleted file mode 100644 index fc676a0a1..000000000 --- a/classes/class_visualshadernodetextureuniform.rst +++ /dev/null @@ -1,216 +0,0 @@ -:github_url: hide - -.. DO NOT EDIT THIS FILE!!! -.. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeTextureUniform.xml. - -.. _class_VisualShaderNodeTextureUniform: - -VisualShaderNodeTextureUniform -============================== - -**Inherits:** :ref:`VisualShaderNodeUniform` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` - -**Inherited By:** :ref:`VisualShaderNodeCubemapUniform`, :ref:`VisualShaderNodeTexture2DArrayUniform`, :ref:`VisualShaderNodeTexture3DUniform`, :ref:`VisualShaderNodeTextureUniformTriplanar` - -Performs a uniform texture lookup within the visual shader graph. - -Description ------------ - -Performs a lookup operation on the texture provided as a uniform for the shader. - -Properties ----------- - -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------+ -| :ref:`ColorDefault` | :ref:`color_default` | ``0`` | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------+ -| :ref:`TextureFilter` | :ref:`texture_filter` | ``0`` | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------+ -| :ref:`TextureRepeat` | :ref:`texture_repeat` | ``0`` | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------+ -| :ref:`TextureType` | :ref:`texture_type` | ``0`` | -+-------------------------------------------------------------------------+-------------------------------------------------------------------------------------+-------+ - -Enumerations ------------- - -.. _enum_VisualShaderNodeTextureUniform_TextureType: - -.. _class_VisualShaderNodeTextureUniform_constant_TYPE_DATA: - -.. _class_VisualShaderNodeTextureUniform_constant_TYPE_COLOR: - -.. _class_VisualShaderNodeTextureUniform_constant_TYPE_NORMAL_MAP: - -.. _class_VisualShaderNodeTextureUniform_constant_TYPE_ANISOTROPY: - -.. _class_VisualShaderNodeTextureUniform_constant_TYPE_MAX: - -enum **TextureType**: - -- **TYPE_DATA** = **0** --- No hints are added to the uniform declaration. - -- **TYPE_COLOR** = **1** --- Adds ``source_color`` as hint to the uniform declaration for proper sRGB to linear conversion. - -- **TYPE_NORMAL_MAP** = **2** --- Adds ``hint_normal`` as hint to the uniform declaration, which internally converts the texture for proper usage as normal map. - -- **TYPE_ANISOTROPY** = **3** --- Adds ``hint_anisotropy`` as hint to the uniform declaration to use for a flowmap. - -- **TYPE_MAX** = **4** --- Represents the size of the :ref:`TextureType` enum. - ----- - -.. _enum_VisualShaderNodeTextureUniform_ColorDefault: - -.. _class_VisualShaderNodeTextureUniform_constant_COLOR_DEFAULT_WHITE: - -.. _class_VisualShaderNodeTextureUniform_constant_COLOR_DEFAULT_BLACK: - -.. _class_VisualShaderNodeTextureUniform_constant_COLOR_DEFAULT_TRANSPARENT: - -.. _class_VisualShaderNodeTextureUniform_constant_COLOR_DEFAULT_MAX: - -enum **ColorDefault**: - -- **COLOR_DEFAULT_WHITE** = **0** --- Defaults to fully opaque white color. - -- **COLOR_DEFAULT_BLACK** = **1** --- Defaults to fully opaque black color. - -- **COLOR_DEFAULT_TRANSPARENT** = **2** --- Defaults to fully transparent black color. - -- **COLOR_DEFAULT_MAX** = **3** --- Represents the size of the :ref:`ColorDefault` enum. - ----- - -.. _enum_VisualShaderNodeTextureUniform_TextureFilter: - -.. _class_VisualShaderNodeTextureUniform_constant_FILTER_DEFAULT: - -.. _class_VisualShaderNodeTextureUniform_constant_FILTER_NEAREST: - -.. _class_VisualShaderNodeTextureUniform_constant_FILTER_LINEAR: - -.. _class_VisualShaderNodeTextureUniform_constant_FILTER_NEAREST_MIPMAP: - -.. _class_VisualShaderNodeTextureUniform_constant_FILTER_LINEAR_MIPMAP: - -.. _class_VisualShaderNodeTextureUniform_constant_FILTER_NEAREST_MIPMAP_ANISOTROPIC: - -.. _class_VisualShaderNodeTextureUniform_constant_FILTER_LINEAR_MIPMAP_ANISOTROPIC: - -.. _class_VisualShaderNodeTextureUniform_constant_FILTER_MAX: - -enum **TextureFilter**: - -- **FILTER_DEFAULT** = **0** - -- **FILTER_NEAREST** = **1** - -- **FILTER_LINEAR** = **2** - -- **FILTER_NEAREST_MIPMAP** = **3** - -- **FILTER_LINEAR_MIPMAP** = **4** - -- **FILTER_NEAREST_MIPMAP_ANISOTROPIC** = **5** - -- **FILTER_LINEAR_MIPMAP_ANISOTROPIC** = **6** - -- **FILTER_MAX** = **7** --- Represents the size of the :ref:`TextureFilter` enum. - ----- - -.. _enum_VisualShaderNodeTextureUniform_TextureRepeat: - -.. _class_VisualShaderNodeTextureUniform_constant_REPEAT_DEFAULT: - -.. _class_VisualShaderNodeTextureUniform_constant_REPEAT_ENABLED: - -.. _class_VisualShaderNodeTextureUniform_constant_REPEAT_DISABLED: - -.. _class_VisualShaderNodeTextureUniform_constant_REPEAT_MAX: - -enum **TextureRepeat**: - -- **REPEAT_DEFAULT** = **0** - -- **REPEAT_ENABLED** = **1** - -- **REPEAT_DISABLED** = **2** - -- **REPEAT_MAX** = **3** --- Represents the size of the :ref:`TextureRepeat` enum. - -Property Descriptions ---------------------- - -.. _class_VisualShaderNodeTextureUniform_property_color_default: - -- :ref:`ColorDefault` **color_default** - -+-----------+--------------------------+ -| *Default* | ``0`` | -+-----------+--------------------------+ -| *Setter* | set_color_default(value) | -+-----------+--------------------------+ -| *Getter* | get_color_default() | -+-----------+--------------------------+ - -Sets the default color if no texture is assigned to the uniform. - ----- - -.. _class_VisualShaderNodeTextureUniform_property_texture_filter: - -- :ref:`TextureFilter` **texture_filter** - -+-----------+---------------------------+ -| *Default* | ``0`` | -+-----------+---------------------------+ -| *Setter* | set_texture_filter(value) | -+-----------+---------------------------+ -| *Getter* | get_texture_filter() | -+-----------+---------------------------+ - -Sets the texture filtering mode. See :ref:`TextureFilter` for options. - ----- - -.. _class_VisualShaderNodeTextureUniform_property_texture_repeat: - -- :ref:`TextureRepeat` **texture_repeat** - -+-----------+---------------------------+ -| *Default* | ``0`` | -+-----------+---------------------------+ -| *Setter* | set_texture_repeat(value) | -+-----------+---------------------------+ -| *Getter* | get_texture_repeat() | -+-----------+---------------------------+ - -Sets the texture repeating mode. See :ref:`TextureRepeat` for options. - ----- - -.. _class_VisualShaderNodeTextureUniform_property_texture_type: - -- :ref:`TextureType` **texture_type** - -+-----------+-------------------------+ -| *Default* | ``0`` | -+-----------+-------------------------+ -| *Setter* | set_texture_type(value) | -+-----------+-------------------------+ -| *Getter* | get_texture_type() | -+-----------+-------------------------+ - -Defines the type of data provided by the source texture. See :ref:`TextureType` for options. - -.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` -.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` -.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` -.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` -.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` -.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` diff --git a/classes/class_visualshadernodetransformuniform.rst b/classes/class_visualshadernodetransformparameter.rst similarity index 69% rename from classes/class_visualshadernodetransformuniform.rst rename to classes/class_visualshadernodetransformparameter.rst index 1460c7e4e..0cb8bb5a8 100644 --- a/classes/class_visualshadernodetransformuniform.rst +++ b/classes/class_visualshadernodetransformparameter.rst @@ -3,16 +3,16 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeTransformUniform.xml. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeTransformParameter.xml. -.. _class_VisualShaderNodeTransformUniform: +.. _class_VisualShaderNodeTransformParameter: -VisualShaderNodeTransformUniform -================================ +VisualShaderNodeTransformParameter +================================== -**Inherits:** :ref:`VisualShaderNodeUniform` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +**Inherits:** :ref:`VisualShaderNodeParameter` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -A :ref:`Transform3D` uniform for use within the visual shader graph. +A :ref:`Transform3D` parameter for use within the visual shader graph. Description ----------- @@ -22,16 +22,16 @@ Translated to ``uniform mat4`` in the shader language. Properties ---------- -+---------------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`Transform3D` | :ref:`default_value` | ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` | -+---------------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------+ -| :ref:`bool` | :ref:`default_value_enabled` | ``false`` | -+---------------------------------------+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------+ ++---------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`Transform3D` | :ref:`default_value` | ``Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)`` | ++---------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------------------------------------+ +| :ref:`bool` | :ref:`default_value_enabled` | ``false`` | ++---------------------------------------+-------------------------------------------------------------------------------------------------------+-----------------------------------------------------+ Property Descriptions --------------------- -.. _class_VisualShaderNodeTransformUniform_property_default_value: +.. _class_VisualShaderNodeTransformParameter_property_default_value: - :ref:`Transform3D` **default_value** @@ -47,7 +47,7 @@ A default value to be assigned within the shader. ---- -.. _class_VisualShaderNodeTransformUniform_property_default_value_enabled: +.. _class_VisualShaderNodeTransformParameter_property_default_value_enabled: - :ref:`bool` **default_value_enabled** @@ -59,7 +59,7 @@ A default value to be assigned within the shader. | *Getter* | is_default_value_enabled() | +-----------+----------------------------------+ -Enables usage of the :ref:`default_value`. +Enables usage of the :ref:`default_value`. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_visualshadernodeuniform.rst b/classes/class_visualshadernodeuniform.rst deleted file mode 100644 index 56dba1806..000000000 --- a/classes/class_visualshadernodeuniform.rst +++ /dev/null @@ -1,92 +0,0 @@ -:github_url: hide - -.. DO NOT EDIT THIS FILE!!! -.. Generated automatically from Godot engine sources. -.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeUniform.xml. - -.. _class_VisualShaderNodeUniform: - -VisualShaderNodeUniform -======================= - -**Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` - -**Inherited By:** :ref:`VisualShaderNodeBooleanUniform`, :ref:`VisualShaderNodeColorUniform`, :ref:`VisualShaderNodeFloatUniform`, :ref:`VisualShaderNodeIntUniform`, :ref:`VisualShaderNodeTextureUniform`, :ref:`VisualShaderNodeTransformUniform`, :ref:`VisualShaderNodeVec2Uniform`, :ref:`VisualShaderNodeVec3Uniform`, :ref:`VisualShaderNodeVec4Uniform` - -A base type for the uniforms within the visual shader graph. - -Description ------------ - -A uniform represents a variable in the shader which is set externally, i.e. from the :ref:`ShaderMaterial`. Uniforms are exposed as properties in the :ref:`ShaderMaterial` and can be assigned from the inspector or from a script. - -Properties ----------- - -+----------------------------------------------------------+--------------------------------------------------------------------------+--------+ -| :ref:`Qualifier` | :ref:`qualifier` | ``0`` | -+----------------------------------------------------------+--------------------------------------------------------------------------+--------+ -| :ref:`String` | :ref:`uniform_name` | ``""`` | -+----------------------------------------------------------+--------------------------------------------------------------------------+--------+ - -Enumerations ------------- - -.. _enum_VisualShaderNodeUniform_Qualifier: - -.. _class_VisualShaderNodeUniform_constant_QUAL_NONE: - -.. _class_VisualShaderNodeUniform_constant_QUAL_GLOBAL: - -.. _class_VisualShaderNodeUniform_constant_QUAL_INSTANCE: - -.. _class_VisualShaderNodeUniform_constant_QUAL_MAX: - -enum **Qualifier**: - -- **QUAL_NONE** = **0** - -- **QUAL_GLOBAL** = **1** - -- **QUAL_INSTANCE** = **2** - -- **QUAL_MAX** = **3** --- Represents the size of the :ref:`Qualifier` enum. - -Property Descriptions ---------------------- - -.. _class_VisualShaderNodeUniform_property_qualifier: - -- :ref:`Qualifier` **qualifier** - -+-----------+----------------------+ -| *Default* | ``0`` | -+-----------+----------------------+ -| *Setter* | set_qualifier(value) | -+-----------+----------------------+ -| *Getter* | get_qualifier() | -+-----------+----------------------+ - ----- - -.. _class_VisualShaderNodeUniform_property_uniform_name: - -- :ref:`String` **uniform_name** - -+-----------+-------------------------+ -| *Default* | ``""`` | -+-----------+-------------------------+ -| *Setter* | set_uniform_name(value) | -+-----------+-------------------------+ -| *Getter* | get_uniform_name() | -+-----------+-------------------------+ - -Name of the uniform, by which it can be accessed through the :ref:`ShaderMaterial` properties. - -.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` -.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` -.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` -.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` -.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` -.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` diff --git a/classes/class_visualshadernodevec2uniform.rst b/classes/class_visualshadernodevec2parameter.rst similarity index 73% rename from classes/class_visualshadernodevec2uniform.rst rename to classes/class_visualshadernodevec2parameter.rst index 2143dd3aa..f4b10ed80 100644 --- a/classes/class_visualshadernodevec2uniform.rst +++ b/classes/class_visualshadernodevec2parameter.rst @@ -3,16 +3,16 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeVec2Uniform.xml. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeVec2Parameter.xml. -.. _class_VisualShaderNodeVec2Uniform: +.. _class_VisualShaderNodeVec2Parameter: -VisualShaderNodeVec2Uniform -=========================== +VisualShaderNodeVec2Parameter +============================= -**Inherits:** :ref:`VisualShaderNodeUniform` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +**Inherits:** :ref:`VisualShaderNodeParameter` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -A :ref:`Vector2` uniform to be used within the visual shader graph. +A :ref:`Vector2` parameter to be used within the visual shader graph. Description ----------- @@ -22,16 +22,16 @@ Translated to ``uniform vec2`` in the shader language. Properties ---------- -+-------------------------------+------------------------------------------------------------------------------------------------+-------------------+ -| :ref:`Vector2` | :ref:`default_value` | ``Vector2(0, 0)`` | -+-------------------------------+------------------------------------------------------------------------------------------------+-------------------+ -| :ref:`bool` | :ref:`default_value_enabled` | ``false`` | -+-------------------------------+------------------------------------------------------------------------------------------------+-------------------+ ++-------------------------------+--------------------------------------------------------------------------------------------------+-------------------+ +| :ref:`Vector2` | :ref:`default_value` | ``Vector2(0, 0)`` | ++-------------------------------+--------------------------------------------------------------------------------------------------+-------------------+ +| :ref:`bool` | :ref:`default_value_enabled` | ``false`` | ++-------------------------------+--------------------------------------------------------------------------------------------------+-------------------+ Property Descriptions --------------------- -.. _class_VisualShaderNodeVec2Uniform_property_default_value: +.. _class_VisualShaderNodeVec2Parameter_property_default_value: - :ref:`Vector2` **default_value** @@ -47,7 +47,7 @@ A default value to be assigned within the shader. ---- -.. _class_VisualShaderNodeVec2Uniform_property_default_value_enabled: +.. _class_VisualShaderNodeVec2Parameter_property_default_value_enabled: - :ref:`bool` **default_value_enabled** @@ -59,7 +59,7 @@ A default value to be assigned within the shader. | *Getter* | is_default_value_enabled() | +-----------+----------------------------------+ -Enables usage of the :ref:`default_value`. +Enables usage of the :ref:`default_value`. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_visualshadernodevec3uniform.rst b/classes/class_visualshadernodevec3parameter.rst similarity index 72% rename from classes/class_visualshadernodevec3uniform.rst rename to classes/class_visualshadernodevec3parameter.rst index bde0f18f7..3a8a910ac 100644 --- a/classes/class_visualshadernodevec3uniform.rst +++ b/classes/class_visualshadernodevec3parameter.rst @@ -3,16 +3,16 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeVec3Uniform.xml. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeVec3Parameter.xml. -.. _class_VisualShaderNodeVec3Uniform: +.. _class_VisualShaderNodeVec3Parameter: -VisualShaderNodeVec3Uniform -=========================== +VisualShaderNodeVec3Parameter +============================= -**Inherits:** :ref:`VisualShaderNodeUniform` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +**Inherits:** :ref:`VisualShaderNodeParameter` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -A :ref:`Vector3` uniform to be used within the visual shader graph. +A :ref:`Vector3` parameter to be used within the visual shader graph. Description ----------- @@ -22,16 +22,16 @@ Translated to ``uniform vec3`` in the shader language. Properties ---------- -+-------------------------------+------------------------------------------------------------------------------------------------+----------------------+ -| :ref:`Vector3` | :ref:`default_value` | ``Vector3(0, 0, 0)`` | -+-------------------------------+------------------------------------------------------------------------------------------------+----------------------+ -| :ref:`bool` | :ref:`default_value_enabled` | ``false`` | -+-------------------------------+------------------------------------------------------------------------------------------------+----------------------+ ++-------------------------------+--------------------------------------------------------------------------------------------------+----------------------+ +| :ref:`Vector3` | :ref:`default_value` | ``Vector3(0, 0, 0)`` | ++-------------------------------+--------------------------------------------------------------------------------------------------+----------------------+ +| :ref:`bool` | :ref:`default_value_enabled` | ``false`` | ++-------------------------------+--------------------------------------------------------------------------------------------------+----------------------+ Property Descriptions --------------------- -.. _class_VisualShaderNodeVec3Uniform_property_default_value: +.. _class_VisualShaderNodeVec3Parameter_property_default_value: - :ref:`Vector3` **default_value** @@ -47,7 +47,7 @@ A default value to be assigned within the shader. ---- -.. _class_VisualShaderNodeVec3Uniform_property_default_value_enabled: +.. _class_VisualShaderNodeVec3Parameter_property_default_value_enabled: - :ref:`bool` **default_value_enabled** @@ -59,7 +59,7 @@ A default value to be assigned within the shader. | *Getter* | is_default_value_enabled() | +-----------+----------------------------------+ -Enables usage of the :ref:`default_value`. +Enables usage of the :ref:`default_value`. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_visualshadernodevec4constant.rst b/classes/class_visualshadernodevec4constant.rst index 0e866b4d1..6d90da95b 100644 --- a/classes/class_visualshadernodevec4constant.rst +++ b/classes/class_visualshadernodevec4constant.rst @@ -12,12 +12,12 @@ VisualShaderNodeVec4Constant **Inherits:** :ref:`VisualShaderNodeConstant` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -A 4D vector (represented as a :ref:`Quaternion`) constant to be used within the visual shader graph. +A 4D vector constant to be used within the visual shader graph. Description ----------- -A constant 4D vector (represented as a :ref:`Quaternion`), which can be used as an input node. +A constant 4D vector, which can be used as an input node. Properties ---------- diff --git a/classes/class_visualshadernodevec4uniform.rst b/classes/class_visualshadernodevec4parameter.rst similarity index 52% rename from classes/class_visualshadernodevec4uniform.rst rename to classes/class_visualshadernodevec4parameter.rst index dcc53d22f..df855930d 100644 --- a/classes/class_visualshadernodevec4uniform.rst +++ b/classes/class_visualshadernodevec4parameter.rst @@ -3,16 +3,16 @@ .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. -.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeVec4Uniform.xml. +.. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeVec4Parameter.xml. -.. _class_VisualShaderNodeVec4Uniform: +.. _class_VisualShaderNodeVec4Parameter: -VisualShaderNodeVec4Uniform -=========================== +VisualShaderNodeVec4Parameter +============================= -**Inherits:** :ref:`VisualShaderNodeUniform` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` +**Inherits:** :ref:`VisualShaderNodeParameter` **<** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -A 4D vector (represented as a :ref:`Quaternion`) uniform to be used within the visual shader graph. +A 4D vector parameter to be used within the visual shader graph. Description ----------- @@ -22,32 +22,32 @@ Translated to ``uniform vec4`` in the shader language. Properties ---------- -+-------------------------------------+------------------------------------------------------------------------------------------------+----------------------------+ -| :ref:`Quaternion` | :ref:`default_value` | ``Quaternion(0, 0, 0, 1)`` | -+-------------------------------------+------------------------------------------------------------------------------------------------+----------------------------+ -| :ref:`bool` | :ref:`default_value_enabled` | ``false`` | -+-------------------------------------+------------------------------------------------------------------------------------------------+----------------------------+ ++-------------------------------+--------------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`Vector4` | :ref:`default_value` | ``Vector4(0, 0, 0, 0)`` | ++-------------------------------+--------------------------------------------------------------------------------------------------+-------------------------+ +| :ref:`bool` | :ref:`default_value_enabled` | ``false`` | ++-------------------------------+--------------------------------------------------------------------------------------------------+-------------------------+ Property Descriptions --------------------- -.. _class_VisualShaderNodeVec4Uniform_property_default_value: +.. _class_VisualShaderNodeVec4Parameter_property_default_value: -- :ref:`Quaternion` **default_value** +- :ref:`Vector4` **default_value** -+-----------+----------------------------+ -| *Default* | ``Quaternion(0, 0, 0, 1)`` | -+-----------+----------------------------+ -| *Setter* | set_default_value(value) | -+-----------+----------------------------+ -| *Getter* | get_default_value() | -+-----------+----------------------------+ ++-----------+--------------------------+ +| *Default* | ``Vector4(0, 0, 0, 0)`` | ++-----------+--------------------------+ +| *Setter* | set_default_value(value) | ++-----------+--------------------------+ +| *Getter* | get_default_value() | ++-----------+--------------------------+ A default value to be assigned within the shader. ---- -.. _class_VisualShaderNodeVec4Uniform_property_default_value_enabled: +.. _class_VisualShaderNodeVec4Parameter_property_default_value_enabled: - :ref:`bool` **default_value_enabled** @@ -59,7 +59,7 @@ A default value to be assigned within the shader. | *Getter* | is_default_value_enabled() | +-----------+----------------------------------+ -Enables usage of the :ref:`default_value`. +Enables usage of the :ref:`default_value`. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_voxelgi.rst b/classes/class_voxelgi.rst index 76ef30a14..899d420ef 100644 --- a/classes/class_voxelgi.rst +++ b/classes/class_voxelgi.rst @@ -35,13 +35,15 @@ Tutorials Properties ---------- -+---------------------------------------+------------------------------------------------+-------------------------+ -| :ref:`VoxelGIData` | :ref:`data` | | -+---------------------------------------+------------------------------------------------+-------------------------+ -| :ref:`Vector3` | :ref:`extents` | ``Vector3(10, 10, 10)`` | -+---------------------------------------+------------------------------------------------+-------------------------+ -| :ref:`Subdiv` | :ref:`subdiv` | ``1`` | -+---------------------------------------+------------------------------------------------+-------------------------+ ++-------------------------------------------------+--------------------------------------------------------------------+-------------------------+ +| :ref:`CameraAttributes` | :ref:`camera_attributes` | | ++-------------------------------------------------+--------------------------------------------------------------------+-------------------------+ +| :ref:`VoxelGIData` | :ref:`data` | | ++-------------------------------------------------+--------------------------------------------------------------------+-------------------------+ +| :ref:`Vector3` | :ref:`extents` | ``Vector3(10, 10, 10)`` | ++-------------------------------------------------+--------------------------------------------------------------------+-------------------------+ +| :ref:`Subdiv` | :ref:`subdiv` | ``1`` | ++-------------------------------------------------+--------------------------------------------------------------------+-------------------------+ Methods ------- @@ -82,6 +84,20 @@ enum **Subdiv**: Property Descriptions --------------------- +.. _class_VoxelGI_property_camera_attributes: + +- :ref:`CameraAttributes` **camera_attributes** + ++----------+------------------------------+ +| *Setter* | set_camera_attributes(value) | ++----------+------------------------------+ +| *Getter* | get_camera_attributes() | ++----------+------------------------------+ + +The :ref:`CameraAttributes` resource that specifies exposure levels to bake at. Auto-exposure and non exposure properties will be ignored. Exposure settings should be used to reduce the dynamic range present when baking. If exposure is too high, the ``VoxelGI`` will have banding artifacts or may have over-exposure artifacts. + +---- + .. _class_VoxelGI_property_data: - :ref:`VoxelGIData` **data** diff --git a/classes/class_vsplitcontainer.rst b/classes/class_vsplitcontainer.rst index d7464ab0d..a9e05591a 100644 --- a/classes/class_vsplitcontainer.rst +++ b/classes/class_vsplitcontainer.rst @@ -27,13 +27,15 @@ Tutorials Theme Properties ---------------- -+-----------------------------------+--------------------------------------------------------------------+--------+ -| :ref:`int` | :ref:`autohide` | ``1`` | -+-----------------------------------+--------------------------------------------------------------------+--------+ -| :ref:`int` | :ref:`separation` | ``12`` | -+-----------------------------------+--------------------------------------------------------------------+--------+ -| :ref:`Texture2D` | :ref:`grabber` | | -+-----------------------------------+--------------------------------------------------------------------+--------+ ++-----------------------------------+--------------------------------------------------------------------------------------------+--------+ +| :ref:`int` | :ref:`autohide` | ``1`` | ++-----------------------------------+--------------------------------------------------------------------------------------------+--------+ +| :ref:`int` | :ref:`minimum_grab_thickness` | ``6`` | ++-----------------------------------+--------------------------------------------------------------------------------------------+--------+ +| :ref:`int` | :ref:`separation` | ``12`` | ++-----------------------------------+--------------------------------------------------------------------------------------------+--------+ +| :ref:`Texture2D` | :ref:`grabber` | | ++-----------------------------------+--------------------------------------------------------------------------------------------+--------+ Theme Property Descriptions --------------------------- @@ -50,6 +52,18 @@ Boolean value. If 1 (``true``), the grabber will hide automatically when it isn' ---- +.. _class_VSplitContainer_theme_constant_minimum_grab_thickness: + +- :ref:`int` **minimum_grab_thickness** + ++-----------+-------+ +| *Default* | ``6`` | ++-----------+-------+ + +The minimum thickness of the area users can click on to grab the splitting line. If :ref:`separation` or :ref:`grabber`'s thickness are too small, this ensure that the splitting line can still be dragged. + +---- + .. _class_VSplitContainer_theme_constant_separation: - :ref:`int` **separation** diff --git a/classes/class_webrtcdatachannelextension.rst b/classes/class_webrtcdatachannelextension.rst index 79a0abe39..9fd441425 100644 --- a/classes/class_webrtcdatachannelextension.rst +++ b/classes/class_webrtcdatachannelextension.rst @@ -17,43 +17,43 @@ WebRTCDataChannelExtension Methods ------- -+-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_close` **(** **)** |virtual| | -+-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_available_packet_count` **(** **)** |virtual| |const| | -+-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_buffered_amount` **(** **)** |virtual| |const| | -+-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_id` **(** **)** |virtual| |const| | -+-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_label` **(** **)** |virtual| |const| | -+-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_max_packet_life_time` **(** **)** |virtual| |const| | -+-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_max_packet_size` **(** **)** |virtual| |const| | -+-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_max_retransmits` **(** **)** |virtual| |const| | -+-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_packet` **(** const uint8_t ** r_buffer, int32_t* r_buffer_size **)** |virtual| | -+-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`String` | :ref:`_get_protocol` **(** **)** |virtual| |const| | -+-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_ready_state` **(** **)** |virtual| |const| | -+-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_write_mode` **(** **)** |virtual| |const| | -+-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`_is_negotiated` **(** **)** |virtual| |const| | -+-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`_is_ordered` **(** **)** |virtual| |const| | -+-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_poll` **(** **)** |virtual| | -+-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_put_packet` **(** const uint8_t* p_buffer, :ref:`int` p_buffer_size **)** |virtual| | -+-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_set_write_mode` **(** :ref:`int` p_write_mode **)** |virtual| | -+-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`_was_string_packet` **(** **)** |virtual| |const| | -+-----------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_close` **(** **)** |virtual| | ++----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_available_packet_count` **(** **)** |virtual| |const| | ++----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_buffered_amount` **(** **)** |virtual| |const| | ++----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_id` **(** **)** |virtual| |const| | ++----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_get_label` **(** **)** |virtual| |const| | ++----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_max_packet_life_time` **(** **)** |virtual| |const| | ++----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_max_packet_size` **(** **)** |virtual| |const| | ++----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`int` | :ref:`_get_max_retransmits` **(** **)** |virtual| |const| | ++----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`_get_packet` **(** const uint8_t ** r_buffer, int32_t* r_buffer_size **)** |virtual| | ++----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`String` | :ref:`_get_protocol` **(** **)** |virtual| |const| | ++----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ChannelState` | :ref:`_get_ready_state` **(** **)** |virtual| |const| | ++----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`WriteMode` | :ref:`_get_write_mode` **(** **)** |virtual| |const| | ++----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`_is_negotiated` **(** **)** |virtual| |const| | ++----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`_is_ordered` **(** **)** |virtual| |const| | ++----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`_poll` **(** **)** |virtual| | ++----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`_put_packet` **(** const uint8_t* p_buffer, :ref:`int` p_buffer_size **)** |virtual| | ++----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_set_write_mode` **(** :ref:`WriteMode` p_write_mode **)** |virtual| | ++----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`bool` | :ref:`_was_string_packet` **(** **)** |virtual| |const| | ++----------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- @@ -108,7 +108,7 @@ Method Descriptions .. _class_WebRTCDataChannelExtension_method__get_packet: -- :ref:`int` **_get_packet** **(** const uint8_t ** r_buffer, int32_t* r_buffer_size **)** |virtual| +- :ref:`Error` **_get_packet** **(** const uint8_t ** r_buffer, int32_t* r_buffer_size **)** |virtual| ---- @@ -120,13 +120,13 @@ Method Descriptions .. _class_WebRTCDataChannelExtension_method__get_ready_state: -- :ref:`int` **_get_ready_state** **(** **)** |virtual| |const| +- :ref:`ChannelState` **_get_ready_state** **(** **)** |virtual| |const| ---- .. _class_WebRTCDataChannelExtension_method__get_write_mode: -- :ref:`int` **_get_write_mode** **(** **)** |virtual| |const| +- :ref:`WriteMode` **_get_write_mode** **(** **)** |virtual| |const| ---- @@ -144,19 +144,19 @@ Method Descriptions .. _class_WebRTCDataChannelExtension_method__poll: -- :ref:`int` **_poll** **(** **)** |virtual| +- :ref:`Error` **_poll** **(** **)** |virtual| ---- .. _class_WebRTCDataChannelExtension_method__put_packet: -- :ref:`int` **_put_packet** **(** const uint8_t* p_buffer, :ref:`int` p_buffer_size **)** |virtual| +- :ref:`Error` **_put_packet** **(** const uint8_t* p_buffer, :ref:`int` p_buffer_size **)** |virtual| ---- .. _class_WebRTCDataChannelExtension_method__set_write_mode: -- void **_set_write_mode** **(** :ref:`int` p_write_mode **)** |virtual| +- void **_set_write_mode** **(** :ref:`WriteMode` p_write_mode **)** |virtual| ---- diff --git a/classes/class_webrtcpeerconnectionextension.rst b/classes/class_webrtcpeerconnectionextension.rst index 4e1abd218..3ec4df786 100644 --- a/classes/class_webrtcpeerconnectionextension.rst +++ b/classes/class_webrtcpeerconnectionextension.rst @@ -17,32 +17,32 @@ WebRTCPeerConnectionExtension Methods ------- -+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_add_ice_candidate` **(** :ref:`String` p_sdp_mid_name, :ref:`int` p_sdp_mline_index, :ref:`String` p_sdp_name **)** |virtual| | -+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| void | :ref:`_close` **(** **)** |virtual| | -+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`Object` | :ref:`_create_data_channel` **(** :ref:`String` p_label, :ref:`Dictionary` p_config **)** |virtual| | -+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_create_offer` **(** **)** |virtual| | -+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_get_connection_state` **(** **)** |virtual| |const| | -+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_initialize` **(** :ref:`Dictionary` p_config **)** |virtual| | -+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_poll` **(** **)** |virtual| | -+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_set_local_description` **(** :ref:`String` p_type, :ref:`String` p_sdp **)** |virtual| | -+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| :ref:`int` | :ref:`_set_remote_description` **(** :ref:`String` p_type, :ref:`String` p_sdp **)** |virtual| | -+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`_add_ice_candidate` **(** :ref:`String` p_sdp_mid_name, :ref:`int` p_sdp_mline_index, :ref:`String` p_sdp_name **)** |virtual| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| void | :ref:`_close` **(** **)** |virtual| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Object` | :ref:`_create_data_channel` **(** :ref:`String` p_label, :ref:`Dictionary` p_config **)** |virtual| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`_create_offer` **(** **)** |virtual| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`ConnectionState` | :ref:`_get_connection_state` **(** **)** |virtual| |const| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`_initialize` **(** :ref:`Dictionary` p_config **)** |virtual| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`_poll` **(** **)** |virtual| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`_set_local_description` **(** :ref:`String` p_type, :ref:`String` p_sdp **)** |virtual| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| :ref:`Error` | :ref:`_set_remote_description` **(** :ref:`String` p_type, :ref:`String` p_sdp **)** |virtual| | ++-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Method Descriptions ------------------- .. _class_WebRTCPeerConnectionExtension_method__add_ice_candidate: -- :ref:`int` **_add_ice_candidate** **(** :ref:`String` p_sdp_mid_name, :ref:`int` p_sdp_mline_index, :ref:`String` p_sdp_name **)** |virtual| +- :ref:`Error` **_add_ice_candidate** **(** :ref:`String` p_sdp_mid_name, :ref:`int` p_sdp_mline_index, :ref:`String` p_sdp_name **)** |virtual| ---- @@ -60,37 +60,37 @@ Method Descriptions .. _class_WebRTCPeerConnectionExtension_method__create_offer: -- :ref:`int` **_create_offer** **(** **)** |virtual| +- :ref:`Error` **_create_offer** **(** **)** |virtual| ---- .. _class_WebRTCPeerConnectionExtension_method__get_connection_state: -- :ref:`int` **_get_connection_state** **(** **)** |virtual| |const| +- :ref:`ConnectionState` **_get_connection_state** **(** **)** |virtual| |const| ---- .. _class_WebRTCPeerConnectionExtension_method__initialize: -- :ref:`int` **_initialize** **(** :ref:`Dictionary` p_config **)** |virtual| +- :ref:`Error` **_initialize** **(** :ref:`Dictionary` p_config **)** |virtual| ---- .. _class_WebRTCPeerConnectionExtension_method__poll: -- :ref:`int` **_poll** **(** **)** |virtual| +- :ref:`Error` **_poll** **(** **)** |virtual| ---- .. _class_WebRTCPeerConnectionExtension_method__set_local_description: -- :ref:`int` **_set_local_description** **(** :ref:`String` p_type, :ref:`String` p_sdp **)** |virtual| +- :ref:`Error` **_set_local_description** **(** :ref:`String` p_type, :ref:`String` p_sdp **)** |virtual| ---- .. _class_WebRTCPeerConnectionExtension_method__set_remote_description: -- :ref:`int` **_set_remote_description** **(** :ref:`String` p_type, :ref:`String` p_sdp **)** |virtual| +- :ref:`Error` **_set_remote_description** **(** :ref:`String` p_type, :ref:`String` p_sdp **)** |virtual| .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` diff --git a/classes/class_websocketclient.rst b/classes/class_websocketclient.rst index 9732b5421..fe4789aa1 100644 --- a/classes/class_websocketclient.rst +++ b/classes/class_websocketclient.rst @@ -31,9 +31,9 @@ Properties ---------- +-----------------------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`X509Certificate` | :ref:`trusted_ssl_certificate` | +| :ref:`X509Certificate` | :ref:`trusted_tls_certificate` | +-----------------------------------------------+----------------------------------------------------------------------------------------+ -| :ref:`bool` | :ref:`verify_ssl` | +| :ref:`bool` | :ref:`verify_tls` | +-----------------------------------------------+----------------------------------------------------------------------------------------+ Methods @@ -95,33 +95,33 @@ Emitted when the server requests a clean close. You should keep polling until yo Property Descriptions --------------------- -.. _class_WebSocketClient_property_trusted_ssl_certificate: +.. _class_WebSocketClient_property_trusted_tls_certificate: -- :ref:`X509Certificate` **trusted_ssl_certificate** +- :ref:`X509Certificate` **trusted_tls_certificate** +----------+------------------------------------+ -| *Setter* | set_trusted_ssl_certificate(value) | +| *Setter* | set_trusted_tls_certificate(value) | +----------+------------------------------------+ -| *Getter* | get_trusted_ssl_certificate() | +| *Getter* | get_trusted_tls_certificate() | +----------+------------------------------------+ -If specified, this :ref:`X509Certificate` will be the only one accepted when connecting to an SSL host. Any other certificate provided by the server will be regarded as invalid. +If specified, this :ref:`X509Certificate` will be the only one accepted when connecting to an TLS host. Any other certificate provided by the server will be regarded as invalid. -\ **Note:** Specifying a custom ``trusted_ssl_certificate`` is not supported in Web exports due to browsers restrictions. +\ **Note:** Specifying a custom ``trusted_tls_certificate`` is not supported in Web exports due to browsers' restrictions. ---- -.. _class_WebSocketClient_property_verify_ssl: +.. _class_WebSocketClient_property_verify_tls: -- :ref:`bool` **verify_ssl** +- :ref:`bool` **verify_tls** +----------+-------------------------------+ -| *Setter* | set_verify_ssl_enabled(value) | +| *Setter* | set_verify_tls_enabled(value) | +----------+-------------------------------+ -| *Getter* | is_verify_ssl_enabled() | +| *Getter* | is_verify_tls_enabled() | +----------+-------------------------------+ -If ``true``, SSL certificate verification is enabled. +If ``true``, TLS certificate verification is enabled. \ **Note:** You must specify the certificates to be used in the Project Settings for it to work when exported. @@ -140,9 +140,9 @@ If ``false`` is passed instead (default), you must call :ref:`PacketPeer` | :ref:`private_key` | | +-----------------------------------------------+----------------------------------------------------------------------------+---------+ -| :ref:`X509Certificate` | :ref:`ssl_certificate` | | +| :ref:`X509Certificate` | :ref:`tls_certificate` | | +-----------------------------------------------+----------------------------------------------------------------------------+---------+ Methods @@ -127,7 +127,7 @@ When not set to ``*`` will restrict incoming connections to the specified IP add | *Getter* | get_ca_chain() | +----------+---------------------+ -When using SSL (see :ref:`private_key` and :ref:`ssl_certificate`), you can set this to a valid :ref:`X509Certificate` to be provided as additional CA chain information during the SSL handshake. +When using TLS (see :ref:`private_key` and :ref:`tls_certificate`), you can set this to a valid :ref:`X509Certificate` to be provided as additional CA chain information during the TLS handshake. ---- @@ -157,21 +157,21 @@ The time in seconds before a pending client (i.e. a client that has not yet fini | *Getter* | get_private_key() | +----------+------------------------+ -When set to a valid :ref:`CryptoKey` (along with :ref:`ssl_certificate`) will cause the server to require SSL instead of regular TCP (i.e. the ``wss://`` protocol). +When set to a valid :ref:`CryptoKey` (along with :ref:`tls_certificate`) will cause the server to require TLS instead of regular TCP (i.e. the ``wss://`` protocol). ---- -.. _class_WebSocketServer_property_ssl_certificate: +.. _class_WebSocketServer_property_tls_certificate: -- :ref:`X509Certificate` **ssl_certificate** +- :ref:`X509Certificate` **tls_certificate** +----------+----------------------------+ -| *Setter* | set_ssl_certificate(value) | +| *Setter* | set_tls_certificate(value) | +----------+----------------------------+ -| *Getter* | get_ssl_certificate() | +| *Getter* | get_tls_certificate() | +----------+----------------------------+ -When set to a valid :ref:`X509Certificate` (along with :ref:`private_key`) will cause the server to require SSL instead of regular TCP (i.e. the ``wss://`` protocol). +When set to a valid :ref:`X509Certificate` (along with :ref:`private_key`) will cause the server to require TLS instead of regular TCP (i.e. the ``wss://`` protocol). Method Descriptions ------------------- diff --git a/classes/class_world3d.rst b/classes/class_world3d.rst index 7ce42f49e..4235572cb 100644 --- a/classes/class_world3d.rst +++ b/classes/class_world3d.rst @@ -28,7 +28,7 @@ Properties ---------- +-------------------------------------------------------------------+--------------------------------------------------------------------------+ -| :ref:`CameraEffects` | :ref:`camera_effects` | +| :ref:`CameraAttributes` | :ref:`camera_attributes` | +-------------------------------------------------------------------+--------------------------------------------------------------------------+ | :ref:`PhysicsDirectSpaceState3D` | :ref:`direct_space_state` | +-------------------------------------------------------------------+--------------------------------------------------------------------------+ @@ -46,15 +46,17 @@ Properties Property Descriptions --------------------- -.. _class_World3D_property_camera_effects: +.. _class_World3D_property_camera_attributes: -- :ref:`CameraEffects` **camera_effects** +- :ref:`CameraAttributes` **camera_attributes** -+----------+---------------------------+ -| *Setter* | set_camera_effects(value) | -+----------+---------------------------+ -| *Getter* | get_camera_effects() | -+----------+---------------------------+ ++----------+------------------------------+ +| *Setter* | set_camera_attributes(value) | ++----------+------------------------------+ +| *Getter* | get_camera_attributes() | ++----------+------------------------------+ + +The default :ref:`CameraAttributes` resource to use if none set on the :ref:`Camera3D`. ---- diff --git a/classes/class_worldenvironment.rst b/classes/class_worldenvironment.rst index f0deddd00..7e9b535a7 100644 --- a/classes/class_worldenvironment.rst +++ b/classes/class_worldenvironment.rst @@ -37,26 +37,26 @@ Tutorials Properties ---------- -+-------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`CameraEffects` | :ref:`camera_effects` | -+-------------------------------------------+-----------------------------------------------------------------------+ -| :ref:`Environment` | :ref:`environment` | -+-------------------------------------------+-----------------------------------------------------------------------+ ++-------------------------------------------------+-----------------------------------------------------------------------------+ +| :ref:`CameraAttributes` | :ref:`camera_attributes` | ++-------------------------------------------------+-----------------------------------------------------------------------------+ +| :ref:`Environment` | :ref:`environment` | ++-------------------------------------------------+-----------------------------------------------------------------------------+ Property Descriptions --------------------- -.. _class_WorldEnvironment_property_camera_effects: +.. _class_WorldEnvironment_property_camera_attributes: -- :ref:`CameraEffects` **camera_effects** +- :ref:`CameraAttributes` **camera_attributes** -+----------+---------------------------+ -| *Setter* | set_camera_effects(value) | -+----------+---------------------------+ -| *Getter* | get_camera_effects() | -+----------+---------------------------+ ++----------+------------------------------+ +| *Setter* | set_camera_attributes(value) | ++----------+------------------------------+ +| *Getter* | get_camera_attributes() | ++----------+------------------------------+ -The :ref:`CameraEffects` resource used by this ``WorldEnvironment``, defining the default properties. This :ref:`CameraEffects` resource will be used by all :ref:`Camera3D`\ s that do not define their own :ref:`CameraEffects`. +The default :ref:`CameraAttributes` resource to use if none set on the :ref:`Camera3D`. ---- diff --git a/classes/class_x509certificate.rst b/classes/class_x509certificate.rst index 5745c5dc0..12952ed7f 100644 --- a/classes/class_x509certificate.rst +++ b/classes/class_x509certificate.rst @@ -12,14 +12,14 @@ X509Certificate **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` -An X509 certificate (e.g. for SSL). +An X509 certificate (e.g. for TLS). Description ----------- The X509Certificate class represents an X509 certificate. Certificates can be loaded and saved like any other :ref:`Resource`. -They can be used as the server certificate in :ref:`StreamPeerSSL.accept_stream` (along with the proper :ref:`CryptoKey`), and to specify the only certificate that should be accepted when connecting to an SSL server via :ref:`StreamPeerSSL.connect_to_stream`. +They can be used as the server certificate in :ref:`StreamPeerTLS.accept_stream` (along with the proper :ref:`CryptoKey`), and to specify the only certificate that should be accepted when connecting to an TLS server via :ref:`StreamPeerTLS.connect_to_stream`. Methods -------