godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-05 22:09:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Order everything alphabetically

Browse Source 
And sync with current 2.0.x sources.
This commit is contained in:
Rémi Verschelde
2016-06-25 02:10:54 +02:00
parent 66c919aa43
commit 1b5e8c18fd
294 changed files with 20019 additions and 19071 deletions
Download Patch File Download Diff File Expand all files Collapse all files

608
classes/class_@gdscript.rst
View File

@@ -17,140 +17,140 @@ Member Functions
----------------
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`sin<class_@GDScript_sin>` **(** :ref:`float<class_float>` s **)** |
| :ref:`Color<class_color>` | :ref:`Color8<class_@GDScript_Color8>` **(** :ref:`int<class_int>` r8, :ref:`int<class_int>` g8, :ref:`int<class_int>` b8, :ref:`int<class_int>` a8 **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`cos<class_@GDScript_cos>` **(** :ref:`float<class_float>` s **)** |
| :ref:`float<class_float>` | :ref:`abs<class_@GDScript_abs>` **(** :ref:`float<class_float>` s **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`tan<class_@GDScript_tan>` **(** :ref:`float<class_float>` s **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`sinh<class_@GDScript_sinh>` **(** :ref:`float<class_float>` s **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`cosh<class_@GDScript_cosh>` **(** :ref:`float<class_float>` s **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`tanh<class_@GDScript_tanh>` **(** :ref:`float<class_float>` s **)** |
| :ref:`float<class_float>` | :ref:`acos<class_@GDScript_acos>` **(** :ref:`float<class_float>` s **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`asin<class_@GDScript_asin>` **(** :ref:`float<class_float>` s **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`acos<class_@GDScript_acos>` **(** :ref:`float<class_float>` s **)** |
| :ref:`Nil<class_nil>` | :ref:`assert<class_@GDScript_assert>` **(** :ref:`bool<class_bool>` condition **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`atan<class_@GDScript_atan>` **(** :ref:`float<class_float>` s **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`atan2<class_@GDScript_atan2>` **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`sqrt<class_@GDScript_sqrt>` **(** :ref:`float<class_float>` s **)** |
| Variant | :ref:`bytes2var<class_@GDScript_bytes2var>` **(** :ref:`RawArray<class_rawarray>` bytes **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`ceil<class_@GDScript_ceil>` **(** :ref:`float<class_float>` s **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`clamp<class_@GDScript_clamp>` **(** :ref:`float<class_float>` val, :ref:`float<class_float>` min, :ref:`float<class_float>` max **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>` | :ref:`convert<class_@GDScript_convert>` **(** Variant what, :ref:`int<class_int>` type **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`cos<class_@GDScript_cos>` **(** :ref:`float<class_float>` s **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`cosh<class_@GDScript_cosh>` **(** :ref:`float<class_float>` s **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`db2linear<class_@GDScript_db2linear>` **(** :ref:`float<class_float>` db **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`decimals<class_@GDScript_decimals>` **(** :ref:`float<class_float>` step **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`dectime<class_@GDScript_dectime>` **(** :ref:`float<class_float>` value, :ref:`float<class_float>` amount, :ref:`float<class_float>` step **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`deg2rad<class_@GDScript_deg2rad>` **(** :ref:`float<class_float>` deg **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>` | :ref:`dict2inst<class_@GDScript_dict2inst>` **(** :ref:`Dictionary<class_dictionary>` dict **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`ease<class_@GDScript_ease>` **(** :ref:`float<class_float>` s, :ref:`float<class_float>` curve **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`exp<class_@GDScript_exp>` **(** :ref:`float<class_float>` s **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`floor<class_@GDScript_floor>` **(** :ref:`float<class_float>` s **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`fmod<class_@GDScript_fmod>` **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`fposmod<class_@GDScript_fposmod>` **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`floor<class_@GDScript_floor>` **(** :ref:`float<class_float>` s **)** |
| :ref:`FuncRef<class_funcref>` | :ref:`funcref<class_@GDScript_funcref>` **(** :ref:`Object<class_object>` instance, :ref:`String<class_string>` funcname **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`ceil<class_@GDScript_ceil>` **(** :ref:`float<class_float>` s **)** |
| :ref:`int<class_int>` | :ref:`hash<class_@GDScript_hash>` **(** Variant var:Variant **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`round<class_@GDScript_round>` **(** :ref:`float<class_float>` s **)** |
| :ref:`Dictionary<class_dictionary>` | :ref:`inst2dict<class_@GDScript_inst2dict>` **(** :ref:`Object<class_object>` inst **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`abs<class_@GDScript_abs>` **(** :ref:`float<class_float>` s **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`sign<class_@GDScript_sign>` **(** :ref:`float<class_float>` s **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`pow<class_@GDScript_pow>` **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`log<class_@GDScript_log>` **(** :ref:`float<class_float>` s **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`exp<class_@GDScript_exp>` **(** :ref:`float<class_float>` s **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`is_nan<class_@GDScript_is_nan>` **(** :ref:`float<class_float>` s **)** |
| :ref:`Object<class_object>` | :ref:`instance_from_id<class_@GDScript_instance_from_id>` **(** :ref:`int<class_int>` instance_id **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`is_inf<class_@GDScript_is_inf>` **(** :ref:`float<class_float>` s **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`ease<class_@GDScript_ease>` **(** :ref:`float<class_float>` s, :ref:`float<class_float>` curve **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`decimals<class_@GDScript_decimals>` **(** :ref:`float<class_float>` step **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`stepify<class_@GDScript_stepify>` **(** :ref:`float<class_float>` s, :ref:`float<class_float>` step **)** |
| :ref:`float<class_float>` | :ref:`is_nan<class_@GDScript_is_nan>` **(** :ref:`float<class_float>` s **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`lerp<class_@GDScript_lerp>` **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to, :ref:`float<class_float>` weight **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`dectime<class_@GDScript_dectime>` **(** :ref:`float<class_float>` value, :ref:`float<class_float>` amount, :ref:`float<class_float>` step **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Nil<class_nil>` | :ref:`randomize<class_@GDScript_randomize>` **(** **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`randi<class_@GDScript_randi>` **(** **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`randf<class_@GDScript_randf>` **(** **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`rand_range<class_@GDScript_rand_range>` **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Nil<class_nil>` | :ref:`seed<class_@GDScript_seed>` **(** :ref:`float<class_float>` seed **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`rand_seed<class_@GDScript_rand_seed>` **(** :ref:`float<class_float>` seed **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`deg2rad<class_@GDScript_deg2rad>` **(** :ref:`float<class_float>` deg **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`rad2deg<class_@GDScript_rad2deg>` **(** :ref:`float<class_float>` rad **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`linear2db<class_@GDScript_linear2db>` **(** :ref:`float<class_float>` nrg **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`db2linear<class_@GDScript_db2linear>` **(** :ref:`float<class_float>` db **)** |
| :ref:`Resource<class_resource>` | :ref:`load<class_@GDScript_load>` **(** :ref:`String<class_string>` path **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`log<class_@GDScript_log>` **(** :ref:`float<class_float>` s **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`max<class_@GDScript_max>` **(** :ref:`float<class_float>` a, :ref:`float<class_float>` b **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`min<class_@GDScript_min>` **(** :ref:`float<class_float>` a, :ref:`float<class_float>` b **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`clamp<class_@GDScript_clamp>` **(** :ref:`float<class_float>` val, :ref:`float<class_float>` min, :ref:`float<class_float>` max **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`nearest_po2<class_@GDScript_nearest_po2>` **(** :ref:`int<class_int>` val **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`WeakRef<class_weakref>` | :ref:`weakref<class_@GDScript_weakref>` **(** :ref:`Object<class_object>` obj **)** |
| :ref:`float<class_float>` | :ref:`pow<class_@GDScript_pow>` **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`FuncRef<class_funcref>` | :ref:`funcref<class_@GDScript_funcref>` **(** :ref:`Object<class_object>` instance, :ref:`String<class_string>` funcname **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>` | :ref:`convert<class_@GDScript_convert>` **(** Variant what, :ref:`int<class_int>` type **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`typeof<class_@GDScript_typeof>` **(** Variant what **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`str<class_@GDScript_str>` **(** Variant what, Variant ... **)** |
| :ref:`Resource<class_resource>` | :ref:`preload<class_@GDScript_preload>` **(** :ref:`String<class_string>` path **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Nil<class_nil>` | :ref:`print<class_@GDScript_print>` **(** Variant what, Variant ... **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Nil<class_nil>` | :ref:`printt<class_@GDScript_printt>` **(** Variant what, Variant ... **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Nil<class_nil>` | :ref:`prints<class_@GDScript_prints>` **(** Variant what, Variant ... **)** |
| :ref:`Nil<class_nil>` | :ref:`print_stack<class_@GDScript_print_stack>` **(** **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Nil<class_nil>` | :ref:`printerr<class_@GDScript_printerr>` **(** Variant what, Variant ... **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Nil<class_nil>` | :ref:`printraw<class_@GDScript_printraw>` **(** Variant what, Variant ... **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`var2str<class_@GDScript_var2str>` **(** Variant var **)** |
| :ref:`Nil<class_nil>` | :ref:`prints<class_@GDScript_prints>` **(** Variant what, Variant ... **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Variant | :ref:`str2var<class_@GDScript_str2var>` **(** :ref:`String<class_string>` string **)** |
| :ref:`Nil<class_nil>` | :ref:`printt<class_@GDScript_printt>` **(** Variant what, Variant ... **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RawArray<class_rawarray>` | :ref:`var2bytes<class_@GDScript_var2bytes>` **(** Variant var **)** |
| :ref:`float<class_float>` | :ref:`rad2deg<class_@GDScript_rad2deg>` **(** :ref:`float<class_float>` rad **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Variant | :ref:`bytes2var<class_@GDScript_bytes2var>` **(** :ref:`RawArray<class_rawarray>` bytes **)** |
| :ref:`float<class_float>` | :ref:`rand_range<class_@GDScript_rand_range>` **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`rand_seed<class_@GDScript_rand_seed>` **(** :ref:`float<class_float>` seed **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`randf<class_@GDScript_randf>` **(** **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`randi<class_@GDScript_randi>` **(** **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Nil<class_nil>` | :ref:`randomize<class_@GDScript_randomize>` **(** **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`range<class_@GDScript_range>` **(** Variant ... **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Resource<class_resource>` | :ref:`load<class_@GDScript_load>` **(** :ref:`String<class_string>` path **)** |
| :ref:`float<class_float>` | :ref:`round<class_@GDScript_round>` **(** :ref:`float<class_float>` s **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_dictionary>` | :ref:`inst2dict<class_@GDScript_inst2dict>` **(** :ref:`Object<class_object>` inst **)** |
| :ref:`Nil<class_nil>` | :ref:`seed<class_@GDScript_seed>` **(** :ref:`float<class_float>` seed **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>` | :ref:`dict2inst<class_@GDScript_dict2inst>` **(** :ref:`Dictionary<class_dictionary>` dict **)** |
| :ref:`float<class_float>` | :ref:`sign<class_@GDScript_sign>` **(** :ref:`float<class_float>` s **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`hash<class_@GDScript_hash>` **(** Variant var:Variant **)** |
| :ref:`float<class_float>` | :ref:`sin<class_@GDScript_sin>` **(** :ref:`float<class_float>` s **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`Color8<class_@GDScript_Color8>` **(** :ref:`int<class_int>` r8, :ref:`int<class_int>` g8, :ref:`int<class_int>` b8, :ref:`int<class_int>` a8 **)** |
| :ref:`float<class_float>` | :ref:`sinh<class_@GDScript_sinh>` **(** :ref:`float<class_float>` s **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Nil<class_nil>` | :ref:`print_stack<class_@GDScript_print_stack>` **(** **)** |
| :ref:`float<class_float>` | :ref:`sqrt<class_@GDScript_sqrt>` **(** :ref:`float<class_float>` s **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>` | :ref:`instance_from_id<class_@GDScript_instance_from_id>` **(** :ref:`int<class_int>` instance_id **)** |
| :ref:`float<class_float>` | :ref:`stepify<class_@GDScript_stepify>` **(** :ref:`float<class_float>` s, :ref:`float<class_float>` step **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Resource<class_resource>` | :ref:`preload<class_@GDScript_preload>` **(** :ref:`String<class_string>` path **)** |
| :ref:`String<class_string>` | :ref:`str<class_@GDScript_str>` **(** Variant what, Variant ... **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Variant | :ref:`str2var<class_@GDScript_str2var>` **(** :ref:`String<class_string>` string **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`tan<class_@GDScript_tan>` **(** :ref:`float<class_float>` s **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`tanh<class_@GDScript_tanh>` **(** :ref:`float<class_float>` s **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`typeof<class_@GDScript_typeof>` **(** Variant what **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RawArray<class_rawarray>` | :ref:`var2bytes<class_@GDScript_var2bytes>` **(** Variant var **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`var2str<class_@GDScript_var2str>` **(** Variant var **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`WeakRef<class_weakref>` | :ref:`weakref<class_@GDScript_weakref>` **(** :ref:`Object<class_object>` obj **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Nil<class_nil>` | :ref:`yield<class_@GDScript_yield>` **(** :ref:`Object<class_object>` object, :ref:`String<class_string>` signal **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Nil<class_nil>` | :ref:`assert<class_@GDScript_assert>` **(** :ref:`bool<class_bool>` condition **)** |
+--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+
Numeric Constants
-----------------
@@ -165,41 +165,23 @@ This contains the list of built-in gdscript functions. Mostly math functions and
Member Function Description
---------------------------
.. _class_@GDScript_sin:
.. _class_@GDScript_Color8:
- :ref:`float<class_float>` **sin** **(** :ref:`float<class_float>` s **)**
- :ref:`Color<class_color>` **Color8** **(** :ref:`int<class_int>` r8, :ref:`int<class_int>` g8, :ref:`int<class_int>` b8, :ref:`int<class_int>` a8 **)**
Standard sine function.
Make a color from red, green, blue and alpha. Arguments can range from 0 to 255.
.. _class_@GDScript_cos:
.. _class_@GDScript_abs:
- :ref:`float<class_float>` **cos** **(** :ref:`float<class_float>` s **)**
- :ref:`float<class_float>` **abs** **(** :ref:`float<class_float>` s **)**
Standard cosine function.
Remove sign (works for integer and float).
.. _class_@GDScript_tan:
.. _class_@GDScript_acos:
- :ref:`float<class_float>` **tan** **(** :ref:`float<class_float>` s **)**
- :ref:`float<class_float>` **acos** **(** :ref:`float<class_float>` s **)**
Standard tangent function.
.. _class_@GDScript_sinh:
- :ref:`float<class_float>` **sinh** **(** :ref:`float<class_float>` s **)**
Hyperbolic sine.
.. _class_@GDScript_cosh:
- :ref:`float<class_float>` **cosh** **(** :ref:`float<class_float>` s **)**
Hyperbolic cosine.
.. _class_@GDScript_tanh:
- :ref:`float<class_float>` **tanh** **(** :ref:`float<class_float>` s **)**
Hyperbolic tangent.
Arc-cosine.
.. _class_@GDScript_asin:
@@ -207,11 +189,11 @@ Hyperbolic tangent.
Arc-sine.
.. _class_@GDScript_acos:
.. _class_@GDScript_assert:
- :ref:`float<class_float>` **acos** **(** :ref:`float<class_float>` s **)**
- :ref:`Nil<class_nil>` **assert** **(** :ref:`bool<class_bool>` condition **)**
Arc-cosine.
Assert that the condition is true. If the condition is false, generates an error.
.. _class_@GDScript_atan:
@@ -225,11 +207,89 @@ Arc-tangent.
Arc-tangent that takes a 2D vector as argument, returns the full -pi to +pi range.
.. _class_@GDScript_sqrt:
.. _class_@GDScript_bytes2var:
- :ref:`float<class_float>` **sqrt** **(** :ref:`float<class_float>` s **)**
- Variant **bytes2var** **(** :ref:`RawArray<class_rawarray>` bytes **)**
Square root.
Decode a byte array back to a value.
.. _class_@GDScript_ceil:
- :ref:`float<class_float>` **ceil** **(** :ref:`float<class_float>` s **)**
Ceiling (rounds up to nearest integer).
.. _class_@GDScript_clamp:
- :ref:`float<class_float>` **clamp** **(** :ref:`float<class_float>` val, :ref:`float<class_float>` min, :ref:`float<class_float>` max **)**
Clamp both values to a range.
.. _class_@GDScript_convert:
- :ref:`Object<class_object>` **convert** **(** Variant what, :ref:`int<class_int>` type **)**
Convert from a type to another in the best way possible. The "type" parameter uses the enum TYPE\_\* in :ref:`@Global Scope<class_@global scope>`.
.. _class_@GDScript_cos:
- :ref:`float<class_float>` **cos** **(** :ref:`float<class_float>` s **)**
Standard cosine function.
.. _class_@GDScript_cosh:
- :ref:`float<class_float>` **cosh** **(** :ref:`float<class_float>` s **)**
Hyperbolic cosine.
.. _class_@GDScript_db2linear:
- :ref:`float<class_float>` **db2linear** **(** :ref:`float<class_float>` db **)**
Convert from decibels to linear energy (audio).
.. _class_@GDScript_decimals:
- :ref:`float<class_float>` **decimals** **(** :ref:`float<class_float>` step **)**
Return the amount of decimals in the floating point value.
.. _class_@GDScript_dectime:
- :ref:`float<class_float>` **dectime** **(** :ref:`float<class_float>` value, :ref:`float<class_float>` amount, :ref:`float<class_float>` step **)**
Decreases time by a specified amount.
.. _class_@GDScript_deg2rad:
- :ref:`float<class_float>` **deg2rad** **(** :ref:`float<class_float>` deg **)**
Convert from degrees to radians.
.. _class_@GDScript_dict2inst:
- :ref:`Object<class_object>` **dict2inst** **(** :ref:`Dictionary<class_dictionary>` dict **)**
Convert a previously converted instances to dictionary back into an instance. Useful for deserializing.
.. _class_@GDScript_ease:
- :ref:`float<class_float>` **ease** **(** :ref:`float<class_float>` s, :ref:`float<class_float>` curve **)**
Easing function, based on exponent. 0 is constant, 1 is linear, 0 to 1 is ease-in, 1+ is ease out. Negative values are in-out/out in.
.. _class_@GDScript_exp:
- :ref:`float<class_float>` **exp** **(** :ref:`float<class_float>` s **)**
Exponential logarithm.
.. _class_@GDScript_floor:
- :ref:`float<class_float>` **floor** **(** :ref:`float<class_float>` s **)**
Floor (rounds down to nearest integer).
.. _class_@GDScript_fmod:
@@ -243,59 +303,29 @@ Module (remainder of x/y).
Module (remainder of x/y) that wraps equally in positive and negative.
.. _class_@GDScript_floor:
.. _class_@GDScript_funcref:
- :ref:`float<class_float>` **floor** **(** :ref:`float<class_float>` s **)**
- :ref:`FuncRef<class_funcref>` **funcref** **(** :ref:`Object<class_object>` instance, :ref:`String<class_string>` funcname **)**
Floor (rounds down to nearest integer).
Return a reference to the specified function.
.. _class_@GDScript_ceil:
.. _class_@GDScript_hash:
- :ref:`float<class_float>` **ceil** **(** :ref:`float<class_float>` s **)**
- :ref:`int<class_int>` **hash** **(** Variant var:Variant **)**
Ceiling (rounds up to nearest integer).
Hash the variable passed and return an integer.
.. _class_@GDScript_round:
.. _class_@GDScript_inst2dict:
- :ref:`float<class_float>` **round** **(** :ref:`float<class_float>` s **)**
- :ref:`Dictionary<class_dictionary>` **inst2dict** **(** :ref:`Object<class_object>` inst **)**
Round to nearest integer.
Convert a script class instance to a dictionary (useful for serializing).
.. _class_@GDScript_abs:
.. _class_@GDScript_instance_from_id:
- :ref:`float<class_float>` **abs** **(** :ref:`float<class_float>` s **)**
- :ref:`Object<class_object>` **instance_from_id** **(** :ref:`int<class_int>` instance_id **)**
Remove sign (works for integer and float).
.. _class_@GDScript_sign:
- :ref:`float<class_float>` **sign** **(** :ref:`float<class_float>` s **)**
Return sign (-1 or +1).
.. _class_@GDScript_pow:
- :ref:`float<class_float>` **pow** **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)**
Power function, x elevate to y.
.. _class_@GDScript_log:
- :ref:`float<class_float>` **log** **(** :ref:`float<class_float>` s **)**
Natural logarithm.
.. _class_@GDScript_exp:
- :ref:`float<class_float>` **exp** **(** :ref:`float<class_float>` s **)**
Exponential logarithm.
.. _class_@GDScript_is_nan:
- :ref:`float<class_float>` **is_nan** **(** :ref:`float<class_float>` s **)**
Return true if the float is not a number.
Get an object by its ID.
.. _class_@GDScript_is_inf:
@@ -303,23 +333,11 @@ Return true if the float is not a number.
Return true if the float is infinite.
.. _class_@GDScript_ease:
.. _class_@GDScript_is_nan:
- :ref:`float<class_float>` **ease** **(** :ref:`float<class_float>` s, :ref:`float<class_float>` curve **)**
- :ref:`float<class_float>` **is_nan** **(** :ref:`float<class_float>` s **)**
Easing function, based on exponent. 0 is constant, 1 is linear, 0 to 1 is ease-in, 1+ is ease out. Negative values are in-out/out in.
.. _class_@GDScript_decimals:
- :ref:`float<class_float>` **decimals** **(** :ref:`float<class_float>` step **)**
Return the amount of decimals in the floating point value.
.. _class_@GDScript_stepify:
- :ref:`float<class_float>` **stepify** **(** :ref:`float<class_float>` s, :ref:`float<class_float>` step **)**
Snap float value to a given step.
Return true if the float is not a number.
.. _class_@GDScript_lerp:
@@ -327,71 +345,23 @@ Snap float value to a given step.
Linear interpolates between two values by a normalized value.
.. _class_@GDScript_dectime:
- :ref:`float<class_float>` **dectime** **(** :ref:`float<class_float>` value, :ref:`float<class_float>` amount, :ref:`float<class_float>` step **)**
Decreases time by a specified amount.
.. _class_@GDScript_randomize:
- :ref:`Nil<class_nil>` **randomize** **(** **)**
Reset the seed of the random number generator with a new, different one.
.. _class_@GDScript_randi:
- :ref:`int<class_int>` **randi** **(** **)**
Random 32 bits value (integer). To obtain a value from 0 to N, you can use remainder, like (for random from 0 to 19): randi() % 20.
.. _class_@GDScript_randf:
- :ref:`float<class_float>` **randf** **(** **)**
Random value (0 to 1 float).
.. _class_@GDScript_rand_range:
- :ref:`float<class_float>` **rand_range** **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to **)**
Random range, any floating point value between 'from' and 'to'
.. _class_@GDScript_seed:
- :ref:`Nil<class_nil>` **seed** **(** :ref:`float<class_float>` seed **)**
Set seed for the random number generator.
.. _class_@GDScript_rand_seed:
- :ref:`Array<class_array>` **rand_seed** **(** :ref:`float<class_float>` seed **)**
Random from seed, pass a seed and an array with both number and new seed is returned.
.. _class_@GDScript_deg2rad:
- :ref:`float<class_float>` **deg2rad** **(** :ref:`float<class_float>` deg **)**
Convert from degrees to radians.
.. _class_@GDScript_rad2deg:
- :ref:`float<class_float>` **rad2deg** **(** :ref:`float<class_float>` rad **)**
Convert from radians to degrees.
.. _class_@GDScript_linear2db:
- :ref:`float<class_float>` **linear2db** **(** :ref:`float<class_float>` nrg **)**
Convert from linear energy to decibels (audio).
.. _class_@GDScript_db2linear:
.. _class_@GDScript_load:
- :ref:`float<class_float>` **db2linear** **(** :ref:`float<class_float>` db **)**
- :ref:`Resource<class_resource>` **load** **(** :ref:`String<class_string>` path **)**
Convert from decibels to linear energy (audio).
Load a resource from the filesystem, pass a valid path as argument.
.. _class_@GDScript_log:
- :ref:`float<class_float>` **log** **(** :ref:`float<class_float>` s **)**
Natural logarithm.
.. _class_@GDScript_max:
@@ -405,47 +375,23 @@ Return the maximum of two values.
Return the minimum of two values.
.. _class_@GDScript_clamp:
- :ref:`float<class_float>` **clamp** **(** :ref:`float<class_float>` val, :ref:`float<class_float>` min, :ref:`float<class_float>` max **)**
Clamp both values to a range.
.. _class_@GDScript_nearest_po2:
- :ref:`int<class_int>` **nearest_po2** **(** :ref:`int<class_int>` val **)**
Return the nearest larger power of 2 for an integer.
.. _class_@GDScript_weakref:
.. _class_@GDScript_pow:
- :ref:`WeakRef<class_weakref>` **weakref** **(** :ref:`Object<class_object>` obj **)**
- :ref:`float<class_float>` **pow** **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)**
Return a weak reference to an object.
Power function, x elevate to y.
.. _class_@GDScript_funcref:
.. _class_@GDScript_preload:
- :ref:`FuncRef<class_funcref>` **funcref** **(** :ref:`Object<class_object>` instance, :ref:`String<class_string>` funcname **)**
- :ref:`Resource<class_resource>` **preload** **(** :ref:`String<class_string>` path **)**
Return a reference to the specified function.
.. _class_@GDScript_convert:
- :ref:`Object<class_object>` **convert** **(** Variant what, :ref:`int<class_int>` type **)**
Convert from a type to another in the best way possible. The "type" parameter uses the enum TYPE\_\* in :ref:`@Global Scope<class_@global scope>`.
.. _class_@GDScript_typeof:
- :ref:`int<class_int>` **typeof** **(** Variant what **)**
Return the internal type of the given Variant object, using the TYPE\_\* enum in :ref:`@Global Scope<class_@global scope>`.
.. _class_@GDScript_str:
- :ref:`String<class_string>` **str** **(** Variant what, Variant ... **)**
Convert one or more arguments to strings in the best way possible.
Preload a resource from the filesystem. The resource is loaded during script parsing.
.. _class_@GDScript_print:
@@ -453,17 +399,11 @@ Convert one or more arguments to strings in the best way possible.
Print one or more arguments to strings in the best way possible to a console line.
.. _class_@GDScript_printt:
.. _class_@GDScript_print_stack:
- :ref:`Nil<class_nil>` **printt** **(** Variant what, Variant ... **)**
- :ref:`Nil<class_nil>` **print_stack** **(** **)**
Print one or more arguments to the console with a tab between each argument.
.. _class_@GDScript_prints:
- :ref:`Nil<class_nil>` **prints** **(** Variant what, Variant ... **)**
Print one or more arguments to the console with a space between each argument.
Print a stack track at code location, only works when running with debugger turned on.
.. _class_@GDScript_printerr:
@@ -477,29 +417,53 @@ Print one or more arguments to strings in the best way possible to standard erro
Print one or more arguments to strings in the best way possible to console. No newline is added at the end.
.. _class_@GDScript_var2str:
.. _class_@GDScript_prints:
- :ref:`String<class_string>` **var2str** **(** Variant var **)**
- :ref:`Nil<class_nil>` **prints** **(** Variant what, Variant ... **)**
Convert a value to a formatted string that can later be parsed using :ref:`str2var<class_@GDScript_str2var>`.
Print one or more arguments to the console with a space between each argument.
.. _class_@GDScript_str2var:
.. _class_@GDScript_printt:
- Variant **str2var** **(** :ref:`String<class_string>` string **)**
- :ref:`Nil<class_nil>` **printt** **(** Variant what, Variant ... **)**
Convert a formatted string that was returned by :ref:`var2str<class_@GDScript_var2str>` to the original value.
Print one or more arguments to the console with a tab between each argument.
.. _class_@GDScript_var2bytes:
.. _class_@GDScript_rad2deg:
- :ref:`RawArray<class_rawarray>` **var2bytes** **(** Variant var **)**
- :ref:`float<class_float>` **rad2deg** **(** :ref:`float<class_float>` rad **)**
Encode a variable value to a byte array.
Convert from radians to degrees.
.. _class_@GDScript_bytes2var:
.. _class_@GDScript_rand_range:
- Variant **bytes2var** **(** :ref:`RawArray<class_rawarray>` bytes **)**
- :ref:`float<class_float>` **rand_range** **(** :ref:`float<class_float>` from, :ref:`float<class_float>` to **)**
Decode a byte array back to a value.
Random range, any floating point value between 'from' and 'to'
.. _class_@GDScript_rand_seed:
- :ref:`Array<class_array>` **rand_seed** **(** :ref:`float<class_float>` seed **)**
Random from seed, pass a seed and an array with both number and new seed is returned.
.. _class_@GDScript_randf:
- :ref:`float<class_float>` **randf** **(** **)**
Random value (0 to 1 float).
.. _class_@GDScript_randi:
- :ref:`int<class_int>` **randi** **(** **)**
Random 32 bits value (integer). To obtain a value from 0 to N, you can use remainder, like (for random from 0 to 19): randi() % 20.
.. _class_@GDScript_randomize:
- :ref:`Nil<class_nil>` **randomize** **(** **)**
Reset the seed of the random number generator with a new, different one.
.. _class_@GDScript_range:
@@ -507,53 +471,95 @@ Decode a byte array back to a value.
Return an array with the given range. Range can be 1 argument N (0 to N-1), two arguments (initial, final-1) or three arguments (initial, final-1, increment).
.. _class_@GDScript_load:
.. _class_@GDScript_round:
- :ref:`Resource<class_resource>` **load** **(** :ref:`String<class_string>` path **)**
- :ref:`float<class_float>` **round** **(** :ref:`float<class_float>` s **)**
Load a resource from the filesystem, pass a valid path as argument.
Round to nearest integer.
.. _class_@GDScript_inst2dict:
.. _class_@GDScript_seed:
- :ref:`Dictionary<class_dictionary>` **inst2dict** **(** :ref:`Object<class_object>` inst **)**
- :ref:`Nil<class_nil>` **seed** **(** :ref:`float<class_float>` seed **)**
Convert a script class instance to a dictionary (useful for serializing).
Set seed for the random number generator.
.. _class_@GDScript_dict2inst:
.. _class_@GDScript_sign:
- :ref:`Object<class_object>` **dict2inst** **(** :ref:`Dictionary<class_dictionary>` dict **)**
- :ref:`float<class_float>` **sign** **(** :ref:`float<class_float>` s **)**
Convert a previously converted instances to dictionary back into an instance. Useful for deserializing.
Return sign (-1 or +1).
.. _class_@GDScript_hash:
.. _class_@GDScript_sin:
- :ref:`int<class_int>` **hash** **(** Variant var:Variant **)**
- :ref:`float<class_float>` **sin** **(** :ref:`float<class_float>` s **)**
Hash the variable passed and return an integer.
Standard sine function.
.. _class_@GDScript_Color8:
.. _class_@GDScript_sinh:
- :ref:`Color<class_color>` **Color8** **(** :ref:`int<class_int>` r8, :ref:`int<class_int>` g8, :ref:`int<class_int>` b8, :ref:`int<class_int>` a8 **)**
- :ref:`float<class_float>` **sinh** **(** :ref:`float<class_float>` s **)**
Make a color from red, green, blue and alpha. Arguments can range from 0 to 255.
Hyperbolic sine.
.. _class_@GDScript_print_stack:
.. _class_@GDScript_sqrt:
- :ref:`Nil<class_nil>` **print_stack** **(** **)**
- :ref:`float<class_float>` **sqrt** **(** :ref:`float<class_float>` s **)**
Print a stack track at code location, only works when running with debugger turned on.
Square root.
.. _class_@GDScript_instance_from_id:
.. _class_@GDScript_stepify:
- :ref:`Object<class_object>` **instance_from_id** **(** :ref:`int<class_int>` instance_id **)**
- :ref:`float<class_float>` **stepify** **(** :ref:`float<class_float>` s, :ref:`float<class_float>` step **)**
Get an object by its ID.
Snap float value to a given step.
.. _class_@GDScript_preload:
.. _class_@GDScript_str:
- :ref:`Resource<class_resource>` **preload** **(** :ref:`String<class_string>` path **)**
- :ref:`String<class_string>` **str** **(** Variant what, Variant ... **)**
Preload a resource from the filesystem. The resource is loaded during script parsing.
Convert one or more arguments to strings in the best way possible.
.. _class_@GDScript_str2var:
- Variant **str2var** **(** :ref:`String<class_string>` string **)**
Convert a formatted string that was returned by :ref:`var2str<class_@GDScript_var2str>` to the original value.
.. _class_@GDScript_tan:
- :ref:`float<class_float>` **tan** **(** :ref:`float<class_float>` s **)**
Standard tangent function.
.. _class_@GDScript_tanh:
- :ref:`float<class_float>` **tanh** **(** :ref:`float<class_float>` s **)**
Hyperbolic tangent.
.. _class_@GDScript_typeof:
- :ref:`int<class_int>` **typeof** **(** Variant what **)**
Return the internal type of the given Variant object, using the TYPE\_\* enum in :ref:`@Global Scope<class_@global scope>`.
.. _class_@GDScript_var2bytes:
- :ref:`RawArray<class_rawarray>` **var2bytes** **(** Variant var **)**
Encode a variable value to a byte array.
.. _class_@GDScript_var2str:
- :ref:`String<class_string>` **var2str** **(** Variant var **)**
Convert a value to a formatted string that can later be parsed using :ref:`str2var<class_@GDScript_str2var>`.
.. _class_@GDScript_weakref:
- :ref:`WeakRef<class_weakref>` **weakref** **(** :ref:`Object<class_object>` obj **)**
Return a weak reference to an object.
.. _class_@GDScript_yield:
@@ -565,10 +571,4 @@ Returns anything that was passed to the resume function call.
If passed an object and a signal, the execution is resumed when the object's signal is emmited.
.. _class_@GDScript_assert:
- :ref:`Nil<class_nil>` **assert** **(** :ref:`bool<class_bool>` condition **)**
Assert that the condition is true. If the condition is false, generates an error.

540
classes/class_@global scope.rst
View File

@@ -16,54 +16,176 @@ Global scope constants and variables.
Member Variables
----------------
- :ref:`Performance<class_performance>` **Performance** - [Performance] singleton
- :ref:`AudioServer<class_audioserver>` **AS** - [AudioServer] singleton
- :ref:`AudioServer<class_audioserver>` **AudioServer** - [AudioServer] singleton
- :ref:`Geometry<class_geometry>` **Geometry** - [Geometry] singleton
- :ref:`Globals<class_globals>` **Globals** - [Globals] singleton
- :ref:`IP<class_ip>` **IP** - [IP] singleton
- :ref:`Geometry<class_geometry>` **Geometry** - [Geometry] singleton
- :ref:`ResourceLoader<class_resourceloader>` **ResourceLoader** - [ResourceLoader] singleton
- :ref:`ResourceSaver<class_resourcesaver>` **ResourceSaver** - [ResourceSaver] singleton
- :ref:`PathRemap<class_pathremap>` **PathRemap** - [PathRemap] singleton
- :ref:`OS<class_os>` **OS** - [OS] singleton
- :ref:`Reference<class_reference>` **Marshalls** - [Marshalls] singleton
- :ref:`TranslationServer<class_translationserver>` **TranslationServer** - [TranslationServer] singleton
- :ref:`TranslationServer<class_translationserver>` **TS** - [TranslationServer] singleton
- :ref:`Input<class_input>` **Input** - [Input] singleton
- :ref:`InputMap<class_inputmap>` **InputMap** - [InputMap] singleton
- :ref:`VisualServer<class_visualserver>` **VisualServer** - [VisualServer] singleton
- :ref:`VisualServer<class_visualserver>` **VS** - [VisualServer] singleton
- :ref:`AudioServer<class_audioserver>` **AudioServer** - [AudioServer] singleton
- :ref:`AudioServer<class_audioserver>` **AS** - [AudioServer] singleton
- :ref:`PhysicsServer<class_physicsserver>` **PhysicsServer** - [PhysicsServer] singleton
- :ref:`Reference<class_reference>` **Marshalls** - [Marshalls] singleton
- :ref:`OS<class_os>` **OS** - [OS] singleton
- :ref:`PhysicsServer<class_physicsserver>` **PS** - [PhysicsServer] singleton
- :ref:`Physics2DServer<class_physics2dserver>` **Physics2DServer** - [Physics2DServer] singleton
- :ref:`Physics2DServer<class_physics2dserver>` **PS2D** - [Physics2DServer] singleton
- :ref:`SpatialSoundServer<class_spatialsoundserver>` **SpatialSoundServer** - [SpatialSoundServer] singleton
- :ref:`PathRemap<class_pathremap>` **PathRemap** - [PathRemap] singleton
- :ref:`Performance<class_performance>` **Performance** - [Performance] singleton
- :ref:`Physics2DServer<class_physics2dserver>` **Physics2DServer** - [Physics2DServer] singleton
- :ref:`PhysicsServer<class_physicsserver>` **PhysicsServer** - [PhysicsServer] singleton
- :ref:`ResourceLoader<class_resourceloader>` **ResourceLoader** - [ResourceLoader] singleton
- :ref:`ResourceSaver<class_resourcesaver>` **ResourceSaver** - [ResourceSaver] singleton
- :ref:`SpatialSoundServer<class_spatialsoundserver>` **SS** - [SpatialSoundServer] singleton
- :ref:`SpatialSound2DServer<class_spatialsound2dserver>` **SpatialSound2DServer** - [SpatialSound2DServer] singleton
- :ref:`SpatialSound2DServer<class_spatialsound2dserver>` **SS2D** - [SpatialSound2DServer] singleton
- :ref:`SpatialSound2DServer<class_spatialsound2dserver>` **SpatialSound2DServer** - [SpatialSound2DServer] singleton
- :ref:`SpatialSoundServer<class_spatialsoundserver>` **SpatialSoundServer** - [SpatialSoundServer] singleton
- :ref:`TranslationServer<class_translationserver>` **TS** - [TranslationServer] singleton
- :ref:`TranslationServer<class_translationserver>` **TranslationServer** - [TranslationServer] singleton
- :ref:`VisualServer<class_visualserver>` **VS** - [VisualServer] singleton
- :ref:`VisualServer<class_visualserver>` **VisualServer** - [VisualServer] singleton
Numeric Constants
-----------------
- **MARGIN_LEFT** = **0** --- Left margin, used usually for :ref:`Control<class_control>` or :ref:`StyleBox<class_stylebox>` derived classes.
- **MARGIN_TOP** = **1** --- Top margin, used usually for :ref:`Control<class_control>` or :ref:`StyleBox<class_stylebox>` derived classes.
- **MARGIN_RIGHT** = **2** --- Right margin, used usually for :ref:`Control<class_control>` or :ref:`StyleBox<class_stylebox>` derived classes.
- **MARGIN_BOTTOM** = **3** --- Bottom margin, used usually for :ref:`Control<class_control>` or :ref:`StyleBox<class_stylebox>` derived classes.
- **VERTICAL** = **1** --- General vertical alignment, used usually for :ref:`Separator<class_separator>`, :ref:`ScrollBar<class_scrollbar>`, :ref:`Slider<class_slider>`, etc.
- **HORIZONTAL** = **0** --- General horizontal alignment, used usually for :ref:`Separator<class_separator>`, :ref:`ScrollBar<class_scrollbar>`, :ref:`Slider<class_slider>`, etc.
- **BUTTON_LEFT** = **1** --- Left Mouse Button
- **BUTTON_MASK_LEFT** = **1**
- **BUTTON_MASK_RIGHT** = **2**
- **BUTTON_RIGHT** = **2** --- Right Mouse Button
- **BUTTON_MIDDLE** = **3** --- Middle Mouse Button
- **BUTTON_MASK_MIDDLE** = **4**
- **BUTTON_WHEEL_UP** = **4** --- Mouse wheel up
- **BUTTON_WHEEL_DOWN** = **5** --- Mouse wheel down
- **BUTTON_WHEEL_LEFT** = **6** --- Mouse wheel left button
- **BUTTON_WHEEL_RIGHT** = **7** --- Mouse wheel right button
- **ERR_FILE_NO_PERMISSION** = **10**
- **ERR_FILE_ALREADY_IN_USE** = **11**
- **ERR_FILE_CANT_OPEN** = **12**
- **ERR_FILE_CANT_WRITE** = **13**
- **ERR_FILE_CANT_READ** = **14**
- **ERR_FILE_UNRECOGNIZED** = **15**
- **ERR_FILE_CORRUPT** = **16**
- **ERR_FILE_MISSING_DEPENDENCIES** = **17**
- **ERR_FILE_EOF** = **18**
- **ERR_CANT_OPEN** = **19**
- **ERR_UNAVAILABLE** = **2**
- **ERR_CANT_CREATE** = **20**
- **ERR_ALREADY_IN_USE** = **22**
- **ERR_LOCKED** = **23**
- **ERR_TIMEOUT** = **24**
- **ERR_CANT_AQUIRE_RESOURCE** = **28**
- **ERR_UNCONFIGURED** = **3**
- **ERR_INVALID_DATA** = **30**
- **ERR_INVALID_PARAMETER** = **31**
- **ERR_ALREADY_EXISTS** = **32**
- **ERR_DOES_NOT_EXIST** = **33**
- **ERR_DATABASE_CANT_READ** = **34**
- **ERR_DATABASE_CANT_WRITE** = **35**
- **ERR_COMPILATION_FAILED** = **36**
- **ERR_METHOD_NOT_FOUND** = **37**
- **ERR_LINK_FAILED** = **38**
- **ERR_SCRIPT_FAILED** = **39**
- **ERR_UNAUTHORIZED** = **4**
- **ERR_CYCLIC_LINK** = **40**
- **ERR_BUSY** = **44**
- **ERR_HELP** = **46**
- **ERR_BUG** = **47**
- **ERR_WTF** = **49**
- **ERR_PARAMETER_RANGE_ERROR** = **5**
- **ERR_OUT_OF_MEMORY** = **6**
- **ERR_FILE_NOT_FOUND** = **7**
- **ERR_FILE_BAD_DRIVE** = **8**
- **ERR_FILE_BAD_PATH** = **9**
- **ERROR_QUERY_FAILED** = **21**
- **FAILED** = **1** --- Generic fail return error.
- **HALIGN_LEFT** = **0** --- Horizontal left alignment, usually for text-derived classes.
- **HALIGN_CENTER** = **1** --- Horizontal center alignment, usually for text-derived classes.
- **HALIGN_RIGHT** = **2** --- Horizontal right alignment, usually for text-derived classes.
- **VALIGN_TOP** = **0** --- Vertical top alignment, usually for text-derived classes.
- **VALIGN_CENTER** = **1** --- Vertical center alignment, usually for text-derived classes.
- **VALIGN_BOTTOM** = **2** --- Vertical bottom alignment, usually for text-derived classes.
- **SPKEY** = **16777216** --- Scancodes with this bit applied are non printable.
- **HORIZONTAL** = **0** --- General horizontal alignment, used usually for :ref:`Separator<class_separator>`, :ref:`ScrollBar<class_scrollbar>`, :ref:`Slider<class_slider>`, etc.
- **JOY_ANALOG_0_X** = **0** --- Joystick Left Stick Horizontal Axis
- **JOY_AXIS_0** = **0** --- Joystick Left Stick Horizontal Axis
- **JOY_BUTTON_0** = **0** --- Joystick Button 0
- **JOY_DS_B** = **0**
- **JOY_SEGA_A** = **0** --- SEGA controller A button
- **JOY_SNES_B** = **0** --- Super Nintendo Entertaiment System controller B button
- **JOY_SONY_X** = **0** --- DUALSHOCK X button
- **JOY_XBOX_A** = **0** --- XBOX controller A button
- **JOY_ANALOG_0_Y** = **1** --- Joystick Left Stick Vertical Axis
- **JOY_AXIS_1** = **1** --- Joystick Left Stick Vertical Axis
- **JOY_BUTTON_1** = **1** --- Joystick Button 1
- **JOY_DS_A** = **1**
- **JOY_SEGA_B** = **1** --- SEGA controller B button
- **JOY_SNES_A** = **1** --- Super Nintendo Entertaiment System controller A button
- **JOY_SONY_CIRCLE** = **1** --- DUALSHOCK circle button
- **JOY_XBOX_B** = **1** --- XBOX controller B button
- **JOY_BUTTON_10** = **10** --- Joystick Button 10
- **JOY_SELECT** = **10** --- Joystick Button Select
- **JOY_BUTTON_11** = **11** --- Joystick Button 11
- **JOY_START** = **11** --- Joystick Button Start
- **JOY_BUTTON_12** = **12** --- Joystick Button 12
- **JOY_DPAD_UP** = **12** --- Joystick DPad Up
- **JOY_BUTTON_13** = **13** --- Joystick Button 13
- **JOY_DPAD_DOWN** = **13** --- Joystick DPad Down
- **JOY_BUTTON_14** = **14** --- Joystick Button 14
- **JOY_DPAD_LEFT** = **14** --- Joystick DPad Left
- **JOY_BUTTON_15** = **15** --- Joystick Button 15
- **JOY_DPAD_RIGHT** = **15** --- Joystick DPad Right
- **JOY_BUTTON_MAX** = **16** --- Joystick Button 16
- **JOY_ANALOG_1_X** = **2** --- Joystick Right Stick Horizontal Axis
- **JOY_AXIS_2** = **2** --- Joystick Right Stick Horizontal Axis
- **JOY_BUTTON_2** = **2** --- Joystick Button 2
- **JOY_DS_Y** = **2**
- **JOY_SEGA_X** = **2** --- SEGA controller X button
- **JOY_SNES_Y** = **2** --- Super Nintendo Entertaiment System controller Y button
- **JOY_SONY_SQUARE** = **2** --- DUALSHOCK square button
- **JOY_XBOX_X** = **2** --- XBOX controller X button
- **JOY_ANALOG_1_Y** = **3** --- Joystick Right Stick Vertical Axis
- **JOY_AXIS_3** = **3** --- Joystick Right Stick Vertical Axis
- **JOY_BUTTON_3** = **3** --- Joystick Button 3
- **JOY_DS_X** = **3**
- **JOY_SEGA_Y** = **3** --- SEGA controller Y button
- **JOY_SNES_X** = **3** --- Super Nintendo Entertaiment System controller X button
- **JOY_SONY_TRIANGLE** = **3** --- DUALSHOCK triangle button
- **JOY_XBOX_Y** = **3** --- XBOX controller Y button
- **JOY_ANALOG_2_X** = **4**
- **JOY_AXIS_4** = **4**
- **JOY_BUTTON_4** = **4** --- Joystick Button 4
- **JOY_L** = **4** --- Joystick Left Shoulder Button
- **JOY_ANALOG_2_Y** = **5**
- **JOY_AXIS_5** = **5**
- **JOY_BUTTON_5** = **5** --- Joystick Button 5
- **JOY_R** = **5** --- Joystick Right Shoulder Button
- **JOY_ANALOG_L2** = **6**
- **JOY_AXIS_6** = **6** --- Joystick Left Trigger Analog Axis
- **JOY_BUTTON_6** = **6** --- Joystick Button 6
- **JOY_L2** = **6** --- Joystick Left Trigger
- **JOY_ANALOG_R2** = **7**
- **JOY_AXIS_7** = **7** --- Joystick Right Trigger Analog Axis
- **JOY_BUTTON_7** = **7** --- Joystick Button 7
- **JOY_R2** = **7** --- Joystick Right Trigger
- **JOY_AXIS_MAX** = **8**
- **JOY_BUTTON_8** = **8** --- Joystick Button 8
- **JOY_L3** = **8** --- Joystick Left Stick Click
- **JOY_BUTTON_9** = **9** --- Joystick Button 9
- **JOY_R3** = **9** --- Joystick Right Stick Click
- **KEY_MODIFIER_MASK** = **-16777216**
- **KEY_MASK_GROUP_SWITCH** = **1073741824**
- **KEY_BRACELEFT** = **123** --- { key
- **KEY_BAR** = **124** --- | key
- **KEY_BRACERIGHT** = **125** --- } key
- **KEY_ASCIITILDE** = **126** --- ~ key
- **KEY_MASK_META** = **134217728**
- **KEY_NOBREAKSPACE** = **160**
- **KEY_EXCLAMDOWN** = **161**
- **KEY_CENT** = **162** --- ¢ key
- **KEY_STERLING** = **163**
- **KEY_CURRENCY** = **164**
- **KEY_YEN** = **165**
- **KEY_BROKENBAR** = **166** --- ¦ key
- **KEY_SECTION** = **167** --- § key
- **KEY_ESCAPE** = **16777217** --- Escape Key
- **KEY_TAB** = **16777218** --- Tab Key
- **KEY_BACKTAB** = **16777219** --- Shift-Tab Key
- **KEY_BACKSPACE** = **16777220** --- Backspace Key
- **KEY_RETURN** = **16777221** --- Return Key
- **KEY_ENTER** = **16777222** --- Enter Key
- **KEY_RETURN** = **16777221** --- Return Key (On Main Keyboard)
- **KEY_ENTER** = **16777222** --- Enter Key (On Numpad)
- **KEY_INSERT** = **16777223** --- Insert Key
- **KEY_DELETE** = **16777224** --- Delete Key
- **KEY_PAUSE** = **16777225** --- Pause Key
@@ -101,22 +223,6 @@ Numeric Constants
- **KEY_F14** = **16777257** --- F14 Key
- **KEY_F15** = **16777258** --- F15 Key
- **KEY_F16** = **16777259** --- F16 Key
- **KEY_KP_ENTER** = **16777344** --- Enter Key on Numpad
- **KEY_KP_MULTIPLY** = **16777345** --- Multiply Key on Numpad
- **KEY_KP_DIVIDE** = **16777346** --- Divide Key on Numpad
- **KEY_KP_SUBTRACT** = **16777347** --- Subtract Key on Numpad
- **KEY_KP_PERIOD** = **16777348** --- Period Key on Numpad
- **KEY_KP_ADD** = **16777349** --- Add Key on Numpad
- **KEY_KP_0** = **16777350** --- Number 0 on Numpad
- **KEY_KP_1** = **16777351** --- Number 1 on Numpad
- **KEY_KP_2** = **16777352** --- Number 2 on Numpad
- **KEY_KP_3** = **16777353** --- Number 3 on Numpad
- **KEY_KP_4** = **16777354** --- Number 4 on Numpad
- **KEY_KP_5** = **16777355** --- Number 5 on Numpad
- **KEY_KP_6** = **16777356** --- Number 6 on Numpad
- **KEY_KP_7** = **16777357** --- Number 7 on Numpad
- **KEY_KP_8** = **16777358** --- Number 8 on Numpad
- **KEY_KP_9** = **16777359** --- Number 9 on Numpad
- **KEY_SUPER_L** = **16777260** --- Super Left key (windows key)
- **KEY_SUPER_R** = **16777261** --- Super Left key (windows key)
- **KEY_MENU** = **16777262** --- Context menu key
@@ -165,84 +271,22 @@ Numeric Constants
- **KEY_LAUNCHD** = **16777317**
- **KEY_LAUNCHE** = **16777318**
- **KEY_LAUNCHF** = **16777319**
- **KEY_UNKNOWN** = **33554431**
- **KEY_SPACE** = **32** --- Space Key
- **KEY_EXCLAM** = **33** --- ! key
- **KEY_QUOTEDBL** = **34** --- " key
- **KEY_NUMBERSIGN** = **35** --- # key
- **KEY_DOLLAR** = **36** --- $ key
- **KEY_PERCENT** = **37** --- % key
- **KEY_AMPERSAND** = **38** --- & key
- **KEY_APOSTROPHE** = **39** --- ' key
- **KEY_PARENLEFT** = **40** --- ( key
- **KEY_PARENRIGHT** = **41** --- ) key
- **KEY_ASTERISK** = **42** --- \* key
- **KEY_PLUS** = **43** --- + key
- **KEY_COMMA** = **44** --- , key
- **KEY_MINUS** = **45** --- - key
- **KEY_PERIOD** = **46** --- . key
- **KEY_SLASH** = **47** --- / key
- **KEY_0** = **48** --- Number 0
- **KEY_1** = **49** --- Number 1
- **KEY_2** = **50** --- Number 2
- **KEY_3** = **51** --- Number 3
- **KEY_4** = **52** --- Number 4
- **KEY_5** = **53** --- Number 5
- **KEY_6** = **54** --- Number 6
- **KEY_7** = **55** --- Number 7
- **KEY_8** = **56** --- Number 8
- **KEY_9** = **57** --- Number 9
- **KEY_COLON** = **58** --- : key
- **KEY_SEMICOLON** = **59** --- ; key
- **KEY_LESS** = **60** --- Lower than key
- **KEY_EQUAL** = **61** --- = key
- **KEY_GREATER** = **62** --- Greater than key
- **KEY_QUESTION** = **63** --- ? key
- **KEY_AT** = **64** --- @ key
- **KEY_A** = **65** --- A Key
- **KEY_B** = **66** --- B Key
- **KEY_C** = **67** --- C Key
- **KEY_D** = **68** --- D Key
- **KEY_E** = **69** --- E Key
- **KEY_F** = **70** --- F Key
- **KEY_G** = **71** --- G Key
- **KEY_H** = **72** --- H Key
- **KEY_I** = **73** --- I Key
- **KEY_J** = **74** --- J Key
- **KEY_K** = **75** --- K Key
- **KEY_L** = **76** --- L Key
- **KEY_M** = **77** --- M Key
- **KEY_N** = **78** --- N Key
- **KEY_O** = **79** --- O Key
- **KEY_P** = **80** --- P Key
- **KEY_Q** = **81** --- Q Key
- **KEY_R** = **82** --- R Key
- **KEY_S** = **83** --- S Key
- **KEY_T** = **84** --- T Key
- **KEY_U** = **85** --- U Key
- **KEY_V** = **86** --- V Key
- **KEY_W** = **87** --- W Key
- **KEY_X** = **88** --- X Key
- **KEY_Y** = **89** --- Y Key
- **KEY_Z** = **90** --- Z Key
- **KEY_BRACKETLEFT** = **91** --- [ key
- **KEY_BACKSLASH** = **92** --- \ key
- **KEY_BRACKETRIGHT** = **93** --- ] key
- **KEY_ASCIICIRCUM** = **94** --- ^ key
- **KEY_UNDERSCORE** = **95** --- \_ key
- **KEY_QUOTELEFT** = **96**
- **KEY_BRACELEFT** = **123** --- { key
- **KEY_BAR** = **124** --- | key
- **KEY_BRACERIGHT** = **125** --- } key
- **KEY_ASCIITILDE** = **126** --- ~ key
- **KEY_NOBREAKSPACE** = **160**
- **KEY_EXCLAMDOWN** = **161**
- **KEY_CENT** = **162** --- ¢ key
- **KEY_STERLING** = **163**
- **KEY_CURRENCY** = **164**
- **KEY_YEN** = **165**
- **KEY_BROKENBAR** = **166** --- ¦ key
- **KEY_SECTION** = **167** --- § key
- **KEY_KP_ENTER** = **16777344** --- Enter Key on Numpad
- **KEY_KP_MULTIPLY** = **16777345** --- Multiply Key on Numpad
- **KEY_KP_DIVIDE** = **16777346** --- Divide Key on Numpad
- **KEY_KP_SUBTRACT** = **16777347** --- Subtract Key on Numpad
- **KEY_KP_PERIOD** = **16777348** --- Period Key on Numpad
- **KEY_KP_ADD** = **16777349** --- Add Key on Numpad
- **KEY_KP_0** = **16777350** --- Number 0 on Numpad
- **KEY_KP_1** = **16777351** --- Number 1 on Numpad
- **KEY_KP_2** = **16777352** --- Number 2 on Numpad
- **KEY_KP_3** = **16777353** --- Number 3 on Numpad
- **KEY_KP_4** = **16777354** --- Number 4 on Numpad
- **KEY_KP_5** = **16777355** --- Number 5 on Numpad
- **KEY_KP_6** = **16777356** --- Number 6 on Numpad
- **KEY_KP_7** = **16777357** --- Number 7 on Numpad
- **KEY_KP_8** = **16777358** --- Number 8 on Numpad
- **KEY_KP_9** = **16777359** --- Number 9 on Numpad
- **KEY_DIAERESIS** = **168** --- ¨ key
- **KEY_COPYRIGHT** = **169** --- © key
- **KEY_ORDFEMININE** = **170**
@@ -301,141 +345,94 @@ Numeric Constants
- **KEY_SSHARP** = **223**
- **KEY_DIVISION** = **247**
- **KEY_YDIAERESIS** = **255**
- **KEY_CODE_MASK** = **33554431**
- **KEY_MODIFIER_MASK** = **-16777216**
- **KEY_MASK_SHIFT** = **33554432**
- **KEY_MASK_ALT** = **67108864**
- **KEY_MASK_META** = **134217728**
- **KEY_MASK_CTRL** = **268435456**
- **KEY_MASK_CMD** = **268435456**
- **KEY_MASK_CTRL** = **268435456**
- **KEY_SPACE** = **32** --- Space Key
- **KEY_EXCLAM** = **33** --- ! key
- **KEY_CODE_MASK** = **33554431**
- **KEY_UNKNOWN** = **33554431**
- **KEY_MASK_SHIFT** = **33554432**
- **KEY_QUOTEDBL** = **34** --- " key
- **KEY_NUMBERSIGN** = **35** --- # key
- **KEY_DOLLAR** = **36** --- $ key
- **KEY_PERCENT** = **37** --- % key
- **KEY_AMPERSAND** = **38** --- & key
- **KEY_APOSTROPHE** = **39** --- ' key
- **KEY_PARENLEFT** = **40** --- ( key
- **KEY_PARENRIGHT** = **41** --- ) key
- **KEY_ASTERISK** = **42** --- \* key
- **KEY_PLUS** = **43** --- + key
- **KEY_COMMA** = **44** --- , key
- **KEY_MINUS** = **45** --- - key
- **KEY_PERIOD** = **46** --- . key
- **KEY_SLASH** = **47** --- / key
- **KEY_0** = **48** --- Number 0
- **KEY_1** = **49** --- Number 1
- **KEY_2** = **50** --- Number 2
- **KEY_3** = **51** --- Number 3
- **KEY_4** = **52** --- Number 4
- **KEY_5** = **53** --- Number 5
- **KEY_MASK_KPAD** = **536870912**
- **KEY_MASK_GROUP_SWITCH** = **1073741824**
- **BUTTON_LEFT** = **1** --- Left Mouse Button
- **BUTTON_RIGHT** = **2** --- Right Mouse Button
- **BUTTON_MIDDLE** = **3** --- Middle Mouse Button
- **BUTTON_WHEEL_UP** = **4** --- Mouse wheel up
- **BUTTON_WHEEL_DOWN** = **5** --- Mouse wheel down
- **BUTTON_WHEEL_LEFT** = **6** --- Mouse wheel left button
- **BUTTON_WHEEL_RIGHT** = **7** --- Mouse wheel right button
- **BUTTON_MASK_LEFT** = **1**
- **BUTTON_MASK_RIGHT** = **2**
- **BUTTON_MASK_MIDDLE** = **4**
- **JOY_BUTTON_0** = **0** --- Joystick Button 0
- **JOY_BUTTON_1** = **1** --- Joystick Button 1
- **JOY_BUTTON_2** = **2** --- Joystick Button 2
- **JOY_BUTTON_3** = **3** --- Joystick Button 3
- **JOY_BUTTON_4** = **4** --- Joystick Button 4
- **JOY_BUTTON_5** = **5** --- Joystick Button 5
- **JOY_BUTTON_6** = **6** --- Joystick Button 6
- **JOY_BUTTON_7** = **7** --- Joystick Button 7
- **JOY_BUTTON_8** = **8** --- Joystick Button 8
- **JOY_BUTTON_9** = **9** --- Joystick Button 9
- **JOY_BUTTON_10** = **10** --- Joystick Button 10
- **JOY_BUTTON_11** = **11** --- Joystick Button 11
- **JOY_BUTTON_12** = **12** --- Joystick Button 12
- **JOY_BUTTON_13** = **13** --- Joystick Button 13
- **JOY_BUTTON_14** = **14** --- Joystick Button 14
- **JOY_BUTTON_15** = **15** --- Joystick Button 15
- **JOY_BUTTON_MAX** = **16** --- Joystick Button 16
- **JOY_SNES_A** = **1** --- Super Nintendo Entertaiment System controller A button
- **JOY_SNES_B** = **0** --- Super Nintendo Entertaiment System controller B button
- **JOY_SNES_X** = **3** --- Super Nintendo Entertaiment System controller X button
- **JOY_SNES_Y** = **2** --- Super Nintendo Entertaiment System controller Y button
- **JOY_SONY_CIRCLE** = **1** --- DUALSHOCK circle button
- **JOY_SONY_X** = **0** --- DUALSHOCK X button
- **JOY_SONY_SQUARE** = **2** --- DUALSHOCK square button
- **JOY_SONY_TRIANGLE** = **3** --- DUALSHOCK triangle button
- **JOY_SEGA_B** = **1** --- SEGA controller B button
- **JOY_SEGA_A** = **0** --- SEGA controller A button
- **JOY_SEGA_X** = **2** --- SEGA controller X button
- **JOY_SEGA_Y** = **3** --- SEGA controller Y button
- **JOY_XBOX_B** = **1** --- XBOX controller B button
- **JOY_XBOX_A** = **0** --- XBOX controller A button
- **JOY_XBOX_X** = **2** --- XBOX controller X button
- **JOY_XBOX_Y** = **3** --- XBOX controller Y button
- **JOY_DS_A** = **1**
- **JOY_DS_B** = **0**
- **JOY_DS_X** = **3**
- **JOY_DS_Y** = **2**
- **JOY_SELECT** = **10** --- Joystick Button Select
- **JOY_START** = **11** --- Joystick Button Start
- **JOY_DPAD_UP** = **12** --- Joystick DPad Up
- **JOY_DPAD_DOWN** = **13** --- Joystick DPad Down
- **JOY_DPAD_LEFT** = **14** --- Joystick DPad Left
- **JOY_DPAD_RIGHT** = **15** --- Joystick DPad Right
- **JOY_L** = **4** --- Joystick Left Shoulder Button
- **JOY_L2** = **6** --- Joystick Left Trigger
- **JOY_L3** = **8** --- Joystick Left Stick Click
- **JOY_R** = **5** --- Joystick Right Shoulder Button
- **JOY_R2** = **7** --- Joystick Right Trigger
- **JOY_R3** = **9** --- Joystick Right Stick Click
- **JOY_AXIS_0** = **0** --- Joystick Left Stick Horizontal Axis
- **JOY_AXIS_1** = **1** --- Joystick Left Stick Vertical Axis
- **JOY_AXIS_2** = **2** --- Joystick Right Stick Horizontal Axis
- **JOY_AXIS_3** = **3** --- Joystick Right Stick Vertical Axis
- **JOY_AXIS_4** = **4**
- **JOY_AXIS_5** = **5**
- **JOY_AXIS_6** = **6** --- Joystick Left Trigger Analog Axis
- **JOY_AXIS_7** = **7** --- Joystick Right Trigger Analog Axis
- **JOY_AXIS_MAX** = **8**
- **JOY_ANALOG_0_X** = **0** --- Joystick Left Stick Horizontal Axis
- **JOY_ANALOG_0_Y** = **1** --- Joystick Left Stick Vertical Axis
- **JOY_ANALOG_1_X** = **2** --- Joystick Right Stick Horizontal Axis
- **JOY_ANALOG_1_Y** = **3** --- Joystick Right Stick Vertical Axis
- **JOY_ANALOG_2_X** = **4**
- **JOY_ANALOG_2_Y** = **5**
- **JOY_ANALOG_L2** = **6**
- **JOY_ANALOG_R2** = **7**
- **KEY_6** = **54** --- Number 6
- **KEY_7** = **55** --- Number 7
- **KEY_8** = **56** --- Number 8
- **KEY_9** = **57** --- Number 9
- **KEY_COLON** = **58** --- : key
- **KEY_SEMICOLON** = **59** --- ; key
- **KEY_LESS** = **60** --- Lower than key
- **KEY_EQUAL** = **61** --- = key
- **KEY_GREATER** = **62** --- Greater than key
- **KEY_QUESTION** = **63** --- ? key
- **KEY_AT** = **64** --- @ key
- **KEY_A** = **65** --- A Key
- **KEY_B** = **66** --- B Key
- **KEY_C** = **67** --- C Key
- **KEY_MASK_ALT** = **67108864**
- **KEY_D** = **68** --- D Key
- **KEY_E** = **69** --- E Key
- **KEY_F** = **70** --- F Key
- **KEY_G** = **71** --- G Key
- **KEY_H** = **72** --- H Key
- **KEY_I** = **73** --- I Key
- **KEY_J** = **74** --- J Key
- **KEY_K** = **75** --- K Key
- **KEY_L** = **76** --- L Key
- **KEY_M** = **77** --- M Key
- **KEY_N** = **78** --- N Key
- **KEY_O** = **79** --- O Key
- **KEY_P** = **80** --- P Key
- **KEY_Q** = **81** --- Q Key
- **KEY_R** = **82** --- R Key
- **KEY_S** = **83** --- S Key
- **KEY_T** = **84** --- T Key
- **KEY_U** = **85** --- U Key
- **KEY_V** = **86** --- V Key
- **KEY_W** = **87** --- W Key
- **KEY_X** = **88** --- X Key
- **KEY_Y** = **89** --- Y Key
- **KEY_Z** = **90** --- Z Key
- **KEY_BRACKETLEFT** = **91** --- [ key
- **KEY_BACKSLASH** = **92** --- \ key
- **KEY_BRACKETRIGHT** = **93** --- ] key
- **KEY_ASCIICIRCUM** = **94** --- ^ key
- **KEY_UNDERSCORE** = **95** --- \_ key
- **KEY_QUOTELEFT** = **96**
- **MARGIN_LEFT** = **0** --- Left margin, used usually for :ref:`Control<class_control>` or :ref:`StyleBox<class_stylebox>` derived classes.
- **MARGIN_TOP** = **1** --- Top margin, used usually for :ref:`Control<class_control>` or :ref:`StyleBox<class_stylebox>` derived classes.
- **MARGIN_RIGHT** = **2** --- Right margin, used usually for :ref:`Control<class_control>` or :ref:`StyleBox<class_stylebox>` derived classes.
- **MARGIN_BOTTOM** = **3** --- Bottom margin, used usually for :ref:`Control<class_control>` or :ref:`StyleBox<class_stylebox>` derived classes.
- **METHOD_FLAGS_DEFAULT** = **1**
- **METHOD_FLAG_NORMAL** = **1**
- **METHOD_FLAG_REVERSE** = **16**
- **METHOD_FLAG_EDITOR** = **2**
- **METHOD_FLAG_VIRTUAL** = **32**
- **METHOD_FLAG_NOSCRIPT** = **4**
- **METHOD_FLAG_FROM_SCRIPT** = **64**
- **METHOD_FLAG_CONST** = **8**
- **OK** = **0** --- Functions that return Error return OK when everything went ok. Most functions don't return error anyway and/or just print errors to stdout.
- **FAILED** = **1** --- Generic fail return error.
- **ERR_UNAVAILABLE** = **2**
- **ERR_UNCONFIGURED** = **3**
- **ERR_UNAUTHORIZED** = **4**
- **ERR_PARAMETER_RANGE_ERROR** = **5**
- **ERR_OUT_OF_MEMORY** = **6**
- **ERR_FILE_NOT_FOUND** = **7**
- **ERR_FILE_BAD_DRIVE** = **8**
- **ERR_FILE_BAD_PATH** = **9**
- **ERR_FILE_NO_PERMISSION** = **10**
- **ERR_FILE_ALREADY_IN_USE** = **11**
- **ERR_FILE_CANT_OPEN** = **12**
- **ERR_FILE_CANT_WRITE** = **13**
- **ERR_FILE_CANT_READ** = **14**
- **ERR_FILE_UNRECOGNIZED** = **15**
- **ERR_FILE_CORRUPT** = **16**
- **ERR_FILE_MISSING_DEPENDENCIES** = **17**
- **ERR_FILE_EOF** = **18**
- **ERR_CANT_OPEN** = **19**
- **ERR_CANT_CREATE** = **20**
- **ERROR_QUERY_FAILED** = **21**
- **ERR_ALREADY_IN_USE** = **22**
- **ERR_LOCKED** = **23**
- **ERR_TIMEOUT** = **24**
- **ERR_CANT_AQUIRE_RESOURCE** = **28**
- **ERR_INVALID_DATA** = **30**
- **ERR_INVALID_PARAMETER** = **31**
- **ERR_ALREADY_EXISTS** = **32**
- **ERR_DOES_NOT_EXIST** = **33**
- **ERR_DATABASE_CANT_READ** = **34**
- **ERR_DATABASE_CANT_WRITE** = **35**
- **ERR_COMPILATION_FAILED** = **36**
- **ERR_METHOD_NOT_FOUND** = **37**
- **ERR_LINK_FAILED** = **38**
- **ERR_SCRIPT_FAILED** = **39**
- **ERR_CYCLIC_LINK** = **40**
- **ERR_BUSY** = **44**
- **ERR_HELP** = **46**
- **ERR_BUG** = **47**
- **ERR_WTF** = **49**
- **PROPERTY_HINT_NONE** = **0** --- No hint for edited property.
- **PROPERTY_HINT_RANGE** = **1** --- Hints that the string is a range, defined as "min,max" or "min,max,step". This is valid for integers and floats.
- **PROPERTY_HINT_EXP_RANGE** = **2** --- Hints that the string is an exponential range, defined as "min,max" or "min,max,step". This is valid for integers and floats.
- **PROPERTY_HINT_ENUM** = **3** --- Property hint for an enumerated value, like "Hello,Something,Else". This is valid for integer, float and string properties.
- **PROPERTY_HINT_EXP_EASING** = **4**
- **PROPERTY_HINT_LENGTH** = **5**
- **PROPERTY_HINT_KEY_ACCEL** = **7**
- **PROPERTY_HINT_FLAGS** = **8** --- Property hint for a bitmask description, for bits 0,1,2,3 and 5 the hint would be like "Bit0,Bit1,Bit2,Bit3,,Bit5". Valid only for integers.
- **PROPERTY_HINT_ALL_FLAGS** = **9** --- Property hint for a bitmask description that covers all 32 bits. Valid only for integers.
- **PROPERTY_USAGE_STORAGE** = **1** --- Property will be used as storage (default).
- **PROPERTY_HINT_FILE** = **10** --- String property is a file (so pop up a file dialog when edited). Hint string can be a set of wildcards like "\*.doc".
- **PROPERTY_HINT_DIR** = **11** --- String property is a directory (so pop up a file dialog when edited).
- **PROPERTY_HINT_GLOBAL_FILE** = **12**
@@ -445,28 +442,19 @@ Numeric Constants
- **PROPERTY_HINT_COLOR_NO_ALPHA** = **16**
- **PROPERTY_HINT_IMAGE_COMPRESS_LOSSY** = **17**
- **PROPERTY_HINT_IMAGE_COMPRESS_LOSSLESS** = **18**
- **PROPERTY_USAGE_STORAGE** = **1** --- Property will be used as storage (default).
- **PROPERTY_HINT_EXP_RANGE** = **2** --- Hints that the string is an exponential range, defined as "min,max" or "min,max,step". This is valid for integers and floats.
- **PROPERTY_USAGE_EDITOR** = **2** --- Property will be visible in editor (default).
- **PROPERTY_HINT_ENUM** = **3** --- Property hint for an enumerated value, like "Hello,Something,Else". This is valid for integer, float and string properties.
- **PROPERTY_HINT_EXP_EASING** = **4**
- **PROPERTY_USAGE_NETWORK** = **4**
- **PROPERTY_HINT_LENGTH** = **5**
- **PROPERTY_HINT_KEY_ACCEL** = **7**
- **PROPERTY_USAGE_DEFAULT** = **7** --- Default usage (storage and editor).
- **METHOD_FLAG_NORMAL** = **1**
- **METHOD_FLAG_EDITOR** = **2**
- **METHOD_FLAG_NOSCRIPT** = **4**
- **METHOD_FLAG_CONST** = **8**
- **METHOD_FLAG_REVERSE** = **16**
- **METHOD_FLAG_VIRTUAL** = **32**
- **METHOD_FLAG_FROM_SCRIPT** = **64**
- **METHOD_FLAGS_DEFAULT** = **1**
- **PROPERTY_HINT_FLAGS** = **8** --- Property hint for a bitmask description, for bits 0,1,2,3 and 5 the hint would be like "Bit0,Bit1,Bit2,Bit3,,Bit5". Valid only for integers.
- **PROPERTY_HINT_ALL_FLAGS** = **9** --- Property hint for a bitmask description that covers all 32 bits. Valid only for integers.
- **SPKEY** = **16777216** --- Scancodes with this bit applied are non printable.
- **TYPE_NIL** = **0** --- Variable is of type nil (only applied for null).
- **TYPE_BOOL** = **1** --- Variable is of type :ref:`bool<class_bool>`.
- **TYPE_INT** = **2** --- Variable is of type :ref:`int<class_int>`.
- **TYPE_REAL** = **3** --- Variable is of type :ref:`float<class_float>`/real.
- **TYPE_STRING** = **4** --- Variable is of type :ref:`String<class_string>`.
- **TYPE_VECTOR2** = **5** --- Variable is of type :ref:`Vector2<class_vector2>`.
- **TYPE_RECT2** = **6** --- Variable is of type :ref:`Rect2<class_rect2>`.
- **TYPE_VECTOR3** = **7** --- Variable is of type :ref:`Vector3<class_vector3>`.
- **TYPE_MATRIX32** = **8** --- Variable is of type :ref:`Matrix32<class_matrix32>`.
- **TYPE_PLANE** = **9** --- Variable is of type :ref:`Plane<class_plane>`.
- **TYPE_QUAT** = **10** --- Variable is of type :ref:`Quat<class_quat>`.
- **TYPE_AABB** = **11** --- Variable is of type :ref:`AABB<class_aabb>`.
- **TYPE_MATRIX3** = **12** --- Variable is of type :ref:`Matrix3<class_matrix3>`.
@@ -477,6 +465,7 @@ Numeric Constants
- **TYPE_RID** = **17** --- Variable is of type :ref:`RID<class_rid>`.
- **TYPE_OBJECT** = **18** --- Variable is of type :ref:`Object<class_object>`.
- **TYPE_INPUT_EVENT** = **19** --- Variable is of type :ref:`InputEvent<class_inputevent>`.
- **TYPE_INT** = **2** --- Variable is of type :ref:`int<class_int>`.
- **TYPE_DICTIONARY** = **20** --- Variable is of type :ref:`Dictionary<class_dictionary>`.
- **TYPE_ARRAY** = **21** --- Variable is of type :ref:`Array<class_array>`.
- **TYPE_RAW_ARRAY** = **22**
@@ -487,6 +476,17 @@ Numeric Constants
- **TYPE_VECTOR3_ARRAY** = **27**
- **TYPE_COLOR_ARRAY** = **28**
- **TYPE_MAX** = **29**
- **TYPE_REAL** = **3** --- Variable is of type :ref:`float<class_float>`/real.
- **TYPE_STRING** = **4** --- Variable is of type :ref:`String<class_string>`.
- **TYPE_VECTOR2** = **5** --- Variable is of type :ref:`Vector2<class_vector2>`.
- **TYPE_RECT2** = **6** --- Variable is of type :ref:`Rect2<class_rect2>`.
- **TYPE_VECTOR3** = **7** --- Variable is of type :ref:`Vector3<class_vector3>`.
- **TYPE_MATRIX32** = **8** --- Variable is of type :ref:`Matrix32<class_matrix32>`.
- **TYPE_PLANE** = **9** --- Variable is of type :ref:`Plane<class_plane>`.
- **VALIGN_TOP** = **0** --- Vertical top alignment, usually for text-derived classes.
- **VALIGN_CENTER** = **1** --- Vertical center alignment, usually for text-derived classes.
- **VALIGN_BOTTOM** = **2** --- Vertical bottom alignment, usually for text-derived classes.
- **VERTICAL** = **1** --- General vertical alignment, used usually for :ref:`Separator<class_separator>`, :ref:`ScrollBar<class_scrollbar>`, :ref:`Slider<class_slider>`, etc.
Description
-----------

18
classes/class_aabb.rst
View File

@@ -16,6 +16,8 @@ Axis-Aligned Bounding Box.
Member Functions
----------------
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`AABB<class_aabb>` | :ref:`AABB<class_AABB_AABB>` **(** :ref:`Vector3<class_vector3>` pos, :ref:`Vector3<class_vector3>` size **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`encloses<class_AABB_encloses>` **(** :ref:`AABB<class_aabb>` with **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
@@ -57,15 +59,13 @@ Member Functions
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`AABB<class_aabb>` | :ref:`merge<class_AABB_merge>` **(** :ref:`AABB<class_aabb>` with **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`AABB<class_aabb>` | :ref:`AABB<class_AABB_AABB>` **(** :ref:`Vector3<class_vector3>` pos, :ref:`Vector3<class_vector3>` size **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`Vector3<class_vector3>` **end** - Ending corner.
- :ref:`Vector3<class_vector3>` **pos** - Position (starting corner).
- :ref:`Vector3<class_vector3>` **size** - Size from position to end.
- :ref:`Vector3<class_vector3>` **end** - Ending corner.
Description
-----------
@@ -75,6 +75,12 @@ AABB provides an 3D Axis-Aligned Bounding Box. It consists of a position, a size
Member Function Description
---------------------------
.. _class_AABB_AABB:
- :ref:`AABB<class_aabb>` **AABB** **(** :ref:`Vector3<class_vector3>` pos, :ref:`Vector3<class_vector3>` size **)**
Optional constructor, accepts position and size.
.. _class_AABB_encloses:
- :ref:`bool<class_bool>` **encloses** **(** :ref:`AABB<class_aabb>` with **)**
@@ -195,10 +201,4 @@ Return true if the :ref:`AABB<class_aabb>` intersects the line segment between f
Combine this :ref:`AABB<class_aabb>` with another, a larger one is returned that contains both.
.. _class_AABB_AABB:
- :ref:`AABB<class_aabb>` **AABB** **(** :ref:`Vector3<class_vector3>` pos, :ref:`Vector3<class_vector3>` size **)**
Optional constructor, accepts position and size.

80
classes/class_acceptdialog.rst
View File

@@ -20,25 +20,25 @@ Base dialog for user notification.
Member Functions
----------------
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>` | :ref:`get_ok<class_AcceptDialog_get_ok>` **(** **)** |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>` | :ref:`get_label<class_AcceptDialog_get_label>` **(** **)** |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_hide_on_ok<class_AcceptDialog_set_hide_on_ok>` **(** :ref:`bool<class_bool>` enabled **)** |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_hide_on_ok<class_AcceptDialog_get_hide_on_ok>` **(** **)** const |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Button<class_button>` | :ref:`add_button<class_AcceptDialog_add_button>` **(** :ref:`String<class_string>` text, :ref:`bool<class_bool>` right=false, :ref:`String<class_string>` action="" **)** |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Button<class_button>` | :ref:`add_cancel<class_AcceptDialog_add_cancel>` **(** :ref:`String<class_string>` name **)** |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`LineEdit<class_lineedit>` | :ref:`register_text_enter<class_AcceptDialog_register_text_enter>` **(** :ref:`Object<class_object>` line_edit **)** |
| :ref:`bool<class_bool>` | :ref:`get_hide_on_ok<class_AcceptDialog_get_hide_on_ok>` **(** **)** const |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_text<class_AcceptDialog_set_text>` **(** :ref:`String<class_string>` text **)** |
| :ref:`Object<class_object>` | :ref:`get_label<class_AcceptDialog_get_label>` **(** **)** |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>` | :ref:`get_ok<class_AcceptDialog_get_ok>` **(** **)** |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_text<class_AcceptDialog_get_text>` **(** **)** const |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`LineEdit<class_lineedit>` | :ref:`register_text_enter<class_AcceptDialog_register_text_enter>` **(** :ref:`Object<class_object>` line_edit **)** |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_hide_on_ok<class_AcceptDialog_set_hide_on_ok>` **(** :ref:`bool<class_bool>` enabled **)** |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_text<class_AcceptDialog_set_text>` **(** :ref:`String<class_string>` text **)** |
+----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
@@ -54,30 +54,6 @@ This dialog is useful for small notifications to the user about an event. It can
Member Function Description
---------------------------
.. _class_AcceptDialog_get_ok:
- :ref:`Object<class_object>` **get_ok** **(** **)**
Return the OK Button.
.. _class_AcceptDialog_get_label:
- :ref:`Object<class_object>` **get_label** **(** **)**
Return the label used for built-in text.
.. _class_AcceptDialog_set_hide_on_ok:
- void **set_hide_on_ok** **(** :ref:`bool<class_bool>` enabled **)**
Set whether the dialog is hidden when accepted (default true).
.. _class_AcceptDialog_get_hide_on_ok:
- :ref:`bool<class_bool>` **get_hide_on_ok** **(** **)** const
Return true if the dialog will be hidden when accepted (default true).
.. _class_AcceptDialog_add_button:
- :ref:`Button<class_button>` **add_button** **(** :ref:`String<class_string>` text, :ref:`bool<class_bool>` right=false, :ref:`String<class_string>` action="" **)**
@@ -92,17 +68,23 @@ The button titled with *text* and the *action* will be passed to :ref:`custom_ac
Add custom cancel button to the dialog and return the created button.
.. _class_AcceptDialog_register_text_enter:
.. _class_AcceptDialog_get_hide_on_ok:
- :ref:`LineEdit<class_lineedit>` **register_text_enter** **(** :ref:`Object<class_object>` line_edit **)**
- :ref:`bool<class_bool>` **get_hide_on_ok** **(** **)** const
Register a :ref:`LineEdit<class_lineedit>` in the dialog. When the enter key is pressed, the dialog will be accepted.
Return true if the dialog will be hidden when accepted (default true).
.. _class_AcceptDialog_set_text:
.. _class_AcceptDialog_get_label:
- void **set_text** **(** :ref:`String<class_string>` text **)**
- :ref:`Object<class_object>` **get_label** **(** **)**
Set the built-in label text.
Return the label used for built-in text.
.. _class_AcceptDialog_get_ok:
- :ref:`Object<class_object>` **get_ok** **(** **)**
Return the OK Button.
.. _class_AcceptDialog_get_text:
@@ -110,4 +92,22 @@ Set the built-in label text.
Return the built-in label text.
.. _class_AcceptDialog_register_text_enter:
- :ref:`LineEdit<class_lineedit>` **register_text_enter** **(** :ref:`Object<class_object>` line_edit **)**
Register a :ref:`LineEdit<class_lineedit>` in the dialog. When the enter key is pressed, the dialog will be accepted.
.. _class_AcceptDialog_set_hide_on_ok:
- void **set_hide_on_ok** **(** :ref:`bool<class_bool>` enabled **)**
Set whether the dialog is hidden when accepted (default true).
.. _class_AcceptDialog_set_text:
- void **set_text** **(** :ref:`String<class_string>` text **)**
Set the built-in label text.

172
classes/class_animatedsprite.rst
View File

@@ -19,33 +19,33 @@ Member Functions
----------------
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_sprite_frames<class_AnimatedSprite_set_sprite_frames>` **(** :ref:`SpriteFrames<class_spriteframes>` sprite_frames **)** |
| :ref:`int<class_int>` | :ref:`get_frame<class_AnimatedSprite_get_frame>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`SpriteFrames<class_spriteframes>` | :ref:`get_sprite_frames<class_AnimatedSprite_get_sprite_frames>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_centered<class_AnimatedSprite_set_centered>` **(** :ref:`bool<class_bool>` centered **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_centered<class_AnimatedSprite_is_centered>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_offset<class_AnimatedSprite_set_offset>` **(** :ref:`Vector2<class_vector2>` offset **)** |
| :ref:`Color<class_color>` | :ref:`get_modulate<class_AnimatedSprite_get_modulate>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_offset<class_AnimatedSprite_get_offset>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_flip_h<class_AnimatedSprite_set_flip_h>` **(** :ref:`bool<class_bool>` flip_h **)** |
| :ref:`SpriteFrames<class_spriteframes>` | :ref:`get_sprite_frames<class_AnimatedSprite_get_sprite_frames>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_centered<class_AnimatedSprite_is_centered>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_flipped_h<class_AnimatedSprite_is_flipped_h>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_flip_v<class_AnimatedSprite_set_flip_v>` **(** :ref:`bool<class_bool>` flip_v **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_flipped_v<class_AnimatedSprite_is_flipped_v>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_centered<class_AnimatedSprite_set_centered>` **(** :ref:`bool<class_bool>` centered **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_flip_h<class_AnimatedSprite_set_flip_h>` **(** :ref:`bool<class_bool>` flip_h **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_flip_v<class_AnimatedSprite_set_flip_v>` **(** :ref:`bool<class_bool>` flip_v **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_frame<class_AnimatedSprite_set_frame>` **(** :ref:`int<class_int>` frame **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_frame<class_AnimatedSprite_get_frame>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_modulate<class_AnimatedSprite_set_modulate>` **(** :ref:`Color<class_color>` modulate **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_modulate<class_AnimatedSprite_get_modulate>` **(** **)** const |
| void | :ref:`set_offset<class_AnimatedSprite_set_offset>` **(** :ref:`Vector2<class_vector2>` offset **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_sprite_frames<class_AnimatedSprite_set_sprite_frames>` **(** :ref:`SpriteFrames<class_spriteframes>` sprite_frames **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
Signals
@@ -61,88 +61,88 @@ Sprite node that can use multiple textures for animation.
Member Function Description
---------------------------
.. _class_AnimatedSprite_set_sprite_frames:
- void **set_sprite_frames** **(** :ref:`SpriteFrames<class_spriteframes>` sprite_frames **)**
Set the :ref:`SpriteFrames<class_spriteframes>` resource, which contains all frames.
.. _class_AnimatedSprite_get_sprite_frames:
- :ref:`SpriteFrames<class_spriteframes>` **get_sprite_frames** **(** **)** const
Get the :ref:`SpriteFrames<class_spriteframes>` resource, which contains all frames.
.. _class_AnimatedSprite_set_centered:
- void **set_centered** **(** :ref:`bool<class_bool>` centered **)**
When turned on, offset at (0,0) is the center of the sprite, when off, the top-left corner is.
.. _class_AnimatedSprite_is_centered:
- :ref:`bool<class_bool>` **is_centered** **(** **)** const
Return true when centered. See :ref:`set_centered<class_AnimatedSprite_set_centered>`.
.. _class_AnimatedSprite_set_offset:
- void **set_offset** **(** :ref:`Vector2<class_vector2>` offset **)**
Set the offset of the sprite in the node origin. Position varies depending on whether it is centered or not.
.. _class_AnimatedSprite_get_offset:
- :ref:`Vector2<class_vector2>` **get_offset** **(** **)** const
Return the offset of the sprite in the node origin.
.. _class_AnimatedSprite_set_flip_h:
- void **set_flip_h** **(** :ref:`bool<class_bool>` flip_h **)**
If true, sprite is flipped horizontally.
.. _class_AnimatedSprite_is_flipped_h:
- :ref:`bool<class_bool>` **is_flipped_h** **(** **)** const
Return true if sprite is flipped horizontally.
.. _class_AnimatedSprite_set_flip_v:
- void **set_flip_v** **(** :ref:`bool<class_bool>` flip_v **)**
If true, sprite is flipped vertically.
.. _class_AnimatedSprite_is_flipped_v:
- :ref:`bool<class_bool>` **is_flipped_v** **(** **)** const
Return true if sprite is flipped vertically.
.. _class_AnimatedSprite_set_frame:
- void **set_frame** **(** :ref:`int<class_int>` frame **)**
Set the visible sprite frame index (from the list of frames inside the :ref:`SpriteFrames<class_spriteframes>` resource).
.. _class_AnimatedSprite_get_frame:
- :ref:`int<class_int>` **get_frame** **(** **)** const
Return the visible frame index.
.. _class_AnimatedSprite_set_modulate:
- void **set_modulate** **(** :ref:`Color<class_color>` modulate **)**
Change the color modulation (multiplication) for this sprite.
.. _class_AnimatedSprite_get_modulate:
- :ref:`Color<class_color>` **get_modulate** **(** **)** const
Return the color modulation for this sprite.
.. _class_AnimatedSprite_get_offset:
- :ref:`Vector2<class_vector2>` **get_offset** **(** **)** const
Return the offset of the sprite in the node origin.
.. _class_AnimatedSprite_get_sprite_frames:
- :ref:`SpriteFrames<class_spriteframes>` **get_sprite_frames** **(** **)** const
Get the :ref:`SpriteFrames<class_spriteframes>` resource, which contains all frames.
.. _class_AnimatedSprite_is_centered:
- :ref:`bool<class_bool>` **is_centered** **(** **)** const
Return true when centered. See :ref:`set_centered<class_AnimatedSprite_set_centered>`.
.. _class_AnimatedSprite_is_flipped_h:
- :ref:`bool<class_bool>` **is_flipped_h** **(** **)** const
Return true if sprite is flipped horizontally.
.. _class_AnimatedSprite_is_flipped_v:
- :ref:`bool<class_bool>` **is_flipped_v** **(** **)** const
Return true if sprite is flipped vertically.
.. _class_AnimatedSprite_set_centered:
- void **set_centered** **(** :ref:`bool<class_bool>` centered **)**
When turned on, offset at (0,0) is the center of the sprite, when off, the top-left corner is.
.. _class_AnimatedSprite_set_flip_h:
- void **set_flip_h** **(** :ref:`bool<class_bool>` flip_h **)**
If true, sprite is flipped horizontally.
.. _class_AnimatedSprite_set_flip_v:
- void **set_flip_v** **(** :ref:`bool<class_bool>` flip_v **)**
If true, sprite is flipped vertically.
.. _class_AnimatedSprite_set_frame:
- void **set_frame** **(** :ref:`int<class_int>` frame **)**
Set the visible sprite frame index (from the list of frames inside the :ref:`SpriteFrames<class_spriteframes>` resource).
.. _class_AnimatedSprite_set_modulate:
- void **set_modulate** **(** :ref:`Color<class_color>` modulate **)**
Change the color modulation (multiplication) for this sprite.
.. _class_AnimatedSprite_set_offset:
- void **set_offset** **(** :ref:`Vector2<class_vector2>` offset **)**
Set the offset of the sprite in the node origin. Position varies depending on whether it is centered or not.
.. _class_AnimatedSprite_set_sprite_frames:
- void **set_sprite_frames** **(** :ref:`SpriteFrames<class_spriteframes>` sprite_frames **)**
Set the :ref:`SpriteFrames<class_spriteframes>` resource, which contains all frames.

12
classes/class_animatedsprite3d.rst
View File

@@ -19,13 +19,13 @@ Member Functions
----------------
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_sprite_frames<class_AnimatedSprite3D_set_sprite_frames>` **(** :ref:`SpriteFrames<class_spriteframes>` sprite_frames **)** |
| :ref:`int<class_int>` | :ref:`get_frame<class_AnimatedSprite3D_get_frame>` **(** **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>` | :ref:`get_sprite_frames<class_AnimatedSprite3D_get_sprite_frames>` **(** **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_frame<class_AnimatedSprite3D_set_frame>` **(** :ref:`int<class_int>` frame **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_frame<class_AnimatedSprite3D_get_frame>` **(** **)** const |
| void | :ref:`set_sprite_frames<class_AnimatedSprite3D_set_sprite_frames>` **(** :ref:`SpriteFrames<class_spriteframes>` sprite_frames **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
Signals
@@ -36,9 +36,9 @@ Signals
Member Function Description
---------------------------
.. _class_AnimatedSprite3D_set_sprite_frames:
.. _class_AnimatedSprite3D_get_frame:
- void **set_sprite_frames** **(** :ref:`SpriteFrames<class_spriteframes>` sprite_frames **)**
- :ref:`int<class_int>` **get_frame** **(** **)** const
.. _class_AnimatedSprite3D_get_sprite_frames:
@@ -48,8 +48,8 @@ Member Function Description
- void **set_frame** **(** :ref:`int<class_int>` frame **)**
.. _class_AnimatedSprite3D_get_frame:
.. _class_AnimatedSprite3D_set_sprite_frames:
- :ref:`int<class_int>` **get_frame** **(** **)** const
- void **set_sprite_frames** **(** :ref:`SpriteFrames<class_spriteframes>` sprite_frames **)**

410
classes/class_animation.rst
View File

@@ -21,55 +21,17 @@ Member Functions
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`add_track<class_Animation_add_track>` **(** :ref:`int<class_int>` type, :ref:`int<class_int>` at_pos=-1 **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_track<class_Animation_remove_track>` **(** :ref:`int<class_int>` idx **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_track_count<class_Animation_get_track_count>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`track_get_type<class_Animation_track_get_type>` **(** :ref:`int<class_int>` idx **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`NodePath<class_nodepath>` | :ref:`track_get_path<class_Animation_track_get_path>` **(** :ref:`int<class_int>` idx **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_set_path<class_Animation_track_set_path>` **(** :ref:`int<class_int>` idx, :ref:`NodePath<class_nodepath>` path **)** |
| void | :ref:`clear<class_Animation_clear>` **(** **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`find_track<class_Animation_find_track>` **(** :ref:`NodePath<class_nodepath>` path **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_move_up<class_Animation_track_move_up>` **(** :ref:`int<class_int>` idx **)** |
| :ref:`float<class_float>` | :ref:`get_length<class_Animation_get_length>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_move_down<class_Animation_track_move_down>` **(** :ref:`int<class_int>` idx **)** |
| :ref:`float<class_float>` | :ref:`get_step<class_Animation_get_step>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`transform_track_insert_key<class_Animation_transform_track_insert_key>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time, :ref:`Vector3<class_vector3>` loc, :ref:`Quat<class_quat>` rot, :ref:`Vector3<class_vector3>` scale **)** |
| :ref:`int<class_int>` | :ref:`get_track_count<class_Animation_get_track_count>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_insert_key<class_Animation_track_insert_key>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time, var key, :ref:`float<class_float>` transition=1 **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_remove_key<class_Animation_track_remove_key>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_remove_key_at_pos<class_Animation_track_remove_key_at_pos>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` pos **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_set_key_value<class_Animation_track_set_key_value>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key, var value **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_set_key_transition<class_Animation_track_set_key_transition>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`float<class_float>` transition **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`track_get_key_transition<class_Animation_track_get_key_transition>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`track_get_key_count<class_Animation_track_get_key_count>` **(** :ref:`int<class_int>` idx **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_get_key_value<class_Animation_track_get_key_value>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`track_get_key_time<class_Animation_track_get_key_time>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`track_find_key<class_Animation_track_find_key>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time, :ref:`bool<class_bool>` exact=false **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_set_interpolation_type<class_Animation_track_set_interpolation_type>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` interpolation **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`track_get_interpolation_type<class_Animation_track_get_interpolation_type>` **(** :ref:`int<class_int>` idx **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`transform_track_interpolate<class_Animation_transform_track_interpolate>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`value_track_set_continuous<class_Animation_value_track_set_continuous>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` continuous **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`value_track_is_continuous<class_Animation_value_track_is_continuous>` **(** :ref:`int<class_int>` idx **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`IntArray<class_intarray>` | :ref:`value_track_get_key_indices<class_Animation_value_track_get_key_indices>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec, :ref:`float<class_float>` delta **)** const |
| :ref:`bool<class_bool>` | :ref:`has_loop<class_Animation_has_loop>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`IntArray<class_intarray>` | :ref:`method_track_get_key_indices<class_Animation_method_track_get_key_indices>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec, :ref:`float<class_float>` delta **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -77,30 +39,68 @@ Member Functions
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`method_track_get_params<class_Animation_method_track_get_params>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_length<class_Animation_set_length>` **(** :ref:`float<class_float>` time_sec **)** |
| void | :ref:`remove_track<class_Animation_remove_track>` **(** :ref:`int<class_int>` idx **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_length<class_Animation_get_length>` **(** **)** const |
| void | :ref:`set_length<class_Animation_set_length>` **(** :ref:`float<class_float>` time_sec **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_loop<class_Animation_set_loop>` **(** :ref:`bool<class_bool>` enabled **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_loop<class_Animation_has_loop>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_step<class_Animation_set_step>` **(** :ref:`float<class_float>` size_sec **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_step<class_Animation_get_step>` **(** **)** const |
| :ref:`int<class_int>` | :ref:`track_find_key<class_Animation_track_find_key>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time, :ref:`bool<class_bool>` exact=false **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_Animation_clear>` **(** **)** |
| :ref:`int<class_int>` | :ref:`track_get_interpolation_type<class_Animation_track_get_interpolation_type>` **(** :ref:`int<class_int>` idx **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`track_get_key_count<class_Animation_track_get_key_count>` **(** :ref:`int<class_int>` idx **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`track_get_key_time<class_Animation_track_get_key_time>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`track_get_key_transition<class_Animation_track_get_key_transition>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_get_key_value<class_Animation_track_get_key_value>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`NodePath<class_nodepath>` | :ref:`track_get_path<class_Animation_track_get_path>` **(** :ref:`int<class_int>` idx **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`track_get_type<class_Animation_track_get_type>` **(** :ref:`int<class_int>` idx **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_insert_key<class_Animation_track_insert_key>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time, var key, :ref:`float<class_float>` transition=1 **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_move_down<class_Animation_track_move_down>` **(** :ref:`int<class_int>` idx **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_move_up<class_Animation_track_move_up>` **(** :ref:`int<class_int>` idx **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_remove_key<class_Animation_track_remove_key>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_remove_key_at_pos<class_Animation_track_remove_key_at_pos>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` pos **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_set_interpolation_type<class_Animation_track_set_interpolation_type>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` interpolation **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_set_key_transition<class_Animation_track_set_key_transition>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`float<class_float>` transition **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_set_key_value<class_Animation_track_set_key_value>` **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key, var value **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`track_set_path<class_Animation_track_set_path>` **(** :ref:`int<class_int>` idx, :ref:`NodePath<class_nodepath>` path **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`transform_track_insert_key<class_Animation_transform_track_insert_key>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time, :ref:`Vector3<class_vector3>` loc, :ref:`Quat<class_quat>` rot, :ref:`Vector3<class_vector3>` scale **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`transform_track_interpolate<class_Animation_transform_track_interpolate>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`IntArray<class_intarray>` | :ref:`value_track_get_key_indices<class_Animation_value_track_get_key_indices>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec, :ref:`float<class_float>` delta **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`value_track_is_continuous<class_Animation_value_track_is_continuous>` **(** :ref:`int<class_int>` idx **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`value_track_set_continuous<class_Animation_value_track_set_continuous>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` continuous **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Numeric Constants
-----------------
- **TYPE_VALUE** = **0** --- Value tracks set values in node properties, but only those which can be Interpolated.
- **TYPE_TRANSFORM** = **1** --- Transform tracks are used to change node local transforms or skeleton pose bones. Transitions are Interpolated.
- **TYPE_METHOD** = **2** --- Method tracks call functions with given arguments per key.
- **INTERPOLATION_NEAREST** = **0** --- No interpolation (nearest value).
- **INTERPOLATION_LINEAR** = **1** --- Linear interpolation.
- **INTERPOLATION_CUBIC** = **2** --- Cubic interpolation.
- **TYPE_VALUE** = **0** --- Value tracks set values in node properties, but only those which can be Interpolated.
- **TYPE_TRANSFORM** = **1** --- Transform tracks are used to change node local transforms or skeleton pose bones. Transitions are Interpolated.
- **TYPE_METHOD** = **2** --- Method tracks call functions with given arguments per key.
Description
-----------
@@ -118,11 +118,25 @@ Member Function Description
Add a track to the Animation. The track type must be specified as any of the values in the TYPE\_\* enumeration.
.. _class_Animation_remove_track:
.. _class_Animation_clear:
- void **remove_track** **(** :ref:`int<class_int>` idx **)**
- void **clear** **(** **)**
Remove a track by specifying the track index.
Clear the animation (clear all tracks and reset all).
.. _class_Animation_find_track:
- :ref:`int<class_int>` **find_track** **(** :ref:`NodePath<class_nodepath>` path **)** const
.. _class_Animation_get_length:
- :ref:`float<class_float>` **get_length** **(** **)** const
Return the total length of the animation (in seconds).
.. _class_Animation_get_step:
- :ref:`float<class_float>` **get_step** **(** **)** const
.. _class_Animation_get_track_count:
@@ -130,141 +144,11 @@ Remove a track by specifying the track index.
Return the amount of tracks in the animation.
.. _class_Animation_track_get_type:
.. _class_Animation_has_loop:
- :ref:`int<class_int>` **track_get_type** **(** :ref:`int<class_int>` idx **)** const
- :ref:`bool<class_bool>` **has_loop** **(** **)** const
Get the type of a track.
.. _class_Animation_track_get_path:
- :ref:`NodePath<class_nodepath>` **track_get_path** **(** :ref:`int<class_int>` idx **)** const
Get the path of a track. for more information on the path format, see :ref:`track_set_path<class_Animation_track_set_path>`
.. _class_Animation_track_set_path:
- void **track_set_path** **(** :ref:`int<class_int>` idx, :ref:`NodePath<class_nodepath>` path **)**
Set the path of a track. Paths must be valid scene-tree paths to a node, and must be specified starting from the parent node of the node that will reproduce the animation. Tracks that control properties or bones must append their name after the path, separated by ":". Example: "character/skeleton:ankle" or "character/mesh:transform/local"
.. _class_Animation_find_track:
- :ref:`int<class_int>` **find_track** **(** :ref:`NodePath<class_nodepath>` path **)** const
.. _class_Animation_track_move_up:
- void **track_move_up** **(** :ref:`int<class_int>` idx **)**
Move a track up.
.. _class_Animation_track_move_down:
- void **track_move_down** **(** :ref:`int<class_int>` idx **)**
Move a track down.
.. _class_Animation_transform_track_insert_key:
- :ref:`int<class_int>` **transform_track_insert_key** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time, :ref:`Vector3<class_vector3>` loc, :ref:`Quat<class_quat>` rot, :ref:`Vector3<class_vector3>` scale **)**
Insert a transform key for a transform track.
.. _class_Animation_track_insert_key:
- void **track_insert_key** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time, var key, :ref:`float<class_float>` transition=1 **)**
Insert a generic key in a given track.
.. _class_Animation_track_remove_key:
- void **track_remove_key** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)**
Remove a key by index in a given track.
.. _class_Animation_track_remove_key_at_pos:
- void **track_remove_key_at_pos** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` pos **)**
Remove a key by position (seconds) in a given track.
.. _class_Animation_track_set_key_value:
- void **track_set_key_value** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key, var value **)**
Set the value of an existing key.
.. _class_Animation_track_set_key_transition:
- void **track_set_key_transition** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`float<class_float>` transition **)**
Set the transition curve (easing) for a specific key (see built-in math function "ease").
.. _class_Animation_track_get_key_transition:
- :ref:`float<class_float>` **track_get_key_transition** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const
Return the transition curve (easing) for a specific key (see built-in math function "ease").
.. _class_Animation_track_get_key_count:
- :ref:`int<class_int>` **track_get_key_count** **(** :ref:`int<class_int>` idx **)** const
Return the amount of keys in a given track.
.. _class_Animation_track_get_key_value:
- void **track_get_key_value** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const
Return the value of a given key in a given track.
.. _class_Animation_track_get_key_time:
- :ref:`float<class_float>` **track_get_key_time** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const
Return the time at which the key is located.
.. _class_Animation_track_find_key:
- :ref:`int<class_int>` **track_find_key** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time, :ref:`bool<class_bool>` exact=false **)** const
Find the key index by time in a given track. Optionally, only find it if the exact time is given.
.. _class_Animation_track_set_interpolation_type:
- void **track_set_interpolation_type** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` interpolation **)**
Set the interpolation type of a given track, from the INTERPOLATION\_\* enum.
.. _class_Animation_track_get_interpolation_type:
- :ref:`int<class_int>` **track_get_interpolation_type** **(** :ref:`int<class_int>` idx **)** const
Return the interpolation type of a given track, from the INTERPOLATION\_\* enum.
.. _class_Animation_transform_track_interpolate:
- :ref:`Array<class_array>` **transform_track_interpolate** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec **)** const
Return the interpolated value of a transform track at a given time (in seconds). An array consisting of 3 elements: position (:ref:`Vector3<class_vector3>`), rotation (:ref:`Quat<class_quat>`) and scale (:ref:`Vector3<class_vector3>`).
.. _class_Animation_value_track_set_continuous:
- void **value_track_set_continuous** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` continuous **)**
Enable or disable interpolation for a whole track. By default tracks are interpolated.
.. _class_Animation_value_track_is_continuous:
- :ref:`bool<class_bool>` **value_track_is_continuous** **(** :ref:`int<class_int>` idx **)** const
Return whether interpolation is enabled or disabled for a whole track. By default tracks are interpolated.
.. _class_Animation_value_track_get_key_indices:
- :ref:`IntArray<class_intarray>` **value_track_get_key_indices** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec, :ref:`float<class_float>` delta **)** const
Return all the key indices of a value track, given a position and delta time.
Return whether the animation has the loop flag set.
.. _class_Animation_method_track_get_key_indices:
@@ -284,42 +168,158 @@ Return the method name of a method track.
Return the arguments values to be called on a method track for a given key in a given track.
.. _class_Animation_remove_track:
- void **remove_track** **(** :ref:`int<class_int>` idx **)**
Remove a track by specifying the track index.
.. _class_Animation_set_length:
- void **set_length** **(** :ref:`float<class_float>` time_sec **)**
Set the total length of the animation (in seconds). Note that length is not delimited by the last key, as this one may be before or after the end to ensure correct interpolation and looping.
.. _class_Animation_get_length:
- :ref:`float<class_float>` **get_length** **(** **)** const
Return the total length of the animation (in seconds).
.. _class_Animation_set_loop:
- void **set_loop** **(** :ref:`bool<class_bool>` enabled **)**
Set a flag indicating that the animation must loop. This is uses for correct interpolation of animation cycles, and for hinting the player that it must restart the animation.
.. _class_Animation_has_loop:
- :ref:`bool<class_bool>` **has_loop** **(** **)** const
Return whether the animation has the loop flag set.
.. _class_Animation_set_step:
- void **set_step** **(** :ref:`float<class_float>` size_sec **)**
.. _class_Animation_get_step:
.. _class_Animation_track_find_key:
- :ref:`float<class_float>` **get_step** **(** **)** const
- :ref:`int<class_int>` **track_find_key** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time, :ref:`bool<class_bool>` exact=false **)** const
.. _class_Animation_clear:
Find the key index by time in a given track. Optionally, only find it if the exact time is given.
- void **clear** **(** **)**
.. _class_Animation_track_get_interpolation_type:
Clear the animation (clear all tracks and reset all).
- :ref:`int<class_int>` **track_get_interpolation_type** **(** :ref:`int<class_int>` idx **)** const
Return the interpolation type of a given track, from the INTERPOLATION\_\* enum.
.. _class_Animation_track_get_key_count:
- :ref:`int<class_int>` **track_get_key_count** **(** :ref:`int<class_int>` idx **)** const
Return the amount of keys in a given track.
.. _class_Animation_track_get_key_time:
- :ref:`float<class_float>` **track_get_key_time** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const
Return the time at which the key is located.
.. _class_Animation_track_get_key_transition:
- :ref:`float<class_float>` **track_get_key_transition** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const
Return the transition curve (easing) for a specific key (see built-in math function "ease").
.. _class_Animation_track_get_key_value:
- void **track_get_key_value** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)** const
Return the value of a given key in a given track.
.. _class_Animation_track_get_path:
- :ref:`NodePath<class_nodepath>` **track_get_path** **(** :ref:`int<class_int>` idx **)** const
Get the path of a track. for more information on the path format, see :ref:`track_set_path<class_Animation_track_set_path>`
.. _class_Animation_track_get_type:
- :ref:`int<class_int>` **track_get_type** **(** :ref:`int<class_int>` idx **)** const
Get the type of a track.
.. _class_Animation_track_insert_key:
- void **track_insert_key** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time, var key, :ref:`float<class_float>` transition=1 **)**
Insert a generic key in a given track.
.. _class_Animation_track_move_down:
- void **track_move_down** **(** :ref:`int<class_int>` idx **)**
Move a track down.
.. _class_Animation_track_move_up:
- void **track_move_up** **(** :ref:`int<class_int>` idx **)**
Move a track up.
.. _class_Animation_track_remove_key:
- void **track_remove_key** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx **)**
Remove a key by index in a given track.
.. _class_Animation_track_remove_key_at_pos:
- void **track_remove_key_at_pos** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` pos **)**
Remove a key by position (seconds) in a given track.
.. _class_Animation_track_set_interpolation_type:
- void **track_set_interpolation_type** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` interpolation **)**
Set the interpolation type of a given track, from the INTERPOLATION\_\* enum.
.. _class_Animation_track_set_key_transition:
- void **track_set_key_transition** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key_idx, :ref:`float<class_float>` transition **)**
Set the transition curve (easing) for a specific key (see built-in math function "ease").
.. _class_Animation_track_set_key_value:
- void **track_set_key_value** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` key, var value **)**
Set the value of an existing key.
.. _class_Animation_track_set_path:
- void **track_set_path** **(** :ref:`int<class_int>` idx, :ref:`NodePath<class_nodepath>` path **)**
Set the path of a track. Paths must be valid scene-tree paths to a node, and must be specified starting from the parent node of the node that will reproduce the animation. Tracks that control properties or bones must append their name after the path, separated by ":". Example: "character/skeleton:ankle" or "character/mesh:transform/local"
.. _class_Animation_transform_track_insert_key:
- :ref:`int<class_int>` **transform_track_insert_key** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time, :ref:`Vector3<class_vector3>` loc, :ref:`Quat<class_quat>` rot, :ref:`Vector3<class_vector3>` scale **)**
Insert a transform key for a transform track.
.. _class_Animation_transform_track_interpolate:
- :ref:`Array<class_array>` **transform_track_interpolate** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec **)** const
Return the interpolated value of a transform track at a given time (in seconds). An array consisting of 3 elements: position (:ref:`Vector3<class_vector3>`), rotation (:ref:`Quat<class_quat>`) and scale (:ref:`Vector3<class_vector3>`).
.. _class_Animation_value_track_get_key_indices:
- :ref:`IntArray<class_intarray>` **value_track_get_key_indices** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` time_sec, :ref:`float<class_float>` delta **)** const
Return all the key indices of a value track, given a position and delta time.
.. _class_Animation_value_track_is_continuous:
- :ref:`bool<class_bool>` **value_track_is_continuous** **(** :ref:`int<class_int>` idx **)** const
Return whether interpolation is enabled or disabled for a whole track. By default tracks are interpolated.
.. _class_Animation_value_track_set_continuous:
- void **value_track_set_continuous** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` continuous **)**
Enable or disable interpolation for a whole track. By default tracks are interpolated.

394
classes/class_animationplayer.rst
View File

@@ -21,79 +21,79 @@ Member Functions
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`add_animation<class_AnimationPlayer_add_animation>` **(** :ref:`String<class_string>` name, :ref:`Animation<class_animation>` animation **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_animation<class_AnimationPlayer_remove_animation>` **(** :ref:`String<class_string>` name **)** |
| void | :ref:`advance<class_AnimationPlayer_advance>` **(** :ref:`float<class_float>` delta **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`rename_animation<class_AnimationPlayer_rename_animation>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` newname **)** |
| :ref:`String<class_string>` | :ref:`animation_get_next<class_AnimationPlayer_animation_get_next>` **(** :ref:`String<class_string>` anim_from **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_animation<class_AnimationPlayer_has_animation>` **(** :ref:`String<class_string>` name **)** const |
| void | :ref:`animation_set_next<class_AnimationPlayer_animation_set_next>` **(** :ref:`String<class_string>` anim_from, :ref:`String<class_string>` anim_to **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_caches<class_AnimationPlayer_clear_caches>` **(** **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_queue<class_AnimationPlayer_clear_queue>` **(** **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`find_animation<class_AnimationPlayer_find_animation>` **(** :ref:`Animation<class_animation>` animation **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Animation<class_animation>` | :ref:`get_animation<class_AnimationPlayer_get_animation>` **(** :ref:`String<class_string>` name **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`StringArray<class_stringarray>` | :ref:`get_animation_list<class_AnimationPlayer_get_animation_list>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`animation_set_next<class_AnimationPlayer_animation_set_next>` **(** :ref:`String<class_string>` anim_from, :ref:`String<class_string>` anim_to **)** |
| :ref:`int<class_int>` | :ref:`get_animation_process_mode<class_AnimationPlayer_get_animation_process_mode>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`animation_get_next<class_AnimationPlayer_animation_get_next>` **(** :ref:`String<class_string>` anim_from **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_blend_time<class_AnimationPlayer_set_blend_time>` **(** :ref:`String<class_string>` anim_from, :ref:`String<class_string>` anim_to, :ref:`float<class_float>` sec **)** |
| :ref:`String<class_string>` | :ref:`get_autoplay<class_AnimationPlayer_get_autoplay>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_blend_time<class_AnimationPlayer_get_blend_time>` **(** :ref:`String<class_string>` anim_from, :ref:`String<class_string>` anim_to **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_default_blend_time<class_AnimationPlayer_set_default_blend_time>` **(** :ref:`float<class_float>` sec **)** |
| :ref:`String<class_string>` | :ref:`get_current_animation<class_AnimationPlayer_get_current_animation>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_current_animation_length<class_AnimationPlayer_get_current_animation_length>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_current_animation_pos<class_AnimationPlayer_get_current_animation_pos>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_default_blend_time<class_AnimationPlayer_get_default_blend_time>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_pos<class_AnimationPlayer_get_pos>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`NodePath<class_nodepath>` | :ref:`get_root<class_AnimationPlayer_get_root>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_speed<class_AnimationPlayer_get_speed>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_animation<class_AnimationPlayer_has_animation>` **(** :ref:`String<class_string>` name **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_active<class_AnimationPlayer_is_active>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AnimationPlayer_is_playing>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`play<class_AnimationPlayer_play>` **(** :ref:`String<class_string>` name="", :ref:`float<class_float>` custom_blend=-1, :ref:`float<class_float>` custom_speed=1, :ref:`bool<class_bool>` from_end=false **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`play_backwards<class_AnimationPlayer_play_backwards>` **(** :ref:`String<class_string>` name="", :ref:`float<class_float>` custom_blend=-1 **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`stop<class_AnimationPlayer_stop>` **(** :ref:`bool<class_bool>` reset=true **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`stop_all<class_AnimationPlayer_stop_all>` **(** **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AnimationPlayer_is_playing>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_current_animation<class_AnimationPlayer_set_current_animation>` **(** :ref:`String<class_string>` anim **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_current_animation<class_AnimationPlayer_get_current_animation>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`queue<class_AnimationPlayer_queue>` **(** :ref:`String<class_string>` name **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_queue<class_AnimationPlayer_clear_queue>` **(** **)** |
| void | :ref:`remove_animation<class_AnimationPlayer_remove_animation>` **(** :ref:`String<class_string>` name **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_active<class_AnimationPlayer_set_active>` **(** :ref:`bool<class_bool>` active **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_active<class_AnimationPlayer_is_active>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_speed<class_AnimationPlayer_set_speed>` **(** :ref:`float<class_float>` speed **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_speed<class_AnimationPlayer_get_speed>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_autoplay<class_AnimationPlayer_set_autoplay>` **(** :ref:`String<class_string>` name **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_autoplay<class_AnimationPlayer_get_autoplay>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_root<class_AnimationPlayer_set_root>` **(** :ref:`NodePath<class_nodepath>` path **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`NodePath<class_nodepath>` | :ref:`get_root<class_AnimationPlayer_get_root>` **(** **)** const |
| void | :ref:`rename_animation<class_AnimationPlayer_rename_animation>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` newname **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`seek<class_AnimationPlayer_seek>` **(** :ref:`float<class_float>` pos_sec, :ref:`bool<class_bool>` update=false **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_pos<class_AnimationPlayer_get_pos>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`find_animation<class_AnimationPlayer_find_animation>` **(** :ref:`Animation<class_animation>` animation **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_caches<class_AnimationPlayer_clear_caches>` **(** **)** |
| void | :ref:`set_active<class_AnimationPlayer_set_active>` **(** :ref:`bool<class_bool>` active **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_animation_process_mode<class_AnimationPlayer_set_animation_process_mode>` **(** :ref:`int<class_int>` mode **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_animation_process_mode<class_AnimationPlayer_get_animation_process_mode>` **(** **)** const |
| void | :ref:`set_autoplay<class_AnimationPlayer_set_autoplay>` **(** :ref:`String<class_string>` name **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_current_animation_pos<class_AnimationPlayer_get_current_animation_pos>` **(** **)** const |
| void | :ref:`set_blend_time<class_AnimationPlayer_set_blend_time>` **(** :ref:`String<class_string>` anim_from, :ref:`String<class_string>` anim_to, :ref:`float<class_float>` sec **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_current_animation_length<class_AnimationPlayer_get_current_animation_length>` **(** **)** const |
| void | :ref:`set_current_animation<class_AnimationPlayer_set_current_animation>` **(** :ref:`String<class_string>` anim **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`advance<class_AnimationPlayer_advance>` **(** :ref:`float<class_float>` delta **)** |
| void | :ref:`set_default_blend_time<class_AnimationPlayer_set_default_blend_time>` **(** :ref:`float<class_float>` sec **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_root<class_AnimationPlayer_set_root>` **(** :ref:`NodePath<class_nodepath>` path **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_speed<class_AnimationPlayer_set_speed>` **(** :ref:`float<class_float>` speed **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`stop<class_AnimationPlayer_stop>` **(** :ref:`bool<class_bool>` reset=true **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`stop_all<class_AnimationPlayer_stop_all>` **(** **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
@@ -122,23 +122,37 @@ Member Function Description
Add an animation resource to the player, which will be later referenced by the "name" argument.
.. _class_AnimationPlayer_remove_animation:
.. _class_AnimationPlayer_advance:
- void **remove_animation** **(** :ref:`String<class_string>` name **)**
- void **advance** **(** :ref:`float<class_float>` delta **)**
Remove an animation from the player (by supplying the same name used to add it).
Used to skip ahead or skip back in an animation. Delta is the time in seconds to skip.
.. _class_AnimationPlayer_rename_animation:
.. _class_AnimationPlayer_animation_get_next:
- void **rename_animation** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` newname **)**
- :ref:`String<class_string>` **animation_get_next** **(** :ref:`String<class_string>` anim_from **)** const
Rename an existing animation.
.. _class_AnimationPlayer_animation_set_next:
.. _class_AnimationPlayer_has_animation:
- void **animation_set_next** **(** :ref:`String<class_string>` anim_from, :ref:`String<class_string>` anim_to **)**
- :ref:`bool<class_bool>` **has_animation** **(** :ref:`String<class_string>` name **)** const
.. _class_AnimationPlayer_clear_caches:
Request whether an :ref:`Animation<class_animation>` name exist within the player.
- void **clear_caches** **(** **)**
The animation player creates caches for faster access to the nodes it will animate. However, if a specific node is removed, it may not notice it, so clear_caches will force the player to search for the nodes again.
.. _class_AnimationPlayer_clear_queue:
- void **clear_queue** **(** **)**
If animations are queued to play, clear them.
.. _class_AnimationPlayer_find_animation:
- :ref:`String<class_string>` **find_animation** **(** :ref:`Animation<class_animation>` animation **)** const
Find an animation name by resource.
.. _class_AnimationPlayer_get_animation:
@@ -152,19 +166,17 @@ Get an :ref:`Animation<class_animation>` resource by requesting a name.
Get the list of names of the animations stored in the player.
.. _class_AnimationPlayer_animation_set_next:
.. _class_AnimationPlayer_get_animation_process_mode:
- void **animation_set_next** **(** :ref:`String<class_string>` anim_from, :ref:`String<class_string>` anim_to **)**
- :ref:`int<class_int>` **get_animation_process_mode** **(** **)** const
.. _class_AnimationPlayer_animation_get_next:
Return the mode in which the animation player processes. See :ref:`set_animation_process_mode<class_AnimationPlayer_set_animation_process_mode>`.
- :ref:`String<class_string>` **animation_get_next** **(** :ref:`String<class_string>` anim_from **)** const
.. _class_AnimationPlayer_get_autoplay:
.. _class_AnimationPlayer_set_blend_time:
- :ref:`String<class_string>` **get_autoplay** **(** **)** const
- void **set_blend_time** **(** :ref:`String<class_string>` anim_from, :ref:`String<class_string>` anim_to, :ref:`float<class_float>` sec **)**
Specify a blend time (in seconds) between two animations, referenced by their names.
Return the name of the animation that will be automatically played when the scene is loaded.
.. _class_AnimationPlayer_get_blend_time:
@@ -172,11 +184,23 @@ Specify a blend time (in seconds) between two animations, referenced by their na
Get the blend time between two animations, referenced by their names.
.. _class_AnimationPlayer_set_default_blend_time:
.. _class_AnimationPlayer_get_current_animation:
- void **set_default_blend_time** **(** :ref:`float<class_float>` sec **)**
- :ref:`String<class_string>` **get_current_animation** **(** **)** const
Set the default blend time between animations.
Return the name of the animation being played.
.. _class_AnimationPlayer_get_current_animation_length:
- :ref:`float<class_float>` **get_current_animation_length** **(** **)** const
Get the length (in seconds) of the currently being played animation.
.. _class_AnimationPlayer_get_current_animation_pos:
- :ref:`float<class_float>` **get_current_animation_pos** **(** **)** const
Get the position (in seconds) of the currently being played animation.
.. _class_AnimationPlayer_get_default_blend_time:
@@ -184,6 +208,42 @@ Set the default blend time between animations.
Return the default blend time between animations.
.. _class_AnimationPlayer_get_pos:
- :ref:`float<class_float>` **get_pos** **(** **)** const
Return the playback position (in seconds) in an animation channel (or channel 0 if none is provided).
.. _class_AnimationPlayer_get_root:
- :ref:`NodePath<class_nodepath>` **get_root** **(** **)** const
Return path to root node (see :ref:`set_root<class_AnimationPlayer_set_root>`).
.. _class_AnimationPlayer_get_speed:
- :ref:`float<class_float>` **get_speed** **(** **)** const
Get the speed scaling ratio in a given animation channel (or channel 0 if none is provided). Default ratio is *1* (no scaling).
.. _class_AnimationPlayer_has_animation:
- :ref:`bool<class_bool>` **has_animation** **(** :ref:`String<class_string>` name **)** const
Request whether an :ref:`Animation<class_animation>` name exist within the player.
.. _class_AnimationPlayer_is_active:
- :ref:`bool<class_bool>` **is_active** **(** **)** const
Return true if the player is active.
.. _class_AnimationPlayer_is_playing:
- :ref:`bool<class_bool>` **is_playing** **(** **)** const
Return whether an animation is playing.
.. _class_AnimationPlayer_play:
- void **play** **(** :ref:`String<class_string>` name="", :ref:`float<class_float>` custom_blend=-1, :ref:`float<class_float>` custom_speed=1, :ref:`bool<class_bool>` from_end=false **)**
@@ -196,6 +256,80 @@ Play a given animation by the animation name. Custom speed and blend times can b
Play a given animation by the animation name in reverse.
.. _class_AnimationPlayer_queue:
- void **queue** **(** :ref:`String<class_string>` name **)**
Queue an animation for playback once the current one is done.
.. _class_AnimationPlayer_remove_animation:
- void **remove_animation** **(** :ref:`String<class_string>` name **)**
Remove an animation from the player (by supplying the same name used to add it).
.. _class_AnimationPlayer_rename_animation:
- void **rename_animation** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` newname **)**
Rename an existing animation.
.. _class_AnimationPlayer_seek:
- void **seek** **(** :ref:`float<class_float>` pos_sec, :ref:`bool<class_bool>` update=false **)**
Seek the animation to a given position in time (in seconds). If 'update' is true, the animation will be updated too, otherwise it will be updated at process time.
.. _class_AnimationPlayer_set_active:
- void **set_active** **(** :ref:`bool<class_bool>` active **)**
Set the player as active (playing). If false, it
will do nothing.
.. _class_AnimationPlayer_set_animation_process_mode:
- void **set_animation_process_mode** **(** :ref:`int<class_int>` mode **)**
Set the mode in which the animation player processes. By default, it processes on idle time (framerate dependent), but using fixed time works well for animating static collision bodies in 2D and 3D. See enum ANIMATION_PROCESS\_\*.
.. _class_AnimationPlayer_set_autoplay:
- void **set_autoplay** **(** :ref:`String<class_string>` name **)**
Set the name of the animation that will be automatically played when the scene is loaded.
.. _class_AnimationPlayer_set_blend_time:
- void **set_blend_time** **(** :ref:`String<class_string>` anim_from, :ref:`String<class_string>` anim_to, :ref:`float<class_float>` sec **)**
Specify a blend time (in seconds) between two animations, referenced by their names.
.. _class_AnimationPlayer_set_current_animation:
- void **set_current_animation** **(** :ref:`String<class_string>` anim **)**
Set the current animation (even if no playback occurs). Using set_current_animation() and set_active() are similar to calling play().
.. _class_AnimationPlayer_set_default_blend_time:
- void **set_default_blend_time** **(** :ref:`float<class_float>` sec **)**
Set the default blend time between animations.
.. _class_AnimationPlayer_set_root:
- void **set_root** **(** :ref:`NodePath<class_nodepath>` path **)**
AnimationPlayer resolves animation track paths from this node (which is relative to itself), by default root is "..", but it can be changed.
.. _class_AnimationPlayer_set_speed:
- void **set_speed** **(** :ref:`float<class_float>` speed **)**
Set a speed scaling ratio in a given animation channel (or channel 0 if none is provided). Default ratio is *1* (no scaling).
.. _class_AnimationPlayer_stop:
- void **stop** **(** :ref:`bool<class_bool>` reset=true **)**
@@ -208,138 +342,4 @@ Stop the currently playing animation.
Stop playback of animations (deprecated).
.. _class_AnimationPlayer_is_playing:
- :ref:`bool<class_bool>` **is_playing** **(** **)** const
Return whether an animation is playing.
.. _class_AnimationPlayer_set_current_animation:
- void **set_current_animation** **(** :ref:`String<class_string>` anim **)**
Set the current animation (even if no playback occurs). Using set_current_animation() and set_active() are similar to calling play().
.. _class_AnimationPlayer_get_current_animation:
- :ref:`String<class_string>` **get_current_animation** **(** **)** const
Return the name of the animation being played.
.. _class_AnimationPlayer_queue:
- void **queue** **(** :ref:`String<class_string>` name **)**
Queue an animation for playback once the current one is done.
.. _class_AnimationPlayer_clear_queue:
- void **clear_queue** **(** **)**
If animations are queued to play, clear them.
.. _class_AnimationPlayer_set_active:
- void **set_active** **(** :ref:`bool<class_bool>` active **)**
Set the player as active (playing). If false, it
will do nothing.
.. _class_AnimationPlayer_is_active:
- :ref:`bool<class_bool>` **is_active** **(** **)** const
Return true if the player is active.
.. _class_AnimationPlayer_set_speed:
- void **set_speed** **(** :ref:`float<class_float>` speed **)**
Set a speed scaling ratio in a given animation channel (or channel 0 if none is provided). Default ratio is *1* (no scaling).
.. _class_AnimationPlayer_get_speed:
- :ref:`float<class_float>` **get_speed** **(** **)** const
Get the speed scaling ratio in a given animation channel (or channel 0 if none is provided). Default ratio is *1* (no scaling).
.. _class_AnimationPlayer_set_autoplay:
- void **set_autoplay** **(** :ref:`String<class_string>` name **)**
Set the name of the animation that will be automatically played when the scene is loaded.
.. _class_AnimationPlayer_get_autoplay:
- :ref:`String<class_string>` **get_autoplay** **(** **)** const
Return the name of the animation that will be automatically played when the scene is loaded.
.. _class_AnimationPlayer_set_root:
- void **set_root** **(** :ref:`NodePath<class_nodepath>` path **)**
AnimationPlayer resolves animation track paths from this node (which is relative to itself), by default root is "..", but it can be changed.
.. _class_AnimationPlayer_get_root:
- :ref:`NodePath<class_nodepath>` **get_root** **(** **)** const
Return path to root node (see :ref:`set_root<class_AnimationPlayer_set_root>`).
.. _class_AnimationPlayer_seek:
- void **seek** **(** :ref:`float<class_float>` pos_sec, :ref:`bool<class_bool>` update=false **)**
Seek the animation to a given position in time (in seconds). If 'update' is true, the animation will be updated too, otherwise it will be updated at process time.
.. _class_AnimationPlayer_get_pos:
- :ref:`float<class_float>` **get_pos** **(** **)** const
Return the playback position (in seconds) in an animation channel (or channel 0 if none is provided).
.. _class_AnimationPlayer_find_animation:
- :ref:`String<class_string>` **find_animation** **(** :ref:`Animation<class_animation>` animation **)** const
Find an animation name by resource.
.. _class_AnimationPlayer_clear_caches:
- void **clear_caches** **(** **)**
The animation player creates caches for faster access to the nodes it will animate. However, if a specific node is removed, it may not notice it, so clear_caches will force the player to search for the nodes again.
.. _class_AnimationPlayer_set_animation_process_mode:
- void **set_animation_process_mode** **(** :ref:`int<class_int>` mode **)**
Set the mode in which the animation player processes. By default, it processes on idle time (framerate dependent), but using fixed time works well for animating static collision bodies in 2D and 3D. See enum ANIMATION_PROCESS\_\*.
.. _class_AnimationPlayer_get_animation_process_mode:
- :ref:`int<class_int>` **get_animation_process_mode** **(** **)** const
Return the mode in which the animation player processes. See :ref:`set_animation_process_mode<class_AnimationPlayer_set_animation_process_mode>`.
.. _class_AnimationPlayer_get_current_animation_pos:
- :ref:`float<class_float>` **get_current_animation_pos** **(** **)** const
Get the position (in seconds) of the currently being played animation.
.. _class_AnimationPlayer_get_current_animation_length:
- :ref:`float<class_float>` **get_current_animation_length** **(** **)** const
Get the length (in seconds) of the currently being played animation.
.. _class_AnimationPlayer_advance:
- void **advance** **(** :ref:`float<class_float>` delta **)**
Used to skip ahead or skip back in an animation. Delta is the time in seconds to skip.

478
classes/class_animationtreeplayer.rst
View File

@@ -21,129 +21,129 @@ Member Functions
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_node<class_AnimationTreePlayer_add_node>` **(** :ref:`int<class_int>` type, :ref:`String<class_string>` id **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`advance<class_AnimationTreePlayer_advance>` **(** :ref:`float<class_float>` delta **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Animation<class_animation>` | :ref:`animation_node_get_animation<class_AnimationTreePlayer_animation_node_get_animation>` **(** :ref:`String<class_string>` id **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`animation_node_get_master_animation<class_AnimationTreePlayer_animation_node_get_master_animation>` **(** :ref:`String<class_string>` id **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`animation_node_set_animation<class_AnimationTreePlayer_animation_node_set_animation>` **(** :ref:`String<class_string>` id, :ref:`Animation<class_animation>` animation **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`animation_node_set_master_animation<class_AnimationTreePlayer_animation_node_set_master_animation>` **(** :ref:`String<class_string>` id, :ref:`String<class_string>` source **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`blend2_node_get_amount<class_AnimationTreePlayer_blend2_node_get_amount>` **(** :ref:`String<class_string>` id **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`blend2_node_set_amount<class_AnimationTreePlayer_blend2_node_set_amount>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` blend **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`blend2_node_set_filter_path<class_AnimationTreePlayer_blend2_node_set_filter_path>` **(** :ref:`String<class_string>` id, :ref:`NodePath<class_nodepath>` path, :ref:`bool<class_bool>` enable **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`blend3_node_get_amount<class_AnimationTreePlayer_blend3_node_get_amount>` **(** :ref:`String<class_string>` id **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`blend3_node_set_amount<class_AnimationTreePlayer_blend3_node_set_amount>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` blend **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`blend4_node_get_amount<class_AnimationTreePlayer_blend4_node_get_amount>` **(** :ref:`String<class_string>` id **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`blend4_node_set_amount<class_AnimationTreePlayer_blend4_node_set_amount>` **(** :ref:`String<class_string>` id, :ref:`Vector2<class_vector2>` blend **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`connect<class_AnimationTreePlayer_connect>` **(** :ref:`String<class_string>` id, :ref:`String<class_string>` dst_id, :ref:`int<class_int>` dst_input_idx **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`disconnect<class_AnimationTreePlayer_disconnect>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` dst_input_idx **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_animation_process_mode<class_AnimationTreePlayer_get_animation_process_mode>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`NodePath<class_nodepath>` | :ref:`get_base_path<class_AnimationTreePlayer_get_base_path>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`NodePath<class_nodepath>` | :ref:`get_master_player<class_AnimationTreePlayer_get_master_player>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`StringArray<class_stringarray>` | :ref:`get_node_list<class_AnimationTreePlayer_get_node_list>` **(** **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_active<class_AnimationTreePlayer_is_active>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_connected<class_AnimationTreePlayer_is_connected>` **(** :ref:`String<class_string>` id, :ref:`String<class_string>` dst_id, :ref:`int<class_int>` dst_input_idx **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`mix_node_get_amount<class_AnimationTreePlayer_mix_node_get_amount>` **(** :ref:`String<class_string>` id **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`mix_node_set_amount<class_AnimationTreePlayer_mix_node_set_amount>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` ratio **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`node_exists<class_AnimationTreePlayer_node_exists>` **(** :ref:`String<class_string>` node **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`node_rename<class_AnimationTreePlayer_node_rename>` **(** :ref:`String<class_string>` node, :ref:`String<class_string>` new_name **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`node_get_type<class_AnimationTreePlayer_node_get_type>` **(** :ref:`String<class_string>` id **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`node_get_input_count<class_AnimationTreePlayer_node_get_input_count>` **(** :ref:`String<class_string>` id **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`node_get_input_source<class_AnimationTreePlayer_node_get_input_source>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` idx **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`animation_node_set_animation<class_AnimationTreePlayer_animation_node_set_animation>` **(** :ref:`String<class_string>` id, :ref:`Animation<class_animation>` animation **)** |
| :ref:`Vector2<class_vector2>` | :ref:`node_get_pos<class_AnimationTreePlayer_node_get_pos>` **(** :ref:`String<class_string>` id **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Animation<class_animation>` | :ref:`animation_node_get_animation<class_AnimationTreePlayer_animation_node_get_animation>` **(** :ref:`String<class_string>` id **)** const |
| :ref:`int<class_int>` | :ref:`node_get_type<class_AnimationTreePlayer_node_get_type>` **(** :ref:`String<class_string>` id **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`animation_node_set_master_animation<class_AnimationTreePlayer_animation_node_set_master_animation>` **(** :ref:`String<class_string>` id, :ref:`String<class_string>` source **)** |
| :ref:`int<class_int>` | :ref:`node_rename<class_AnimationTreePlayer_node_rename>` **(** :ref:`String<class_string>` node, :ref:`String<class_string>` new_name **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`animation_node_get_master_animation<class_AnimationTreePlayer_animation_node_get_master_animation>` **(** :ref:`String<class_string>` id **)** const |
| void | :ref:`node_set_pos<class_AnimationTreePlayer_node_set_pos>` **(** :ref:`String<class_string>` id, :ref:`Vector2<class_vector2>` screen_pos **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`oneshot_node_set_fadein_time<class_AnimationTreePlayer_oneshot_node_set_fadein_time>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` time_sec **)** |
| :ref:`float<class_float>` | :ref:`oneshot_node_get_autorestart_delay<class_AnimationTreePlayer_oneshot_node_get_autorestart_delay>` **(** :ref:`String<class_string>` id **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`oneshot_node_get_autorestart_random_delay<class_AnimationTreePlayer_oneshot_node_get_autorestart_random_delay>` **(** :ref:`String<class_string>` id **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`oneshot_node_get_fadein_time<class_AnimationTreePlayer_oneshot_node_get_fadein_time>` **(** :ref:`String<class_string>` id **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`oneshot_node_set_fadeout_time<class_AnimationTreePlayer_oneshot_node_set_fadeout_time>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` time_sec **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`oneshot_node_get_fadeout_time<class_AnimationTreePlayer_oneshot_node_get_fadeout_time>` **(** :ref:`String<class_string>` id **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`oneshot_node_has_autorestart<class_AnimationTreePlayer_oneshot_node_has_autorestart>` **(** :ref:`String<class_string>` id **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`oneshot_node_is_active<class_AnimationTreePlayer_oneshot_node_is_active>` **(** :ref:`String<class_string>` id **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`oneshot_node_set_autorestart<class_AnimationTreePlayer_oneshot_node_set_autorestart>` **(** :ref:`String<class_string>` id, :ref:`bool<class_bool>` enable **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`oneshot_node_set_autorestart_delay<class_AnimationTreePlayer_oneshot_node_set_autorestart_delay>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` delay_sec **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`oneshot_node_set_autorestart_random_delay<class_AnimationTreePlayer_oneshot_node_set_autorestart_random_delay>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` rand_sec **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`oneshot_node_has_autorestart<class_AnimationTreePlayer_oneshot_node_has_autorestart>` **(** :ref:`String<class_string>` id **)** const |
| void | :ref:`oneshot_node_set_fadein_time<class_AnimationTreePlayer_oneshot_node_set_fadein_time>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` time_sec **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`oneshot_node_get_autorestart_delay<class_AnimationTreePlayer_oneshot_node_get_autorestart_delay>` **(** :ref:`String<class_string>` id **)** const |
| void | :ref:`oneshot_node_set_fadeout_time<class_AnimationTreePlayer_oneshot_node_set_fadeout_time>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` time_sec **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`oneshot_node_get_autorestart_random_delay<class_AnimationTreePlayer_oneshot_node_get_autorestart_random_delay>` **(** :ref:`String<class_string>` id **)** const |
| void | :ref:`oneshot_node_set_filter_path<class_AnimationTreePlayer_oneshot_node_set_filter_path>` **(** :ref:`String<class_string>` id, :ref:`NodePath<class_nodepath>` path, :ref:`bool<class_bool>` enable **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`oneshot_node_start<class_AnimationTreePlayer_oneshot_node_start>` **(** :ref:`String<class_string>` id **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`oneshot_node_stop<class_AnimationTreePlayer_oneshot_node_stop>` **(** :ref:`String<class_string>` id **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`oneshot_node_is_active<class_AnimationTreePlayer_oneshot_node_is_active>` **(** :ref:`String<class_string>` id **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`oneshot_node_set_filter_path<class_AnimationTreePlayer_oneshot_node_set_filter_path>` **(** :ref:`String<class_string>` id, :ref:`NodePath<class_nodepath>` path, :ref:`bool<class_bool>` enable **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`mix_node_set_amount<class_AnimationTreePlayer_mix_node_set_amount>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` ratio **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`mix_node_get_amount<class_AnimationTreePlayer_mix_node_get_amount>` **(** :ref:`String<class_string>` id **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`blend2_node_set_amount<class_AnimationTreePlayer_blend2_node_set_amount>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` blend **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`blend2_node_get_amount<class_AnimationTreePlayer_blend2_node_get_amount>` **(** :ref:`String<class_string>` id **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`blend2_node_set_filter_path<class_AnimationTreePlayer_blend2_node_set_filter_path>` **(** :ref:`String<class_string>` id, :ref:`NodePath<class_nodepath>` path, :ref:`bool<class_bool>` enable **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`blend3_node_set_amount<class_AnimationTreePlayer_blend3_node_set_amount>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` blend **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`blend3_node_get_amount<class_AnimationTreePlayer_blend3_node_get_amount>` **(** :ref:`String<class_string>` id **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`blend4_node_set_amount<class_AnimationTreePlayer_blend4_node_set_amount>` **(** :ref:`String<class_string>` id, :ref:`Vector2<class_vector2>` blend **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`blend4_node_get_amount<class_AnimationTreePlayer_blend4_node_get_amount>` **(** :ref:`String<class_string>` id **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`timescale_node_set_scale<class_AnimationTreePlayer_timescale_node_set_scale>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` scale **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`timescale_node_get_scale<class_AnimationTreePlayer_timescale_node_get_scale>` **(** :ref:`String<class_string>` id **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`timeseek_node_seek<class_AnimationTreePlayer_timeseek_node_seek>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` pos_sec **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`transition_node_set_input_count<class_AnimationTreePlayer_transition_node_set_input_count>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` count **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`transition_node_get_input_count<class_AnimationTreePlayer_transition_node_get_input_count>` **(** :ref:`String<class_string>` id **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`transition_node_delete_input<class_AnimationTreePlayer_transition_node_delete_input>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`transition_node_set_input_auto_advance<class_AnimationTreePlayer_transition_node_set_input_auto_advance>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx, :ref:`bool<class_bool>` enable **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`transition_node_has_input_auto_advance<class_AnimationTreePlayer_transition_node_has_input_auto_advance>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`transition_node_set_xfade_time<class_AnimationTreePlayer_transition_node_set_xfade_time>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` time_sec **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`transition_node_get_xfade_time<class_AnimationTreePlayer_transition_node_get_xfade_time>` **(** :ref:`String<class_string>` id **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`transition_node_set_current<class_AnimationTreePlayer_transition_node_set_current>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`transition_node_get_current<class_AnimationTreePlayer_transition_node_get_current>` **(** :ref:`String<class_string>` id **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`node_set_pos<class_AnimationTreePlayer_node_set_pos>` **(** :ref:`String<class_string>` id, :ref:`Vector2<class_vector2>` screen_pos **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`node_get_pos<class_AnimationTreePlayer_node_get_pos>` **(** :ref:`String<class_string>` id **)** const |
| void | :ref:`recompute_caches<class_AnimationTreePlayer_recompute_caches>` **(** **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_node<class_AnimationTreePlayer_remove_node>` **(** :ref:`String<class_string>` id **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`connect<class_AnimationTreePlayer_connect>` **(** :ref:`String<class_string>` id, :ref:`String<class_string>` dst_id, :ref:`int<class_int>` dst_input_idx **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_connected<class_AnimationTreePlayer_is_connected>` **(** :ref:`String<class_string>` id, :ref:`String<class_string>` dst_id, :ref:`int<class_int>` dst_input_idx **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`disconnect<class_AnimationTreePlayer_disconnect>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` dst_input_idx **)** |
| void | :ref:`reset<class_AnimationTreePlayer_reset>` **(** **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_active<class_AnimationTreePlayer_set_active>` **(** :ref:`bool<class_bool>` enabled **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_active<class_AnimationTreePlayer_is_active>` **(** **)** const |
| void | :ref:`set_animation_process_mode<class_AnimationTreePlayer_set_animation_process_mode>` **(** :ref:`int<class_int>` mode **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_base_path<class_AnimationTreePlayer_set_base_path>` **(** :ref:`NodePath<class_nodepath>` path **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`NodePath<class_nodepath>` | :ref:`get_base_path<class_AnimationTreePlayer_get_base_path>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_master_player<class_AnimationTreePlayer_set_master_player>` **(** :ref:`NodePath<class_nodepath>` nodepath **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`NodePath<class_nodepath>` | :ref:`get_master_player<class_AnimationTreePlayer_get_master_player>` **(** **)** const |
| :ref:`float<class_float>` | :ref:`timescale_node_get_scale<class_AnimationTreePlayer_timescale_node_get_scale>` **(** :ref:`String<class_string>` id **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`StringArray<class_stringarray>` | :ref:`get_node_list<class_AnimationTreePlayer_get_node_list>` **(** **)** |
| void | :ref:`timescale_node_set_scale<class_AnimationTreePlayer_timescale_node_set_scale>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` scale **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_animation_process_mode<class_AnimationTreePlayer_set_animation_process_mode>` **(** :ref:`int<class_int>` mode **)** |
| void | :ref:`timeseek_node_seek<class_AnimationTreePlayer_timeseek_node_seek>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` pos_sec **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_animation_process_mode<class_AnimationTreePlayer_get_animation_process_mode>` **(** **)** const |
| void | :ref:`transition_node_delete_input<class_AnimationTreePlayer_transition_node_delete_input>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`advance<class_AnimationTreePlayer_advance>` **(** :ref:`float<class_float>` delta **)** |
| :ref:`int<class_int>` | :ref:`transition_node_get_current<class_AnimationTreePlayer_transition_node_get_current>` **(** :ref:`String<class_string>` id **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`reset<class_AnimationTreePlayer_reset>` **(** **)** |
| :ref:`int<class_int>` | :ref:`transition_node_get_input_count<class_AnimationTreePlayer_transition_node_get_input_count>` **(** :ref:`String<class_string>` id **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`recompute_caches<class_AnimationTreePlayer_recompute_caches>` **(** **)** |
| :ref:`float<class_float>` | :ref:`transition_node_get_xfade_time<class_AnimationTreePlayer_transition_node_get_xfade_time>` **(** :ref:`String<class_string>` id **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`transition_node_has_input_auto_advance<class_AnimationTreePlayer_transition_node_has_input_auto_advance>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`transition_node_set_current<class_AnimationTreePlayer_transition_node_set_current>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`transition_node_set_input_auto_advance<class_AnimationTreePlayer_transition_node_set_input_auto_advance>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx, :ref:`bool<class_bool>` enable **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`transition_node_set_input_count<class_AnimationTreePlayer_transition_node_set_input_count>` **(** :ref:`String<class_string>` id, :ref:`int<class_int>` count **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`transition_node_set_xfade_time<class_AnimationTreePlayer_transition_node_set_xfade_time>` **(** :ref:`String<class_string>` id, :ref:`float<class_float>` time_sec **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Numeric Constants
@@ -174,24 +174,102 @@ Member Function Description
Add a node of a given type in the graph with given id.
.. _class_AnimationTreePlayer_advance:
- void **advance** **(** :ref:`float<class_float>` delta **)**
.. _class_AnimationTreePlayer_animation_node_get_animation:
- :ref:`Animation<class_animation>` **animation_node_get_animation** **(** :ref:`String<class_string>` id **)** const
.. _class_AnimationTreePlayer_animation_node_get_master_animation:
- :ref:`String<class_string>` **animation_node_get_master_animation** **(** :ref:`String<class_string>` id **)** const
.. _class_AnimationTreePlayer_animation_node_set_animation:
- void **animation_node_set_animation** **(** :ref:`String<class_string>` id, :ref:`Animation<class_animation>` animation **)**
Set the animation for an animation node.
.. _class_AnimationTreePlayer_animation_node_set_master_animation:
- void **animation_node_set_master_animation** **(** :ref:`String<class_string>` id, :ref:`String<class_string>` source **)**
.. _class_AnimationTreePlayer_blend2_node_get_amount:
- :ref:`float<class_float>` **blend2_node_get_amount** **(** :ref:`String<class_string>` id **)** const
.. _class_AnimationTreePlayer_blend2_node_set_amount:
- void **blend2_node_set_amount** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` blend **)**
.. _class_AnimationTreePlayer_blend2_node_set_filter_path:
- void **blend2_node_set_filter_path** **(** :ref:`String<class_string>` id, :ref:`NodePath<class_nodepath>` path, :ref:`bool<class_bool>` enable **)**
.. _class_AnimationTreePlayer_blend3_node_get_amount:
- :ref:`float<class_float>` **blend3_node_get_amount** **(** :ref:`String<class_string>` id **)** const
.. _class_AnimationTreePlayer_blend3_node_set_amount:
- void **blend3_node_set_amount** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` blend **)**
.. _class_AnimationTreePlayer_blend4_node_get_amount:
- :ref:`Vector2<class_vector2>` **blend4_node_get_amount** **(** :ref:`String<class_string>` id **)** const
.. _class_AnimationTreePlayer_blend4_node_set_amount:
- void **blend4_node_set_amount** **(** :ref:`String<class_string>` id, :ref:`Vector2<class_vector2>` blend **)**
.. _class_AnimationTreePlayer_connect:
- :ref:`int<class_int>` **connect** **(** :ref:`String<class_string>` id, :ref:`String<class_string>` dst_id, :ref:`int<class_int>` dst_input_idx **)**
.. _class_AnimationTreePlayer_disconnect:
- void **disconnect** **(** :ref:`String<class_string>` id, :ref:`int<class_int>` dst_input_idx **)**
.. _class_AnimationTreePlayer_get_animation_process_mode:
- :ref:`int<class_int>` **get_animation_process_mode** **(** **)** const
.. _class_AnimationTreePlayer_get_base_path:
- :ref:`NodePath<class_nodepath>` **get_base_path** **(** **)** const
.. _class_AnimationTreePlayer_get_master_player:
- :ref:`NodePath<class_nodepath>` **get_master_player** **(** **)** const
.. _class_AnimationTreePlayer_get_node_list:
- :ref:`StringArray<class_stringarray>` **get_node_list** **(** **)**
.. _class_AnimationTreePlayer_is_active:
- :ref:`bool<class_bool>` **is_active** **(** **)** const
.. _class_AnimationTreePlayer_is_connected:
- :ref:`bool<class_bool>` **is_connected** **(** :ref:`String<class_string>` id, :ref:`String<class_string>` dst_id, :ref:`int<class_int>` dst_input_idx **)** const
.. _class_AnimationTreePlayer_mix_node_get_amount:
- :ref:`float<class_float>` **mix_node_get_amount** **(** :ref:`String<class_string>` id **)** const
.. _class_AnimationTreePlayer_mix_node_set_amount:
- void **mix_node_set_amount** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` ratio **)**
.. _class_AnimationTreePlayer_node_exists:
- :ref:`bool<class_bool>` **node_exists** **(** :ref:`String<class_string>` node **)** const
Check if a node exists (by name).
.. _class_AnimationTreePlayer_node_rename:
- :ref:`int<class_int>` **node_rename** **(** :ref:`String<class_string>` node, :ref:`String<class_string>` new_name **)**
Rename a node in the graph.
.. _class_AnimationTreePlayer_node_get_type:
- :ref:`int<class_int>` **node_get_type** **(** :ref:`String<class_string>` id **)** const
Get the node type, will return from NODE\_\* enum.
.. _class_AnimationTreePlayer_node_get_input_count:
- :ref:`int<class_int>` **node_get_input_count** **(** :ref:`String<class_string>` id **)** const
@@ -204,40 +282,50 @@ Return the input count for a given node. Different types of nodes have different
Return the input source for a given node input.
.. _class_AnimationTreePlayer_animation_node_set_animation:
.. _class_AnimationTreePlayer_node_get_pos:
- void **animation_node_set_animation** **(** :ref:`String<class_string>` id, :ref:`Animation<class_animation>` animation **)**
- :ref:`Vector2<class_vector2>` **node_get_pos** **(** :ref:`String<class_string>` id **)** const
Set the animation for an animation node.
.. _class_AnimationTreePlayer_node_get_type:
.. _class_AnimationTreePlayer_animation_node_get_animation:
- :ref:`int<class_int>` **node_get_type** **(** :ref:`String<class_string>` id **)** const
- :ref:`Animation<class_animation>` **animation_node_get_animation** **(** :ref:`String<class_string>` id **)** const
Get the node type, will return from NODE\_\* enum.
.. _class_AnimationTreePlayer_animation_node_set_master_animation:
.. _class_AnimationTreePlayer_node_rename:
- void **animation_node_set_master_animation** **(** :ref:`String<class_string>` id, :ref:`String<class_string>` source **)**
- :ref:`int<class_int>` **node_rename** **(** :ref:`String<class_string>` node, :ref:`String<class_string>` new_name **)**
.. _class_AnimationTreePlayer_animation_node_get_master_animation:
Rename a node in the graph.
- :ref:`String<class_string>` **animation_node_get_master_animation** **(** :ref:`String<class_string>` id **)** const
.. _class_AnimationTreePlayer_node_set_pos:
.. _class_AnimationTreePlayer_oneshot_node_set_fadein_time:
- void **node_set_pos** **(** :ref:`String<class_string>` id, :ref:`Vector2<class_vector2>` screen_pos **)**
- void **oneshot_node_set_fadein_time** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` time_sec **)**
.. _class_AnimationTreePlayer_oneshot_node_get_autorestart_delay:
- :ref:`float<class_float>` **oneshot_node_get_autorestart_delay** **(** :ref:`String<class_string>` id **)** const
.. _class_AnimationTreePlayer_oneshot_node_get_autorestart_random_delay:
- :ref:`float<class_float>` **oneshot_node_get_autorestart_random_delay** **(** :ref:`String<class_string>` id **)** const
.. _class_AnimationTreePlayer_oneshot_node_get_fadein_time:
- :ref:`float<class_float>` **oneshot_node_get_fadein_time** **(** :ref:`String<class_string>` id **)** const
.. _class_AnimationTreePlayer_oneshot_node_set_fadeout_time:
- void **oneshot_node_set_fadeout_time** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` time_sec **)**
.. _class_AnimationTreePlayer_oneshot_node_get_fadeout_time:
- :ref:`float<class_float>` **oneshot_node_get_fadeout_time** **(** :ref:`String<class_string>` id **)** const
.. _class_AnimationTreePlayer_oneshot_node_has_autorestart:
- :ref:`bool<class_bool>` **oneshot_node_has_autorestart** **(** :ref:`String<class_string>` id **)** const
.. _class_AnimationTreePlayer_oneshot_node_is_active:
- :ref:`bool<class_bool>` **oneshot_node_is_active** **(** :ref:`String<class_string>` id **)** const
.. _class_AnimationTreePlayer_oneshot_node_set_autorestart:
- void **oneshot_node_set_autorestart** **(** :ref:`String<class_string>` id, :ref:`bool<class_bool>` enable **)**
@@ -250,17 +338,17 @@ Set the animation for an animation node.
- void **oneshot_node_set_autorestart_random_delay** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` rand_sec **)**
.. _class_AnimationTreePlayer_oneshot_node_has_autorestart:
.. _class_AnimationTreePlayer_oneshot_node_set_fadein_time:
- :ref:`bool<class_bool>` **oneshot_node_has_autorestart** **(** :ref:`String<class_string>` id **)** const
- void **oneshot_node_set_fadein_time** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` time_sec **)**
.. _class_AnimationTreePlayer_oneshot_node_get_autorestart_delay:
.. _class_AnimationTreePlayer_oneshot_node_set_fadeout_time:
- :ref:`float<class_float>` **oneshot_node_get_autorestart_delay** **(** :ref:`String<class_string>` id **)** const
- void **oneshot_node_set_fadeout_time** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` time_sec **)**
.. _class_AnimationTreePlayer_oneshot_node_get_autorestart_random_delay:
.. _class_AnimationTreePlayer_oneshot_node_set_filter_path:
- :ref:`float<class_float>` **oneshot_node_get_autorestart_random_delay** **(** :ref:`String<class_string>` id **)** const
- void **oneshot_node_set_filter_path** **(** :ref:`String<class_string>` id, :ref:`NodePath<class_nodepath>` path, :ref:`bool<class_bool>` enable **)**
.. _class_AnimationTreePlayer_oneshot_node_start:
@@ -270,168 +358,80 @@ Set the animation for an animation node.
- void **oneshot_node_stop** **(** :ref:`String<class_string>` id **)**
.. _class_AnimationTreePlayer_oneshot_node_is_active:
.. _class_AnimationTreePlayer_recompute_caches:
- :ref:`bool<class_bool>` **oneshot_node_is_active** **(** :ref:`String<class_string>` id **)** const
.. _class_AnimationTreePlayer_oneshot_node_set_filter_path:
- void **oneshot_node_set_filter_path** **(** :ref:`String<class_string>` id, :ref:`NodePath<class_nodepath>` path, :ref:`bool<class_bool>` enable **)**
.. _class_AnimationTreePlayer_mix_node_set_amount:
- void **mix_node_set_amount** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` ratio **)**
.. _class_AnimationTreePlayer_mix_node_get_amount:
- :ref:`float<class_float>` **mix_node_get_amount** **(** :ref:`String<class_string>` id **)** const
.. _class_AnimationTreePlayer_blend2_node_set_amount:
- void **blend2_node_set_amount** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` blend **)**
.. _class_AnimationTreePlayer_blend2_node_get_amount:
- :ref:`float<class_float>` **blend2_node_get_amount** **(** :ref:`String<class_string>` id **)** const
.. _class_AnimationTreePlayer_blend2_node_set_filter_path:
- void **blend2_node_set_filter_path** **(** :ref:`String<class_string>` id, :ref:`NodePath<class_nodepath>` path, :ref:`bool<class_bool>` enable **)**
.. _class_AnimationTreePlayer_blend3_node_set_amount:
- void **blend3_node_set_amount** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` blend **)**
.. _class_AnimationTreePlayer_blend3_node_get_amount:
- :ref:`float<class_float>` **blend3_node_get_amount** **(** :ref:`String<class_string>` id **)** const
.. _class_AnimationTreePlayer_blend4_node_set_amount:
- void **blend4_node_set_amount** **(** :ref:`String<class_string>` id, :ref:`Vector2<class_vector2>` blend **)**
.. _class_AnimationTreePlayer_blend4_node_get_amount:
- :ref:`Vector2<class_vector2>` **blend4_node_get_amount** **(** :ref:`String<class_string>` id **)** const
.. _class_AnimationTreePlayer_timescale_node_set_scale:
- void **timescale_node_set_scale** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` scale **)**
.. _class_AnimationTreePlayer_timescale_node_get_scale:
- :ref:`float<class_float>` **timescale_node_get_scale** **(** :ref:`String<class_string>` id **)** const
.. _class_AnimationTreePlayer_timeseek_node_seek:
- void **timeseek_node_seek** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` pos_sec **)**
.. _class_AnimationTreePlayer_transition_node_set_input_count:
- void **transition_node_set_input_count** **(** :ref:`String<class_string>` id, :ref:`int<class_int>` count **)**
.. _class_AnimationTreePlayer_transition_node_get_input_count:
- :ref:`int<class_int>` **transition_node_get_input_count** **(** :ref:`String<class_string>` id **)** const
.. _class_AnimationTreePlayer_transition_node_delete_input:
- void **transition_node_delete_input** **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx **)**
.. _class_AnimationTreePlayer_transition_node_set_input_auto_advance:
- void **transition_node_set_input_auto_advance** **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx, :ref:`bool<class_bool>` enable **)**
.. _class_AnimationTreePlayer_transition_node_has_input_auto_advance:
- :ref:`bool<class_bool>` **transition_node_has_input_auto_advance** **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx **)** const
.. _class_AnimationTreePlayer_transition_node_set_xfade_time:
- void **transition_node_set_xfade_time** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` time_sec **)**
.. _class_AnimationTreePlayer_transition_node_get_xfade_time:
- :ref:`float<class_float>` **transition_node_get_xfade_time** **(** :ref:`String<class_string>` id **)** const
.. _class_AnimationTreePlayer_transition_node_set_current:
- void **transition_node_set_current** **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx **)**
.. _class_AnimationTreePlayer_transition_node_get_current:
- :ref:`int<class_int>` **transition_node_get_current** **(** :ref:`String<class_string>` id **)** const
.. _class_AnimationTreePlayer_node_set_pos:
- void **node_set_pos** **(** :ref:`String<class_string>` id, :ref:`Vector2<class_vector2>` screen_pos **)**
.. _class_AnimationTreePlayer_node_get_pos:
- :ref:`Vector2<class_vector2>` **node_get_pos** **(** :ref:`String<class_string>` id **)** const
- void **recompute_caches** **(** **)**
.. _class_AnimationTreePlayer_remove_node:
- void **remove_node** **(** :ref:`String<class_string>` id **)**
.. _class_AnimationTreePlayer_connect:
.. _class_AnimationTreePlayer_reset:
- :ref:`int<class_int>` **connect** **(** :ref:`String<class_string>` id, :ref:`String<class_string>` dst_id, :ref:`int<class_int>` dst_input_idx **)**
.. _class_AnimationTreePlayer_is_connected:
- :ref:`bool<class_bool>` **is_connected** **(** :ref:`String<class_string>` id, :ref:`String<class_string>` dst_id, :ref:`int<class_int>` dst_input_idx **)** const
.. _class_AnimationTreePlayer_disconnect:
- void **disconnect** **(** :ref:`String<class_string>` id, :ref:`int<class_int>` dst_input_idx **)**
- void **reset** **(** **)**
.. _class_AnimationTreePlayer_set_active:
- void **set_active** **(** :ref:`bool<class_bool>` enabled **)**
.. _class_AnimationTreePlayer_is_active:
.. _class_AnimationTreePlayer_set_animation_process_mode:
- :ref:`bool<class_bool>` **is_active** **(** **)** const
- void **set_animation_process_mode** **(** :ref:`int<class_int>` mode **)**
.. _class_AnimationTreePlayer_set_base_path:
- void **set_base_path** **(** :ref:`NodePath<class_nodepath>` path **)**
.. _class_AnimationTreePlayer_get_base_path:
- :ref:`NodePath<class_nodepath>` **get_base_path** **(** **)** const
.. _class_AnimationTreePlayer_set_master_player:
- void **set_master_player** **(** :ref:`NodePath<class_nodepath>` nodepath **)**
.. _class_AnimationTreePlayer_get_master_player:
.. _class_AnimationTreePlayer_timescale_node_get_scale:
- :ref:`NodePath<class_nodepath>` **get_master_player** **(** **)** const
- :ref:`float<class_float>` **timescale_node_get_scale** **(** :ref:`String<class_string>` id **)** const
.. _class_AnimationTreePlayer_get_node_list:
.. _class_AnimationTreePlayer_timescale_node_set_scale:
- :ref:`StringArray<class_stringarray>` **get_node_list** **(** **)**
- void **timescale_node_set_scale** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` scale **)**
.. _class_AnimationTreePlayer_set_animation_process_mode:
.. _class_AnimationTreePlayer_timeseek_node_seek:
- void **set_animation_process_mode** **(** :ref:`int<class_int>` mode **)**
- void **timeseek_node_seek** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` pos_sec **)**
.. _class_AnimationTreePlayer_get_animation_process_mode:
.. _class_AnimationTreePlayer_transition_node_delete_input:
- :ref:`int<class_int>` **get_animation_process_mode** **(** **)** const
- void **transition_node_delete_input** **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx **)**
.. _class_AnimationTreePlayer_advance:
.. _class_AnimationTreePlayer_transition_node_get_current:
- void **advance** **(** :ref:`float<class_float>` delta **)**
- :ref:`int<class_int>` **transition_node_get_current** **(** :ref:`String<class_string>` id **)** const
.. _class_AnimationTreePlayer_reset:
.. _class_AnimationTreePlayer_transition_node_get_input_count:
- void **reset** **(** **)**
- :ref:`int<class_int>` **transition_node_get_input_count** **(** :ref:`String<class_string>` id **)** const
.. _class_AnimationTreePlayer_recompute_caches:
.. _class_AnimationTreePlayer_transition_node_get_xfade_time:
- void **recompute_caches** **(** **)**
- :ref:`float<class_float>` **transition_node_get_xfade_time** **(** :ref:`String<class_string>` id **)** const
.. _class_AnimationTreePlayer_transition_node_has_input_auto_advance:
- :ref:`bool<class_bool>` **transition_node_has_input_auto_advance** **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx **)** const
.. _class_AnimationTreePlayer_transition_node_set_current:
- void **transition_node_set_current** **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx **)**
.. _class_AnimationTreePlayer_transition_node_set_input_auto_advance:
- void **transition_node_set_input_auto_advance** **(** :ref:`String<class_string>` id, :ref:`int<class_int>` input_idx, :ref:`bool<class_bool>` enable **)**
.. _class_AnimationTreePlayer_transition_node_set_input_count:
- void **transition_node_set_input_count** **(** :ref:`String<class_string>` id, :ref:`int<class_int>` count **)**
.. _class_AnimationTreePlayer_transition_node_set_xfade_time:
- void **transition_node_set_xfade_time** **(** :ref:`String<class_string>` id, :ref:`float<class_float>` time_sec **)**

372
classes/class_area.rst
View File

@@ -19,66 +19,66 @@ Member Functions
----------------
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_space_override_mode<class_Area_set_space_override_mode>` **(** :ref:`int<class_int>` enable **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_space_override_mode<class_Area_get_space_override_mode>` **(** **)** const |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_gravity_is_point<class_Area_set_gravity_is_point>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_gravity_a_point<class_Area_is_gravity_a_point>` **(** **)** const |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_gravity_distance_scale<class_Area_set_gravity_distance_scale>` **(** :ref:`float<class_float>` distance_scale **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_gravity_distance_scale<class_Area_get_gravity_distance_scale>` **(** **)** const |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_gravity_vector<class_Area_set_gravity_vector>` **(** :ref:`Vector3<class_vector3>` vector **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_gravity_vector<class_Area_get_gravity_vector>` **(** **)** const |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_gravity<class_Area_set_gravity>` **(** :ref:`float<class_float>` gravity **)** |
| :ref:`float<class_float>` | :ref:`get_angular_damp<class_Area_get_angular_damp>` **(** **)** const |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_gravity<class_Area_get_gravity>` **(** **)** const |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_angular_damp<class_Area_set_angular_damp>` **(** :ref:`float<class_float>` angular_damp **)** |
| :ref:`float<class_float>` | :ref:`get_gravity_distance_scale<class_Area_get_gravity_distance_scale>` **(** **)** const |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_angular_damp<class_Area_get_angular_damp>` **(** **)** const |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_linear_damp<class_Area_set_linear_damp>` **(** :ref:`float<class_float>` linear_damp **)** |
| :ref:`Vector3<class_vector3>` | :ref:`get_gravity_vector<class_Area_get_gravity_vector>` **(** **)** const |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_linear_damp<class_Area_get_linear_damp>` **(** **)** const |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_priority<class_Area_set_priority>` **(** :ref:`float<class_float>` priority **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_priority<class_Area_get_priority>` **(** **)** const |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_monitorable<class_Area_set_monitorable>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_monitorable<class_Area_is_monitorable>` **(** **)** const |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_enable_monitoring<class_Area_set_enable_monitoring>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_monitoring_enabled<class_Area_is_monitoring_enabled>` **(** **)** const |
| :ref:`Array<class_array>` | :ref:`get_overlapping_areas<class_Area_get_overlapping_areas>` **(** **)** const |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_overlapping_bodies<class_Area_get_overlapping_bodies>` **(** **)** const |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_overlapping_areas<class_Area_get_overlapping_areas>` **(** **)** const |
| :ref:`float<class_float>` | :ref:`get_priority<class_Area_get_priority>` **(** **)** const |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_space_override_mode<class_Area_get_space_override_mode>` **(** **)** const |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_gravity_a_point<class_Area_is_gravity_a_point>` **(** **)** const |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_monitorable<class_Area_is_monitorable>` **(** **)** const |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_monitoring_enabled<class_Area_is_monitoring_enabled>` **(** **)** const |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`overlaps_area<class_Area_overlaps_area>` **(** :ref:`Object<class_object>` area **)** const |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`overlaps_body<class_Area_overlaps_body>` **(** :ref:`Object<class_object>` body **)** const |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`overlaps_area<class_Area_overlaps_area>` **(** :ref:`Object<class_object>` area **)** const |
| void | :ref:`set_angular_damp<class_Area_set_angular_damp>` **(** :ref:`float<class_float>` angular_damp **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_enable_monitoring<class_Area_set_enable_monitoring>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_gravity<class_Area_set_gravity>` **(** :ref:`float<class_float>` gravity **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_gravity_distance_scale<class_Area_set_gravity_distance_scale>` **(** :ref:`float<class_float>` distance_scale **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_gravity_is_point<class_Area_set_gravity_is_point>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_gravity_vector<class_Area_set_gravity_vector>` **(** :ref:`Vector3<class_vector3>` vector **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_linear_damp<class_Area_set_linear_damp>` **(** :ref:`float<class_float>` linear_damp **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_monitorable<class_Area_set_monitorable>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_priority<class_Area_set_priority>` **(** :ref:`float<class_float>` priority **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_space_override_mode<class_Area_set_space_override_mode>` **(** :ref:`int<class_int>` enable **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
- **body_enter** **(** :ref:`Object<class_object>` body **)**
- **body_enter_shape** **(** :ref:`int<class_int>` body_id, :ref:`Object<class_object>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
- **area_enter** **(** :ref:`Object<class_object>` area **)**
- **area_enter_shape** **(** :ref:`int<class_int>` area_id, :ref:`Object<class_object>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` area_shape **)**
- **body_exit** **(** :ref:`Object<class_object>` body **)**
- **body_exit_shape** **(** :ref:`int<class_int>` body_id, :ref:`Object<class_object>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
- **area_exit** **(** :ref:`Object<class_object>` area **)**
- **area_exit_shape** **(** :ref:`int<class_int>` area_id, :ref:`Object<class_object>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` area_shape **)**
- **body_enter** **(** :ref:`Object<class_object>` body **)**
- **body_enter_shape** **(** :ref:`int<class_int>` body_id, :ref:`Object<class_object>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
- **body_exit** **(** :ref:`Object<class_object>` body **)**
- **body_exit_shape** **(** :ref:`int<class_int>` body_id, :ref:`Object<class_object>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
Description
-----------
@@ -88,6 +88,154 @@ General purpose area detection for 3D physics. Areas can be used for detection o
Member Function Description
---------------------------
.. _class_Area_get_angular_damp:
- :ref:`float<class_float>` **get_angular_damp** **(** **)** const
Return the angular damp rate.
.. _class_Area_get_gravity:
- :ref:`float<class_float>` **get_gravity** **(** **)** const
Return the gravity intensity.
.. _class_Area_get_gravity_distance_scale:
- :ref:`float<class_float>` **get_gravity_distance_scale** **(** **)** const
Return the falloff factor for point gravity.
.. _class_Area_get_gravity_vector:
- :ref:`Vector3<class_vector3>` **get_gravity_vector** **(** **)** const
Return the gravity vector. If gravity is a point (see :ref:`is_gravity_a_point<class_Area_is_gravity_a_point>`), this will be the attraction center.
.. _class_Area_get_linear_damp:
- :ref:`float<class_float>` **get_linear_damp** **(** **)** const
Return the linear damp rate.
.. _class_Area_get_overlapping_areas:
- :ref:`Array<class_array>` **get_overlapping_areas** **(** **)** const
Return a list of the areas that are totally or partially inside this area.
.. _class_Area_get_overlapping_bodies:
- :ref:`Array<class_array>` **get_overlapping_bodies** **(** **)** const
Return a list of the bodies (:ref:`PhysicsBody<class_physicsbody>`) that are totally or partially inside this area.
.. _class_Area_get_priority:
- :ref:`float<class_float>` **get_priority** **(** **)** const
Return the processing order of this area.
.. _class_Area_get_space_override_mode:
- :ref:`int<class_int>` **get_space_override_mode** **(** **)** const
Return the space override mode.
.. _class_Area_is_gravity_a_point:
- :ref:`bool<class_bool>` **is_gravity_a_point** **(** **)** const
Return whether gravity is a point. A point gravity will attract objects towards it, as opposed to a gravity vector, which moves them in a given direction.
.. _class_Area_is_monitorable:
- :ref:`bool<class_bool>` **is_monitorable** **(** **)** const
Return whether this area can be detected by other, monitoring, areas.
.. _class_Area_is_monitoring_enabled:
- :ref:`bool<class_bool>` **is_monitoring_enabled** **(** **)** const
Return whether this area detects bodies/areas entering/exiting it.
.. _class_Area_overlaps_area:
- :ref:`bool<class_bool>` **overlaps_area** **(** :ref:`Object<class_object>` area **)** const
Return whether the area passed is totally or partially inside this area.
.. _class_Area_overlaps_body:
- :ref:`bool<class_bool>` **overlaps_body** **(** :ref:`Object<class_object>` body **)** const
Return whether the body passed is totally or partially inside this area.
.. _class_Area_set_angular_damp:
- void **set_angular_damp** **(** :ref:`float<class_float>` angular_damp **)**
Set the rate at which objects stop spinning in this area, if there are not any other forces making it spin. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops.
In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second.
.. _class_Area_set_enable_monitoring:
- void **set_enable_monitoring** **(** :ref:`bool<class_bool>` enable **)**
Set whether this area can detect bodies/areas entering/exiting it.
.. _class_Area_set_gravity:
- void **set_gravity** **(** :ref:`float<class_float>` gravity **)**
Set the gravity intensity. This is useful to alter the force of gravity without altering its direction.
This value multiplies the gravity vector, whether it is the given vector (:ref:`set_gravity_vector<class_Area_set_gravity_vector>`), or a calculated one (when using a center of gravity).
.. _class_Area_set_gravity_distance_scale:
- void **set_gravity_distance_scale** **(** :ref:`float<class_float>` distance_scale **)**
Set the falloff factor for point gravity. The greater this value is, the faster the strength of gravity decreases with the square of distance.
.. _class_Area_set_gravity_is_point:
- void **set_gravity_is_point** **(** :ref:`bool<class_bool>` enable **)**
When overriding space parameters, this method sets whether this area has a center of gravity. To set/get the location of the center of gravity, use :ref:`set_gravity_vector<class_Area_set_gravity_vector>`/:ref:`get_gravity_vector<class_Area_get_gravity_vector>`.
.. _class_Area_set_gravity_vector:
- void **set_gravity_vector** **(** :ref:`Vector3<class_vector3>` vector **)**
Set the gravity vector. This vector does not have to be normalized.
If gravity is a point (see :ref:`is_gravity_a_point<class_Area_is_gravity_a_point>`), this will be the attraction center.
.. _class_Area_set_linear_damp:
- void **set_linear_damp** **(** :ref:`float<class_float>` linear_damp **)**
Set the rate at which objects stop moving in this area, if there are not any other forces moving it. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops.
In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second.
.. _class_Area_set_monitorable:
- void **set_monitorable** **(** :ref:`bool<class_bool>` enable **)**
Set whether this area can be detected by other, monitoring, areas. Only areas need to be marked as monitorable. Bodies are always so.
.. _class_Area_set_priority:
- void **set_priority** **(** :ref:`float<class_float>` priority **)**
Set the order in which the area is processed. Greater values mean the area gets processed first. This is useful for areas which have an space override different from AREA_SPACE_OVERRIDE_DISABLED or AREA_SPACE_OVERRIDE_COMBINE, as they replace values, and are thus order-dependent.
Areas with the same priority value get evaluated in an unpredictable order, and should be differentiated if evaluation order is to be important.
.. _class_Area_set_space_override_mode:
- void **set_space_override_mode** **(** :ref:`int<class_int>` enable **)**
@@ -104,152 +252,4 @@ AREA_SPACE_OVERRIDE_REPLACE: This area replaces any gravity/damp, even the defau
AREA_SPACE_OVERRIDE_REPLACE_COMBINE: This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one.
.. _class_Area_get_space_override_mode:
- :ref:`int<class_int>` **get_space_override_mode** **(** **)** const
Return the space override mode.
.. _class_Area_set_gravity_is_point:
- void **set_gravity_is_point** **(** :ref:`bool<class_bool>` enable **)**
When overriding space parameters, this method sets whether this area has a center of gravity. To set/get the location of the center of gravity, use :ref:`set_gravity_vector<class_Area_set_gravity_vector>`/:ref:`get_gravity_vector<class_Area_get_gravity_vector>`.
.. _class_Area_is_gravity_a_point:
- :ref:`bool<class_bool>` **is_gravity_a_point** **(** **)** const
Return whether gravity is a point. A point gravity will attract objects towards it, as opposed to a gravity vector, which moves them in a given direction.
.. _class_Area_set_gravity_distance_scale:
- void **set_gravity_distance_scale** **(** :ref:`float<class_float>` distance_scale **)**
Set the falloff factor for point gravity. The greater this value is, the faster the strength of gravity decreases with the square of distance.
.. _class_Area_get_gravity_distance_scale:
- :ref:`float<class_float>` **get_gravity_distance_scale** **(** **)** const
Return the falloff factor for point gravity.
.. _class_Area_set_gravity_vector:
- void **set_gravity_vector** **(** :ref:`Vector3<class_vector3>` vector **)**
Set the gravity vector. This vector does not have to be normalized.
If gravity is a point (see :ref:`is_gravity_a_point<class_Area_is_gravity_a_point>`), this will be the attraction center.
.. _class_Area_get_gravity_vector:
- :ref:`Vector3<class_vector3>` **get_gravity_vector** **(** **)** const
Return the gravity vector. If gravity is a point (see :ref:`is_gravity_a_point<class_Area_is_gravity_a_point>`), this will be the attraction center.
.. _class_Area_set_gravity:
- void **set_gravity** **(** :ref:`float<class_float>` gravity **)**
Set the gravity intensity. This is useful to alter the force of gravity without altering its direction.
This value multiplies the gravity vector, whether it is the given vector (:ref:`set_gravity_vector<class_Area_set_gravity_vector>`), or a calculated one (when using a center of gravity).
.. _class_Area_get_gravity:
- :ref:`float<class_float>` **get_gravity** **(** **)** const
Return the gravity intensity.
.. _class_Area_set_angular_damp:
- void **set_angular_damp** **(** :ref:`float<class_float>` angular_damp **)**
Set the rate at which objects stop spinning in this area, if there are not any other forces making it spin. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops.
In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second.
.. _class_Area_get_angular_damp:
- :ref:`float<class_float>` **get_angular_damp** **(** **)** const
Return the angular damp rate.
.. _class_Area_set_linear_damp:
- void **set_linear_damp** **(** :ref:`float<class_float>` linear_damp **)**
Set the rate at which objects stop moving in this area, if there are not any other forces moving it. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops.
In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second.
.. _class_Area_get_linear_damp:
- :ref:`float<class_float>` **get_linear_damp** **(** **)** const
Return the linear damp rate.
.. _class_Area_set_priority:
- void **set_priority** **(** :ref:`float<class_float>` priority **)**
Set the order in which the area is processed. Greater values mean the area gets processed first. This is useful for areas which have an space override different from AREA_SPACE_OVERRIDE_DISABLED or AREA_SPACE_OVERRIDE_COMBINE, as they replace values, and are thus order-dependent.
Areas with the same priority value get evaluated in an unpredictable order, and should be differentiated if evaluation order is to be important.
.. _class_Area_get_priority:
- :ref:`float<class_float>` **get_priority** **(** **)** const
Return the processing order of this area.
.. _class_Area_set_monitorable:
- void **set_monitorable** **(** :ref:`bool<class_bool>` enable **)**
Set whether this area can be detected by other, monitoring, areas. Only areas need to be marked as monitorable. Bodies are always so.
.. _class_Area_is_monitorable:
- :ref:`bool<class_bool>` **is_monitorable** **(** **)** const
Return whether this area can be detected by other, monitoring, areas.
.. _class_Area_set_enable_monitoring:
- void **set_enable_monitoring** **(** :ref:`bool<class_bool>` enable **)**
Set whether this area can detect bodies/areas entering/exiting it.
.. _class_Area_is_monitoring_enabled:
- :ref:`bool<class_bool>` **is_monitoring_enabled** **(** **)** const
Return whether this area detects bodies/areas entering/exiting it.
.. _class_Area_get_overlapping_bodies:
- :ref:`Array<class_array>` **get_overlapping_bodies** **(** **)** const
Return a list of the bodies (:ref:`PhysicsBody<class_physicsbody>`) that are totally or partially inside this area.
.. _class_Area_get_overlapping_areas:
- :ref:`Array<class_array>` **get_overlapping_areas** **(** **)** const
Return a list of the areas that are totally or partially inside this area.
.. _class_Area_overlaps_body:
- :ref:`bool<class_bool>` **overlaps_body** **(** :ref:`Object<class_object>` body **)** const
Return whether the body passed is totally or partially inside this area.
.. _class_Area_overlaps_area:
- :ref:`bool<class_bool>` **overlaps_area** **(** :ref:`Object<class_object>` area **)** const
Return whether the area passed is totally or partially inside this area.

506
classes/class_area2d.rst
View File

@@ -18,83 +18,83 @@ General purpose area detection and influence for 2D physics.
Member Functions
----------------
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_space_override_mode<class_Area2D_set_space_override_mode>` **(** :ref:`int<class_int>` enable **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_space_override_mode<class_Area2D_get_space_override_mode>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_gravity_is_point<class_Area2D_set_gravity_is_point>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_gravity_a_point<class_Area2D_is_gravity_a_point>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_gravity_distance_scale<class_Area2D_set_gravity_distance_scale>` **(** :ref:`float<class_float>` distance_scale **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_gravity_distance_scale<class_Area2D_get_gravity_distance_scale>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_gravity_vector<class_Area2D_set_gravity_vector>` **(** :ref:`Vector2<class_vector2>` vector **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_gravity_vector<class_Area2D_get_gravity_vector>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_gravity<class_Area2D_set_gravity>` **(** :ref:`float<class_float>` gravity **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_gravity<class_Area2D_get_gravity>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_linear_damp<class_Area2D_set_linear_damp>` **(** :ref:`float<class_float>` linear_damp **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_linear_damp<class_Area2D_get_linear_damp>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_angular_damp<class_Area2D_set_angular_damp>` **(** :ref:`float<class_float>` angular_damp **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_angular_damp<class_Area2D_get_angular_damp>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_priority<class_Area2D_set_priority>` **(** :ref:`float<class_float>` priority **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_priority<class_Area2D_get_priority>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_collision_mask<class_Area2D_set_collision_mask>` **(** :ref:`int<class_int>` collision_mask **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_collision_mask<class_Area2D_get_collision_mask>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_layer_mask<class_Area2D_set_layer_mask>` **(** :ref:`int<class_int>` layer_mask **)** |
| :ref:`bool<class_bool>` | :ref:`get_collision_mask_bit<class_Area2D_get_collision_mask_bit>` **(** :ref:`int<class_int>` bit **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_gravity<class_Area2D_get_gravity>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_gravity_distance_scale<class_Area2D_get_gravity_distance_scale>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_gravity_vector<class_Area2D_get_gravity_vector>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_layer_mask<class_Area2D_get_layer_mask>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_collision_mask_bit<class_Area2D_set_collision_mask_bit>` **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_collision_mask_bit<class_Area2D_get_collision_mask_bit>` **(** :ref:`int<class_int>` bit **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_layer_mask_bit<class_Area2D_set_layer_mask_bit>` **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_layer_mask_bit<class_Area2D_get_layer_mask_bit>` **(** :ref:`int<class_int>` bit **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_enable_monitoring<class_Area2D_set_enable_monitoring>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_monitoring_enabled<class_Area2D_is_monitoring_enabled>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_monitorable<class_Area2D_set_monitorable>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_monitorable<class_Area2D_is_monitorable>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_overlapping_bodies<class_Area2D_get_overlapping_bodies>` **(** **)** const |
| :ref:`float<class_float>` | :ref:`get_linear_damp<class_Area2D_get_linear_damp>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_overlapping_areas<class_Area2D_get_overlapping_areas>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`overlaps_body<class_Area2D_overlaps_body>` **(** :ref:`Object<class_object>` body **)** const |
| :ref:`Array<class_array>` | :ref:`get_overlapping_bodies<class_Area2D_get_overlapping_bodies>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_priority<class_Area2D_get_priority>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_space_override_mode<class_Area2D_get_space_override_mode>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_gravity_a_point<class_Area2D_is_gravity_a_point>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_monitorable<class_Area2D_is_monitorable>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_monitoring_enabled<class_Area2D_is_monitoring_enabled>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`overlaps_area<class_Area2D_overlaps_area>` **(** :ref:`Object<class_object>` area **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`overlaps_body<class_Area2D_overlaps_body>` **(** :ref:`Object<class_object>` body **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_angular_damp<class_Area2D_set_angular_damp>` **(** :ref:`float<class_float>` angular_damp **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_collision_mask<class_Area2D_set_collision_mask>` **(** :ref:`int<class_int>` collision_mask **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_collision_mask_bit<class_Area2D_set_collision_mask_bit>` **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_enable_monitoring<class_Area2D_set_enable_monitoring>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_gravity<class_Area2D_set_gravity>` **(** :ref:`float<class_float>` gravity **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_gravity_distance_scale<class_Area2D_set_gravity_distance_scale>` **(** :ref:`float<class_float>` distance_scale **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_gravity_is_point<class_Area2D_set_gravity_is_point>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_gravity_vector<class_Area2D_set_gravity_vector>` **(** :ref:`Vector2<class_vector2>` vector **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_layer_mask<class_Area2D_set_layer_mask>` **(** :ref:`int<class_int>` layer_mask **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_layer_mask_bit<class_Area2D_set_layer_mask_bit>` **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_linear_damp<class_Area2D_set_linear_damp>` **(** :ref:`float<class_float>` linear_damp **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_monitorable<class_Area2D_set_monitorable>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_priority<class_Area2D_set_priority>` **(** :ref:`float<class_float>` priority **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_space_override_mode<class_Area2D_set_space_override_mode>` **(** :ref:`int<class_int>` enable **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
- **body_enter** **(** :ref:`Object<class_object>` body **)**
- **body_enter_shape** **(** :ref:`int<class_int>` body_id, :ref:`Object<class_object>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
- **area_enter** **(** :ref:`Object<class_object>` area **)**
- **area_enter_shape** **(** :ref:`int<class_int>` area_id, :ref:`Object<class_object>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` area_shape **)**
- **body_exit** **(** :ref:`Object<class_object>` body **)**
- **body_exit_shape** **(** :ref:`int<class_int>` body_id, :ref:`Object<class_object>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
- **area_exit** **(** :ref:`Object<class_object>` area **)**
- **area_exit_shape** **(** :ref:`int<class_int>` area_id, :ref:`Object<class_object>` area, :ref:`int<class_int>` area_shape, :ref:`int<class_int>` area_shape **)**
- **body_enter** **(** :ref:`Object<class_object>` body **)**
- **body_enter_shape** **(** :ref:`int<class_int>` body_id, :ref:`Object<class_object>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
- **body_exit** **(** :ref:`Object<class_object>` body **)**
- **body_exit_shape** **(** :ref:`int<class_int>` body_id, :ref:`Object<class_object>` body, :ref:`int<class_int>` body_shape, :ref:`int<class_int>` area_shape **)**
Description
-----------
@@ -104,6 +104,206 @@ General purpose area detection for 2D physics. Areas can be used for detection o
Member Function Description
---------------------------
.. _class_Area2D_get_angular_damp:
- :ref:`float<class_float>` **get_angular_damp** **(** **)** const
Return the angular damp rate.
.. _class_Area2D_get_collision_mask:
- :ref:`int<class_int>` **get_collision_mask** **(** **)** const
Return the physics layers this area can scan for collisions.
.. _class_Area2D_get_collision_mask_bit:
- :ref:`bool<class_bool>` **get_collision_mask_bit** **(** :ref:`int<class_int>` bit **)** const
Return an individual bit on the collision mask.
.. _class_Area2D_get_gravity:
- :ref:`float<class_float>` **get_gravity** **(** **)** const
Return the gravity intensity.
.. _class_Area2D_get_gravity_distance_scale:
- :ref:`float<class_float>` **get_gravity_distance_scale** **(** **)** const
Return the falloff factor for point gravity.
.. _class_Area2D_get_gravity_vector:
- :ref:`Vector2<class_vector2>` **get_gravity_vector** **(** **)** const
Return the gravity vector. If gravity is a point (see :ref:`is_gravity_a_point<class_Area2D_is_gravity_a_point>`), this will be the attraction center.
.. _class_Area2D_get_layer_mask:
- :ref:`int<class_int>` **get_layer_mask** **(** **)** const
Return the physics layer this area is in.
.. _class_Area2D_get_layer_mask_bit:
- :ref:`bool<class_bool>` **get_layer_mask_bit** **(** :ref:`int<class_int>` bit **)** const
Return an individual bit on the layer mask.
.. _class_Area2D_get_linear_damp:
- :ref:`float<class_float>` **get_linear_damp** **(** **)** const
Return the linear damp rate.
.. _class_Area2D_get_overlapping_areas:
- :ref:`Array<class_array>` **get_overlapping_areas** **(** **)** const
Return a list of the areas that are totally or partially inside this area.
.. _class_Area2D_get_overlapping_bodies:
- :ref:`Array<class_array>` **get_overlapping_bodies** **(** **)** const
Return a list of the bodies (:ref:`PhysicsBody2D<class_physicsbody2d>`) that are totally or partially inside this area.
.. _class_Area2D_get_priority:
- :ref:`float<class_float>` **get_priority** **(** **)** const
Return the processing order of this area.
.. _class_Area2D_get_space_override_mode:
- :ref:`int<class_int>` **get_space_override_mode** **(** **)** const
Return the space override mode.
.. _class_Area2D_is_gravity_a_point:
- :ref:`bool<class_bool>` **is_gravity_a_point** **(** **)** const
Return whether gravity is a point. A point gravity will attract objects towards it, as opposed to a gravity vector, which moves them in a given direction.
.. _class_Area2D_is_monitorable:
- :ref:`bool<class_bool>` **is_monitorable** **(** **)** const
Return whether this area can be detected by other, monitoring, areas.
.. _class_Area2D_is_monitoring_enabled:
- :ref:`bool<class_bool>` **is_monitoring_enabled** **(** **)** const
Return whether this area detects bodies/areas entering/exiting it.
.. _class_Area2D_overlaps_area:
- :ref:`bool<class_bool>` **overlaps_area** **(** :ref:`Object<class_object>` area **)** const
Return whether the area passed is totally or partially inside this area.
.. _class_Area2D_overlaps_body:
- :ref:`bool<class_bool>` **overlaps_body** **(** :ref:`Object<class_object>` body **)** const
Return whether the body passed is totally or partially inside this area.
.. _class_Area2D_set_angular_damp:
- void **set_angular_damp** **(** :ref:`float<class_float>` angular_damp **)**
Set the rate at which objects stop spinning in this area, if there are not any other forces making it spin. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops.
In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second.
.. _class_Area2D_set_collision_mask:
- void **set_collision_mask** **(** :ref:`int<class_int>` collision_mask **)**
Set the physics layers this area can scan for collisions.
.. _class_Area2D_set_collision_mask_bit:
- void **set_collision_mask_bit** **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)**
Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier.
.. _class_Area2D_set_enable_monitoring:
- void **set_enable_monitoring** **(** :ref:`bool<class_bool>` enable **)**
Set whether this area can detect bodies/areas entering/exiting it.
.. _class_Area2D_set_gravity:
- void **set_gravity** **(** :ref:`float<class_float>` gravity **)**
Set the gravity intensity. This is useful to alter the force of gravity without altering its direction.
This value multiplies the gravity vector, whether it is the given vector (:ref:`set_gravity_vector<class_Area2D_set_gravity_vector>`), or a calculated one (when using a center of gravity).
.. _class_Area2D_set_gravity_distance_scale:
- void **set_gravity_distance_scale** **(** :ref:`float<class_float>` distance_scale **)**
Set the falloff factor for point gravity. The greater this value is, the faster the strength of gravity decreases with the square of distance.
.. _class_Area2D_set_gravity_is_point:
- void **set_gravity_is_point** **(** :ref:`bool<class_bool>` enable **)**
When overriding space parameters, this method sets whether this area has a center of gravity. To set/get the location of the center of gravity, use :ref:`set_gravity_vector<class_Area2D_set_gravity_vector>`/:ref:`get_gravity_vector<class_Area2D_get_gravity_vector>`.
.. _class_Area2D_set_gravity_vector:
- void **set_gravity_vector** **(** :ref:`Vector2<class_vector2>` vector **)**
Set the gravity vector. This vector does not have to be normalized.
If gravity is a point (see :ref:`is_gravity_a_point<class_Area2D_is_gravity_a_point>`), this will be the attraction center.
.. _class_Area2D_set_layer_mask:
- void **set_layer_mask** **(** :ref:`int<class_int>` layer_mask **)**
Set the physics layers this area is in.
Collidable objects can exist in any of 32 different layers. These layers are not visual, but more of a tagging system instead. A collidable can use these layers/tags to select with which objects it can collide, using :ref:`set_collision_mask<class_Area2D_set_collision_mask>`.
A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A.
.. _class_Area2D_set_layer_mask_bit:
- void **set_layer_mask_bit** **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)**
Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier.
.. _class_Area2D_set_linear_damp:
- void **set_linear_damp** **(** :ref:`float<class_float>` linear_damp **)**
Set the rate at which objects stop moving in this area, if there are not any other forces moving it. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops.
In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second.
.. _class_Area2D_set_monitorable:
- void **set_monitorable** **(** :ref:`bool<class_bool>` enable **)**
Set whether this area can be detected by other, monitoring, areas. Only areas need to be marked as monitorable. Bodies are always so.
.. _class_Area2D_set_priority:
- void **set_priority** **(** :ref:`float<class_float>` priority **)**
Set the order in which the area is processed. Greater values mean the area gets processed first. This is useful for areas which have an space override different from AREA_SPACE_OVERRIDE_DISABLED or AREA_SPACE_OVERRIDE_COMBINE, as they replace values, and are thus order-dependent.
Areas with the same priority value get evaluated in an unpredictable order, and should be differentiated if evaluation order is to be important.
.. _class_Area2D_set_space_override_mode:
- void **set_space_override_mode** **(** :ref:`int<class_int>` enable **)**
@@ -120,204 +320,4 @@ AREA_SPACE_OVERRIDE_REPLACE: This area replaces any gravity/damp, even the defau
AREA_SPACE_OVERRIDE_REPLACE_COMBINE: This area replaces any gravity/damp calculated so far, but keeps calculating the rest of the areas, down to the default one.
.. _class_Area2D_get_space_override_mode:
- :ref:`int<class_int>` **get_space_override_mode** **(** **)** const
Return the space override mode.
.. _class_Area2D_set_gravity_is_point:
- void **set_gravity_is_point** **(** :ref:`bool<class_bool>` enable **)**
When overriding space parameters, this method sets whether this area has a center of gravity. To set/get the location of the center of gravity, use :ref:`set_gravity_vector<class_Area2D_set_gravity_vector>`/:ref:`get_gravity_vector<class_Area2D_get_gravity_vector>`.
.. _class_Area2D_is_gravity_a_point:
- :ref:`bool<class_bool>` **is_gravity_a_point** **(** **)** const
Return whether gravity is a point. A point gravity will attract objects towards it, as opposed to a gravity vector, which moves them in a given direction.
.. _class_Area2D_set_gravity_distance_scale:
- void **set_gravity_distance_scale** **(** :ref:`float<class_float>` distance_scale **)**
Set the falloff factor for point gravity. The greater this value is, the faster the strength of gravity decreases with the square of distance.
.. _class_Area2D_get_gravity_distance_scale:
- :ref:`float<class_float>` **get_gravity_distance_scale** **(** **)** const
Return the falloff factor for point gravity.
.. _class_Area2D_set_gravity_vector:
- void **set_gravity_vector** **(** :ref:`Vector2<class_vector2>` vector **)**
Set the gravity vector. This vector does not have to be normalized.
If gravity is a point (see :ref:`is_gravity_a_point<class_Area2D_is_gravity_a_point>`), this will be the attraction center.
.. _class_Area2D_get_gravity_vector:
- :ref:`Vector2<class_vector2>` **get_gravity_vector** **(** **)** const
Return the gravity vector. If gravity is a point (see :ref:`is_gravity_a_point<class_Area2D_is_gravity_a_point>`), this will be the attraction center.
.. _class_Area2D_set_gravity:
- void **set_gravity** **(** :ref:`float<class_float>` gravity **)**
Set the gravity intensity. This is useful to alter the force of gravity without altering its direction.
This value multiplies the gravity vector, whether it is the given vector (:ref:`set_gravity_vector<class_Area2D_set_gravity_vector>`), or a calculated one (when using a center of gravity).
.. _class_Area2D_get_gravity:
- :ref:`float<class_float>` **get_gravity** **(** **)** const
Return the gravity intensity.
.. _class_Area2D_set_linear_damp:
- void **set_linear_damp** **(** :ref:`float<class_float>` linear_damp **)**
Set the rate at which objects stop moving in this area, if there are not any other forces moving it. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops.
In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second.
.. _class_Area2D_get_linear_damp:
- :ref:`float<class_float>` **get_linear_damp** **(** **)** const
Return the linear damp rate.
.. _class_Area2D_set_angular_damp:
- void **set_angular_damp** **(** :ref:`float<class_float>` angular_damp **)**
Set the rate at which objects stop spinning in this area, if there are not any other forces making it spin. The value is a fraction of its current speed, lost per second. Thus, a value of 1.0 should mean stopping immediately, and 0.0 means the object never stops.
In practice, as the fraction of speed lost gets smaller with each frame, a value of 1.0 does not mean the object will stop in exactly one second. Only when the physics calculations are done at 1 frame per second, it does stop in a second.
.. _class_Area2D_get_angular_damp:
- :ref:`float<class_float>` **get_angular_damp** **(** **)** const
Return the angular damp rate.
.. _class_Area2D_set_priority:
- void **set_priority** **(** :ref:`float<class_float>` priority **)**
Set the order in which the area is processed. Greater values mean the area gets processed first. This is useful for areas which have an space override different from AREA_SPACE_OVERRIDE_DISABLED or AREA_SPACE_OVERRIDE_COMBINE, as they replace values, and are thus order-dependent.
Areas with the same priority value get evaluated in an unpredictable order, and should be differentiated if evaluation order is to be important.
.. _class_Area2D_get_priority:
- :ref:`float<class_float>` **get_priority** **(** **)** const
Return the processing order of this area.
.. _class_Area2D_set_collision_mask:
- void **set_collision_mask** **(** :ref:`int<class_int>` collision_mask **)**
Set the physics layers this area can scan for collisions.
.. _class_Area2D_get_collision_mask:
- :ref:`int<class_int>` **get_collision_mask** **(** **)** const
Return the physics layers this area can scan for collisions.
.. _class_Area2D_set_layer_mask:
- void **set_layer_mask** **(** :ref:`int<class_int>` layer_mask **)**
Set the physics layers this area is in.
Collidable objects can exist in any of 32 different layers. These layers are not visual, but more of a tagging system instead. A collidable can use these layers/tags to select with which objects it can collide, using :ref:`set_collision_mask<class_Area2D_set_collision_mask>`.
A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A.
.. _class_Area2D_get_layer_mask:
- :ref:`int<class_int>` **get_layer_mask** **(** **)** const
Return the physics layer this area is in.
.. _class_Area2D_set_collision_mask_bit:
- void **set_collision_mask_bit** **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)**
Set/clear individual bits on the collision mask. This makes selecting the areas scanned easier.
.. _class_Area2D_get_collision_mask_bit:
- :ref:`bool<class_bool>` **get_collision_mask_bit** **(** :ref:`int<class_int>` bit **)** const
Return an individual bit on the collision mask.
.. _class_Area2D_set_layer_mask_bit:
- void **set_layer_mask_bit** **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)**
Set/clear individual bits on the layer mask. This makes getting an area in/out of only one layer easier.
.. _class_Area2D_get_layer_mask_bit:
- :ref:`bool<class_bool>` **get_layer_mask_bit** **(** :ref:`int<class_int>` bit **)** const
Return an individual bit on the layer mask.
.. _class_Area2D_set_enable_monitoring:
- void **set_enable_monitoring** **(** :ref:`bool<class_bool>` enable **)**
Set whether this area can detect bodies/areas entering/exiting it.
.. _class_Area2D_is_monitoring_enabled:
- :ref:`bool<class_bool>` **is_monitoring_enabled** **(** **)** const
Return whether this area detects bodies/areas entering/exiting it.
.. _class_Area2D_set_monitorable:
- void **set_monitorable** **(** :ref:`bool<class_bool>` enable **)**
Set whether this area can be detected by other, monitoring, areas. Only areas need to be marked as monitorable. Bodies are always so.
.. _class_Area2D_is_monitorable:
- :ref:`bool<class_bool>` **is_monitorable** **(** **)** const
Return whether this area can be detected by other, monitoring, areas.
.. _class_Area2D_get_overlapping_bodies:
- :ref:`Array<class_array>` **get_overlapping_bodies** **(** **)** const
Return a list of the bodies (:ref:`PhysicsBody2D<class_physicsbody2d>`) that are totally or partially inside this area.
.. _class_Area2D_get_overlapping_areas:
- :ref:`Array<class_array>` **get_overlapping_areas** **(** **)** const
Return a list of the areas that are totally or partially inside this area.
.. _class_Area2D_overlaps_body:
- :ref:`bool<class_bool>` **overlaps_body** **(** :ref:`Object<class_object>` body **)** const
Return whether the body passed is totally or partially inside this area.
.. _class_Area2D_overlaps_area:
- :ref:`bool<class_bool>` **overlaps_area** **(** :ref:`Object<class_object>` area **)** const
Return whether the area passed is totally or partially inside this area.

112
classes/class_array.rst
View File

@@ -16,6 +16,20 @@ Generic array datatype.
Member Functions
----------------
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`Array<class_Array_Array>` **(** :ref:`ColorArray<class_colorarray>` from **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`Array<class_Array_Array>` **(** :ref:`Vector3Array<class_vector3array>` from **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`Array<class_Array_Array>` **(** :ref:`Vector2Array<class_vector2array>` from **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`Array<class_Array_Array>` **(** :ref:`StringArray<class_stringarray>` from **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`Array<class_Array_Array>` **(** :ref:`RealArray<class_realarray>` from **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`Array<class_Array_Array>` **(** :ref:`IntArray<class_intarray>` from **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`Array<class_Array_Array>` **(** :ref:`RawArray<class_rawarray>` from **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`append<class_Array_append>` **(** var value **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
@@ -53,20 +67,6 @@ Member Functions
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`sort_custom<class_Array_sort_custom>` **(** :ref:`Object<class_object>` obj, :ref:`String<class_string>` func **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`Array<class_Array_Array>` **(** :ref:`RawArray<class_rawarray>` from **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`Array<class_Array_Array>` **(** :ref:`IntArray<class_intarray>` from **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`Array<class_Array_Array>` **(** :ref:`RealArray<class_realarray>` from **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`Array<class_Array_Array>` **(** :ref:`StringArray<class_stringarray>` from **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`Array<class_Array_Array>` **(** :ref:`Vector2Array<class_vector2array>` from **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`Array<class_Array_Array>` **(** :ref:`Vector3Array<class_vector3array>` from **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`Array<class_Array_Array>` **(** :ref:`ColorArray<class_colorarray>` from **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
Description
-----------
@@ -76,6 +76,48 @@ Generic array, contains several elements of any type, accessible by numerical in
Member Function Description
---------------------------
.. _class_Array_Array:
- :ref:`Array<class_array>` **Array** **(** :ref:`ColorArray<class_colorarray>` from **)**
Construct an array from a :ref:`RawArray<class_rawarray>`.
.. _class_Array_Array:
- :ref:`Array<class_array>` **Array** **(** :ref:`Vector3Array<class_vector3array>` from **)**
Construct an array from a :ref:`RawArray<class_rawarray>`.
.. _class_Array_Array:
- :ref:`Array<class_array>` **Array** **(** :ref:`Vector2Array<class_vector2array>` from **)**
Construct an array from a :ref:`RawArray<class_rawarray>`.
.. _class_Array_Array:
- :ref:`Array<class_array>` **Array** **(** :ref:`StringArray<class_stringarray>` from **)**
Construct an array from a :ref:`RawArray<class_rawarray>`.
.. _class_Array_Array:
- :ref:`Array<class_array>` **Array** **(** :ref:`RealArray<class_realarray>` from **)**
Construct an array from a :ref:`RawArray<class_rawarray>`.
.. _class_Array_Array:
- :ref:`Array<class_array>` **Array** **(** :ref:`IntArray<class_intarray>` from **)**
Construct an array from a :ref:`RawArray<class_rawarray>`.
.. _class_Array_Array:
- :ref:`Array<class_array>` **Array** **(** :ref:`RawArray<class_rawarray>` from **)**
Construct an array from a :ref:`RawArray<class_rawarray>`.
.. _class_Array_append:
- void **append** **(** var value **)**
@@ -184,46 +226,4 @@ Sort the array using natural order.
Sort the array using a custom method. The arguments are an object that holds the method and the name of such method. The custom method receives two arguments (a pair of elements from the array) and must return true if the first argument is less than the second, and return false otherwise.
.. _class_Array_Array:
- :ref:`Array<class_array>` **Array** **(** :ref:`RawArray<class_rawarray>` from **)**
Construct an array from a :ref:`RawArray<class_rawarray>`.
.. _class_Array_Array:
- :ref:`Array<class_array>` **Array** **(** :ref:`IntArray<class_intarray>` from **)**
Construct an array from a :ref:`RawArray<class_rawarray>`.
.. _class_Array_Array:
- :ref:`Array<class_array>` **Array** **(** :ref:`RealArray<class_realarray>` from **)**
Construct an array from a :ref:`RawArray<class_rawarray>`.
.. _class_Array_Array:
- :ref:`Array<class_array>` **Array** **(** :ref:`StringArray<class_stringarray>` from **)**
Construct an array from a :ref:`RawArray<class_rawarray>`.
.. _class_Array_Array:
- :ref:`Array<class_array>` **Array** **(** :ref:`Vector2Array<class_vector2array>` from **)**
Construct an array from a :ref:`RawArray<class_rawarray>`.
.. _class_Array_Array:
- :ref:`Array<class_array>` **Array** **(** :ref:`Vector3Array<class_vector3array>` from **)**
Construct an array from a :ref:`RawArray<class_rawarray>`.
.. _class_Array_Array:
- :ref:`Array<class_array>` **Array** **(** :ref:`ColorArray<class_colorarray>` from **)**
Construct an array from a :ref:`RawArray<class_rawarray>`.

40
classes/class_atlastexture.rst
View File

@@ -18,45 +18,45 @@ Brief Description
Member Functions
----------------
+--------------------------------+--------------------------------------------------------------------------------------------------+
| void | :ref:`set_atlas<class_AtlasTexture_set_atlas>` **(** :ref:`Texture<class_texture>` atlas **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>` | :ref:`get_atlas<class_AtlasTexture_get_atlas>` **(** **)** const |
+--------------------------------+--------------------------------------------------------------------------------------------------+
| void | :ref:`set_region<class_AtlasTexture_set_region>` **(** :ref:`Rect2<class_rect2>` region **)** |
| :ref:`Rect2<class_rect2>` | :ref:`get_margin<class_AtlasTexture_get_margin>` **(** **)** const |
+--------------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>` | :ref:`get_region<class_AtlasTexture_get_region>` **(** **)** const |
+--------------------------------+--------------------------------------------------------------------------------------------------+
| void | :ref:`set_atlas<class_AtlasTexture_set_atlas>` **(** :ref:`Texture<class_texture>` atlas **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------+
| void | :ref:`set_margin<class_AtlasTexture_set_margin>` **(** :ref:`Rect2<class_rect2>` margin **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>` | :ref:`get_margin<class_AtlasTexture_get_margin>` **(** **)** const |
| void | :ref:`set_region<class_AtlasTexture_set_region>` **(** :ref:`Rect2<class_rect2>` region **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------+
Member Function Description
---------------------------
.. _class_AtlasTexture_set_atlas:
- void **set_atlas** **(** :ref:`Texture<class_texture>` atlas **)**
.. _class_AtlasTexture_get_atlas:
- :ref:`Texture<class_texture>` **get_atlas** **(** **)** const
.. _class_AtlasTexture_set_region:
- void **set_region** **(** :ref:`Rect2<class_rect2>` region **)**
.. _class_AtlasTexture_get_region:
- :ref:`Rect2<class_rect2>` **get_region** **(** **)** const
.. _class_AtlasTexture_set_margin:
- void **set_margin** **(** :ref:`Rect2<class_rect2>` margin **)**
.. _class_AtlasTexture_get_margin:
- :ref:`Rect2<class_rect2>` **get_margin** **(** **)** const
.. _class_AtlasTexture_get_region:
- :ref:`Rect2<class_rect2>` **get_region** **(** **)** const
.. _class_AtlasTexture_set_atlas:
- void **set_atlas** **(** :ref:`Texture<class_texture>` atlas **)**
.. _class_AtlasTexture_set_margin:
- void **set_margin** **(** :ref:`Rect2<class_rect2>` margin **)**
.. _class_AtlasTexture_set_region:
- void **set_region** **(** :ref:`Rect2<class_rect2>` region **)**

504
classes/class_audioserver.rst
View File

@@ -20,109 +20,103 @@ Server interface for low level audio access.
Member Functions
----------------
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`free_rid<class_AudioServer_free_rid>` **(** :ref:`RID<class_rid>` rid **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_event_voice_global_volume_scale<class_AudioServer_get_event_voice_global_volume_scale>` **(** **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_fx_global_volume_scale<class_AudioServer_get_fx_global_volume_scale>` **(** **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_stream_global_volume_scale<class_AudioServer_get_stream_global_volume_scale>` **(** **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`sample_create<class_AudioServer_sample_create>` **(** :ref:`int<class_int>` format, :ref:`bool<class_bool>` stereo, :ref:`int<class_int>` length **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`sample_set_description<class_AudioServer_sample_set_description>` **(** :ref:`RID<class_rid>` sample, :ref:`String<class_string>` description **)** |
| :ref:`RawArray<class_rawarray>` | :ref:`sample_get_data<class_AudioServer_sample_get_data>` **(** :ref:`RID<class_rid>` sample **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`sample_get_description<class_AudioServer_sample_get_description>` **(** :ref:`RID<class_rid>` sample **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`sample_get_format<class_AudioServer_sample_get_format>` **(** :ref:`RID<class_rid>` sample **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`sample_is_stereo<class_AudioServer_sample_is_stereo>` **(** :ref:`RID<class_rid>` sample **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`sample_get_length<class_AudioServer_sample_get_length>` **(** :ref:`RID<class_rid>` sample **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`sample_set_signed_data<class_AudioServer_sample_set_signed_data>` **(** :ref:`RID<class_rid>` sample, :ref:`RealArray<class_realarray>` data **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`sample_set_data<class_AudioServer_sample_set_data>` **(** :ref:`RID<class_rid>` sample, :ref:`RawArray<class_rawarray>` data **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RawArray<class_rawarray>` | :ref:`sample_get_data<class_AudioServer_sample_get_data>` **(** :ref:`RID<class_rid>` sample **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`sample_set_mix_rate<class_AudioServer_sample_set_mix_rate>` **(** :ref:`RID<class_rid>` sample, :ref:`int<class_int>` mix_rate **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`sample_get_mix_rate<class_AudioServer_sample_get_mix_rate>` **(** :ref:`RID<class_rid>` sample **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`sample_set_loop_format<class_AudioServer_sample_set_loop_format>` **(** :ref:`RID<class_rid>` sample, :ref:`int<class_int>` loop_format **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`sample_get_loop_format<class_AudioServer_sample_get_loop_format>` **(** :ref:`RID<class_rid>` sample **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`sample_set_loop_begin<class_AudioServer_sample_set_loop_begin>` **(** :ref:`RID<class_rid>` sample, :ref:`int<class_int>` pos **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`sample_get_loop_begin<class_AudioServer_sample_get_loop_begin>` **(** :ref:`RID<class_rid>` sample **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`sample_get_loop_end<class_AudioServer_sample_get_loop_end>` **(** :ref:`RID<class_rid>` sample **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`sample_get_loop_format<class_AudioServer_sample_get_loop_format>` **(** :ref:`RID<class_rid>` sample **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`sample_get_mix_rate<class_AudioServer_sample_get_mix_rate>` **(** :ref:`RID<class_rid>` sample **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`sample_is_stereo<class_AudioServer_sample_is_stereo>` **(** :ref:`RID<class_rid>` sample **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`sample_set_data<class_AudioServer_sample_set_data>` **(** :ref:`RID<class_rid>` sample, :ref:`RawArray<class_rawarray>` data **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`sample_set_description<class_AudioServer_sample_set_description>` **(** :ref:`RID<class_rid>` sample, :ref:`String<class_string>` description **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`sample_set_loop_begin<class_AudioServer_sample_set_loop_begin>` **(** :ref:`RID<class_rid>` sample, :ref:`int<class_int>` pos **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`sample_set_loop_end<class_AudioServer_sample_set_loop_end>` **(** :ref:`RID<class_rid>` sample, :ref:`int<class_int>` pos **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`sample_get_loop_end<class_AudioServer_sample_get_loop_end>` **(** :ref:`RID<class_rid>` sample **)** const |
| void | :ref:`sample_set_loop_format<class_AudioServer_sample_set_loop_format>` **(** :ref:`RID<class_rid>` sample, :ref:`int<class_int>` loop_format **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`sample_set_mix_rate<class_AudioServer_sample_set_mix_rate>` **(** :ref:`RID<class_rid>` sample, :ref:`int<class_int>` mix_rate **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`sample_set_signed_data<class_AudioServer_sample_set_signed_data>` **(** :ref:`RID<class_rid>` sample, :ref:`RealArray<class_realarray>` data **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_event_voice_global_volume_scale<class_AudioServer_set_event_voice_global_volume_scale>` **(** :ref:`float<class_float>` scale **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_fx_global_volume_scale<class_AudioServer_set_fx_global_volume_scale>` **(** :ref:`float<class_float>` scale **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_stream_global_volume_scale<class_AudioServer_set_stream_global_volume_scale>` **(** :ref:`float<class_float>` scale **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`voice_create<class_AudioServer_voice_create>` **(** **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`voice_play<class_AudioServer_voice_play>` **(** :ref:`RID<class_rid>` voice, :ref:`RID<class_rid>` sample **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`voice_set_volume<class_AudioServer_voice_set_volume>` **(** :ref:`RID<class_rid>` voice, :ref:`float<class_float>` volume **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`voice_set_pan<class_AudioServer_voice_set_pan>` **(** :ref:`RID<class_rid>` voice, :ref:`float<class_float>` pan, :ref:`float<class_float>` depth=0, :ref:`float<class_float>` height=0 **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`voice_set_filter<class_AudioServer_voice_set_filter>` **(** :ref:`RID<class_rid>` voice, :ref:`int<class_int>` type, :ref:`float<class_float>` cutoff, :ref:`float<class_float>` resonance, :ref:`float<class_float>` gain=0 **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`voice_set_chorus<class_AudioServer_voice_set_chorus>` **(** :ref:`RID<class_rid>` voice, :ref:`float<class_float>` chorus **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`voice_set_reverb<class_AudioServer_voice_set_reverb>` **(** :ref:`RID<class_rid>` voice, :ref:`int<class_int>` room, :ref:`float<class_float>` reverb **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`voice_set_mix_rate<class_AudioServer_voice_set_mix_rate>` **(** :ref:`RID<class_rid>` voice, :ref:`int<class_int>` rate **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`voice_set_positional<class_AudioServer_voice_set_positional>` **(** :ref:`RID<class_rid>` voice, :ref:`bool<class_bool>` enabled **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice_get_volume<class_AudioServer_voice_get_volume>` **(** :ref:`RID<class_rid>` voice **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice_get_pan<class_AudioServer_voice_get_pan>` **(** :ref:`RID<class_rid>` voice **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice_get_pan_height<class_AudioServer_voice_get_pan_height>` **(** :ref:`RID<class_rid>` voice **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice_get_pan_depth<class_AudioServer_voice_get_pan_depth>` **(** :ref:`RID<class_rid>` voice **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`voice_get_filter_type<class_AudioServer_voice_get_filter_type>` **(** :ref:`RID<class_rid>` voice **)** const |
| :ref:`float<class_float>` | :ref:`voice_get_chorus<class_AudioServer_voice_get_chorus>` **(** :ref:`RID<class_rid>` voice **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice_get_filter_cutoff<class_AudioServer_voice_get_filter_cutoff>` **(** :ref:`RID<class_rid>` voice **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice_get_filter_resonance<class_AudioServer_voice_get_filter_resonance>` **(** :ref:`RID<class_rid>` voice **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice_get_chorus<class_AudioServer_voice_get_chorus>` **(** :ref:`RID<class_rid>` voice **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`voice_get_reverb_type<class_AudioServer_voice_get_reverb_type>` **(** :ref:`RID<class_rid>` voice **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice_get_reverb<class_AudioServer_voice_get_reverb>` **(** :ref:`RID<class_rid>` voice **)** const |
| :ref:`int<class_int>` | :ref:`voice_get_filter_type<class_AudioServer_voice_get_filter_type>` **(** :ref:`RID<class_rid>` voice **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`voice_get_mix_rate<class_AudioServer_voice_get_mix_rate>` **(** :ref:`RID<class_rid>` voice **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice_get_pan<class_AudioServer_voice_get_pan>` **(** :ref:`RID<class_rid>` voice **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice_get_pan_depth<class_AudioServer_voice_get_pan_depth>` **(** :ref:`RID<class_rid>` voice **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice_get_pan_height<class_AudioServer_voice_get_pan_height>` **(** :ref:`RID<class_rid>` voice **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice_get_reverb<class_AudioServer_voice_get_reverb>` **(** :ref:`RID<class_rid>` voice **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`voice_get_reverb_type<class_AudioServer_voice_get_reverb_type>` **(** :ref:`RID<class_rid>` voice **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`voice_get_volume<class_AudioServer_voice_get_volume>` **(** :ref:`RID<class_rid>` voice **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`voice_is_positional<class_AudioServer_voice_is_positional>` **(** :ref:`RID<class_rid>` voice **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`voice_play<class_AudioServer_voice_play>` **(** :ref:`RID<class_rid>` voice, :ref:`RID<class_rid>` sample **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`voice_set_chorus<class_AudioServer_voice_set_chorus>` **(** :ref:`RID<class_rid>` voice, :ref:`float<class_float>` chorus **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`voice_set_filter<class_AudioServer_voice_set_filter>` **(** :ref:`RID<class_rid>` voice, :ref:`int<class_int>` type, :ref:`float<class_float>` cutoff, :ref:`float<class_float>` resonance, :ref:`float<class_float>` gain=0 **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`voice_set_mix_rate<class_AudioServer_voice_set_mix_rate>` **(** :ref:`RID<class_rid>` voice, :ref:`int<class_int>` rate **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`voice_set_pan<class_AudioServer_voice_set_pan>` **(** :ref:`RID<class_rid>` voice, :ref:`float<class_float>` pan, :ref:`float<class_float>` depth=0, :ref:`float<class_float>` height=0 **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`voice_set_positional<class_AudioServer_voice_set_positional>` **(** :ref:`RID<class_rid>` voice, :ref:`bool<class_bool>` enabled **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`voice_set_reverb<class_AudioServer_voice_set_reverb>` **(** :ref:`RID<class_rid>` voice, :ref:`int<class_int>` room, :ref:`float<class_float>` reverb **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`voice_set_volume<class_AudioServer_voice_set_volume>` **(** :ref:`RID<class_rid>` voice, :ref:`float<class_float>` volume **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`voice_stop<class_AudioServer_voice_stop>` **(** :ref:`RID<class_rid>` voice **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`free_rid<class_AudioServer_free_rid>` **(** :ref:`RID<class_rid>` rid **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_stream_global_volume_scale<class_AudioServer_set_stream_global_volume_scale>` **(** :ref:`float<class_float>` scale **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_stream_global_volume_scale<class_AudioServer_get_stream_global_volume_scale>` **(** **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_fx_global_volume_scale<class_AudioServer_set_fx_global_volume_scale>` **(** :ref:`float<class_float>` scale **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_fx_global_volume_scale<class_AudioServer_get_fx_global_volume_scale>` **(** **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_event_voice_global_volume_scale<class_AudioServer_set_event_voice_global_volume_scale>` **(** :ref:`float<class_float>` scale **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_event_voice_global_volume_scale<class_AudioServer_get_event_voice_global_volume_scale>` **(** **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Numeric Constants
-----------------
- **SAMPLE_FORMAT_PCM8** = **0** --- Sample format is 8 bits, signed.
- **SAMPLE_FORMAT_PCM16** = **1** --- Sample format is 16 bits, little-endian, signed.
- **SAMPLE_FORMAT_IMA_ADPCM** = **2** --- Sample format is IMA-ADPCM compressed.
- **SAMPLE_LOOP_NONE** = **0** --- Sample does not loop.
- **SAMPLE_LOOP_FORWARD** = **1** --- Sample loops in forward mode.
- **SAMPLE_LOOP_PING_PONG** = **2** --- Sample loops in a bidirectional way.
- **FILTER_NONE** = **0** --- Filter is disabled.
- **FILTER_LOWPASS** = **1** --- Filter is a resonant lowpass.
- **FILTER_BANDPASS** = **2** --- Filter is a resonant bandpass.
@@ -133,6 +127,12 @@ Numeric Constants
- **REVERB_MEDIUM** = **1** --- Medium reverb room (living room)
- **REVERB_LARGE** = **2** --- Large reverb room (warehouse).
- **REVERB_HALL** = **3** --- Large reverb room with long decay.
- **SAMPLE_FORMAT_PCM8** = **0** --- Sample format is 8 bits, signed.
- **SAMPLE_LOOP_NONE** = **0** --- Sample does not loop.
- **SAMPLE_FORMAT_PCM16** = **1** --- Sample format is 16 bits, little-endian, signed.
- **SAMPLE_LOOP_FORWARD** = **1** --- Sample loops in forward mode.
- **SAMPLE_FORMAT_IMA_ADPCM** = **2** --- Sample format is IMA-ADPCM compressed.
- **SAMPLE_LOOP_PING_PONG** = **2** --- Sample loops in a bidirectional way.
Description
-----------
@@ -142,6 +142,30 @@ AudioServer is a low level server interface for audio access. It is in charge of
Member Function Description
---------------------------
.. _class_AudioServer_free_rid:
- void **free_rid** **(** :ref:`RID<class_rid>` rid **)**
Free a :ref:`RID<class_rid>` resource.
.. _class_AudioServer_get_event_voice_global_volume_scale:
- :ref:`float<class_float>` **get_event_voice_global_volume_scale** **(** **)** const
Return the global scale for event-based stream playback.
.. _class_AudioServer_get_fx_global_volume_scale:
- :ref:`float<class_float>` **get_fx_global_volume_scale** **(** **)** const
Return the global scale for all voices.
.. _class_AudioServer_get_stream_global_volume_scale:
- :ref:`float<class_float>` **get_stream_global_volume_scale** **(** **)** const
Return the global scale for stream playback.
.. _class_AudioServer_sample_create:
- :ref:`RID<class_rid>` **sample_create** **(** :ref:`int<class_int>` format, :ref:`bool<class_bool>` stereo, :ref:`int<class_int>` length **)**
@@ -150,11 +174,11 @@ Create an audio sample, return a :ref:`RID<class_rid>` referencing it. The sampl
Even if a stereo sample consists of a left sample and a right sample, it still counts as one sample for length purposes.
.. _class_AudioServer_sample_set_description:
.. _class_AudioServer_sample_get_data:
- void **sample_set_description** **(** :ref:`RID<class_rid>` sample, :ref:`String<class_string>` description **)**
- :ref:`RawArray<class_rawarray>` **sample_get_data** **(** :ref:`RID<class_rid>` sample **)** const
Set the description of an audio sample. Mainly used for organization.
Return the sample data as an array of bytes. The length will be the expected length in bytes.
.. _class_AudioServer_sample_get_description:
@@ -168,27 +192,41 @@ Return the description of an audio sample. Mainly used for organization.
Return the format of the audio sample, in the form of the SAMPLE_FORMAT\_\* enum.
.. _class_AudioServer_sample_is_stereo:
- :ref:`bool<class_bool>` **sample_is_stereo** **(** :ref:`RID<class_rid>` sample **)** const
Return whether the sample is stereo (2 channels).
.. _class_AudioServer_sample_get_length:
- :ref:`int<class_int>` **sample_get_length** **(** :ref:`RID<class_rid>` sample **)** const
Return the length in samples (not bytes) of the audio sample. Even if a stereo sample consists of a left sample and a right sample, it still counts as one sample for length purposes.
.. _class_AudioServer_sample_set_signed_data:
.. _class_AudioServer_sample_get_loop_begin:
- void **sample_set_signed_data** **(** :ref:`RID<class_rid>` sample, :ref:`RealArray<class_realarray>` data **)**
- :ref:`int<class_int>` **sample_get_loop_begin** **(** :ref:`RID<class_rid>` sample **)** const
Set the sample data for a given sample as an array of floats. The length must be equal to the sample length or an error will be produced.
Return the initial loop point of a sample. Only has effect if sample loop is enabled. See :ref:`sample_set_loop_format<class_AudioServer_sample_set_loop_format>`.
For this method, a stereo sample is made from two samples. Thus, in case of a stereo sample, the array length must be twice the length returned by :ref:`sample_get_length<class_AudioServer_sample_get_length>`.
.. _class_AudioServer_sample_get_loop_end:
Trying to alter a SAMPLE_FORMAT_IMA_ADPCM sample is not supported. It will throw an error to the console, but will not alter the sample data.
- :ref:`int<class_int>` **sample_get_loop_end** **(** :ref:`RID<class_rid>` sample **)** const
Return the final loop point of a sample. Only has effect if sample loop is enabled. See :ref:`sample_set_loop_format<class_AudioServer_sample_set_loop_format>`.
.. _class_AudioServer_sample_get_loop_format:
- :ref:`int<class_int>` **sample_get_loop_format** **(** :ref:`RID<class_rid>` sample **)** const
Return the loop format for a sample, as a value from the SAMPLE_LOOP\_\* enum.
.. _class_AudioServer_sample_get_mix_rate:
- :ref:`int<class_int>` **sample_get_mix_rate** **(** :ref:`RID<class_rid>` sample **)** const
Return the mix rate of the given sample.
.. _class_AudioServer_sample_is_stereo:
- :ref:`bool<class_bool>` **sample_is_stereo** **(** :ref:`RID<class_rid>` sample **)** const
Return whether the sample is stereo (2 channels).
.. _class_AudioServer_sample_set_data:
@@ -204,35 +242,11 @@ If the sample format is SAMPLE_FORMAT_IMA_ADPCM, divide it by 2 (rounding any fr
If the sample is stereo (:ref:`sample_is_stereo<class_AudioServer_sample_is_stereo>`), multiply it by 2.
.. _class_AudioServer_sample_get_data:
.. _class_AudioServer_sample_set_description:
- :ref:`RawArray<class_rawarray>` **sample_get_data** **(** :ref:`RID<class_rid>` sample **)** const
- void **sample_set_description** **(** :ref:`RID<class_rid>` sample, :ref:`String<class_string>` description **)**
Return the sample data as an array of bytes. The length will be the expected length in bytes.
.. _class_AudioServer_sample_set_mix_rate:
- void **sample_set_mix_rate** **(** :ref:`RID<class_rid>` sample, :ref:`int<class_int>` mix_rate **)**
Change the default mix rate of a given sample.
.. _class_AudioServer_sample_get_mix_rate:
- :ref:`int<class_int>` **sample_get_mix_rate** **(** :ref:`RID<class_rid>` sample **)** const
Return the mix rate of the given sample.
.. _class_AudioServer_sample_set_loop_format:
- void **sample_set_loop_format** **(** :ref:`RID<class_rid>` sample, :ref:`int<class_int>` loop_format **)**
Set the loop format for a sample from the SAMPLE_LOOP\_\* enum. As a warning, Ping Pong loops may not be available on some hardware-mixing platforms.
.. _class_AudioServer_sample_get_loop_format:
- :ref:`int<class_int>` **sample_get_loop_format** **(** :ref:`RID<class_rid>` sample **)** const
Return the loop format for a sample, as a value from the SAMPLE_LOOP\_\* enum.
Set the description of an audio sample. Mainly used for organization.
.. _class_AudioServer_sample_set_loop_begin:
@@ -240,23 +254,51 @@ Return the loop format for a sample, as a value from the SAMPLE_LOOP\_\* enum.
Set the initial loop point of a sample. Only has effect if sample loop is enabled. See :ref:`sample_set_loop_format<class_AudioServer_sample_set_loop_format>`.
.. _class_AudioServer_sample_get_loop_begin:
- :ref:`int<class_int>` **sample_get_loop_begin** **(** :ref:`RID<class_rid>` sample **)** const
Return the initial loop point of a sample. Only has effect if sample loop is enabled. See :ref:`sample_set_loop_format<class_AudioServer_sample_set_loop_format>`.
.. _class_AudioServer_sample_set_loop_end:
- void **sample_set_loop_end** **(** :ref:`RID<class_rid>` sample, :ref:`int<class_int>` pos **)**
Set the final loop point of a sample. Only has effect if sample loop is enabled. See :ref:`sample_set_loop_format<class_AudioServer_sample_set_loop_format>`.
.. _class_AudioServer_sample_get_loop_end:
.. _class_AudioServer_sample_set_loop_format:
- :ref:`int<class_int>` **sample_get_loop_end** **(** :ref:`RID<class_rid>` sample **)** const
- void **sample_set_loop_format** **(** :ref:`RID<class_rid>` sample, :ref:`int<class_int>` loop_format **)**
Return the final loop point of a sample. Only has effect if sample loop is enabled. See :ref:`sample_set_loop_format<class_AudioServer_sample_set_loop_format>`.
Set the loop format for a sample from the SAMPLE_LOOP\_\* enum. As a warning, Ping Pong loops may not be available on some hardware-mixing platforms.
.. _class_AudioServer_sample_set_mix_rate:
- void **sample_set_mix_rate** **(** :ref:`RID<class_rid>` sample, :ref:`int<class_int>` mix_rate **)**
Change the default mix rate of a given sample.
.. _class_AudioServer_sample_set_signed_data:
- void **sample_set_signed_data** **(** :ref:`RID<class_rid>` sample, :ref:`RealArray<class_realarray>` data **)**
Set the sample data for a given sample as an array of floats. The length must be equal to the sample length or an error will be produced.
For this method, a stereo sample is made from two samples. Thus, in case of a stereo sample, the array length must be twice the length returned by :ref:`sample_get_length<class_AudioServer_sample_get_length>`.
Trying to alter a SAMPLE_FORMAT_IMA_ADPCM sample is not supported. It will throw an error to the console, but will not alter the sample data.
.. _class_AudioServer_set_event_voice_global_volume_scale:
- void **set_event_voice_global_volume_scale** **(** :ref:`float<class_float>` scale **)**
Set global scale for event-based stream (:ref:`EventStream<class_eventstream>`) playback. Default is 1.0.
.. _class_AudioServer_set_fx_global_volume_scale:
- void **set_fx_global_volume_scale** **(** :ref:`float<class_float>` scale **)**
Set global scale for all voices (not including streams). Default is 1.0.
.. _class_AudioServer_set_stream_global_volume_scale:
- void **set_stream_global_volume_scale** **(** :ref:`float<class_float>` scale **)**
Set global scale for stream playback. Default is 1.0.
.. _class_AudioServer_voice_create:
@@ -264,83 +306,11 @@ Return the final loop point of a sample. Only has effect if sample loop is enabl
Allocate a voice for playback. Voices are persistent. A voice can play a single sample at the same time. See :ref:`sample_create<class_AudioServer_sample_create>`.
.. _class_AudioServer_voice_play:
.. _class_AudioServer_voice_get_chorus:
- void **voice_play** **(** :ref:`RID<class_rid>` voice, :ref:`RID<class_rid>` sample **)**
- :ref:`float<class_float>` **voice_get_chorus** **(** :ref:`RID<class_rid>` voice **)** const
Start playback of a given voice using a given sample. If the voice was already playing it will be restarted.
.. _class_AudioServer_voice_set_volume:
- void **voice_set_volume** **(** :ref:`RID<class_rid>` voice, :ref:`float<class_float>` volume **)**
Change the volume of a currently playing voice. Volume is expressed as linear gain where 0.0 is mute and 1.0 is default.
.. _class_AudioServer_voice_set_pan:
- void **voice_set_pan** **(** :ref:`RID<class_rid>` voice, :ref:`float<class_float>` pan, :ref:`float<class_float>` depth=0, :ref:`float<class_float>` height=0 **)**
Change the pan of a currently playing voice and, optionally, the depth and height for a positional/3D sound. Panning values are expressed within the -1 to +1 range.
.. _class_AudioServer_voice_set_filter:
- void **voice_set_filter** **(** :ref:`RID<class_rid>` voice, :ref:`int<class_int>` type, :ref:`float<class_float>` cutoff, :ref:`float<class_float>` resonance, :ref:`float<class_float>` gain=0 **)**
Set a resonant filter post processing for the voice. Filter type is a value from the FILTER\_\* enum.
.. _class_AudioServer_voice_set_chorus:
- void **voice_set_chorus** **(** :ref:`RID<class_rid>` voice, :ref:`float<class_float>` chorus **)**
Set chorus send post processing for the voice (from 0 to 1).
.. _class_AudioServer_voice_set_reverb:
- void **voice_set_reverb** **(** :ref:`RID<class_rid>` voice, :ref:`int<class_int>` room, :ref:`float<class_float>` reverb **)**
Set the reverb send post processing for the voice (from 0 to 1) and the reverb type, from the REVERB\_\* enum.
.. _class_AudioServer_voice_set_mix_rate:
- void **voice_set_mix_rate** **(** :ref:`RID<class_rid>` voice, :ref:`int<class_int>` rate **)**
Set a different playback mix rate for the given voice.
.. _class_AudioServer_voice_set_positional:
- void **voice_set_positional** **(** :ref:`RID<class_rid>` voice, :ref:`bool<class_bool>` enabled **)**
Set whether a given voice is positional. This is only interpreted as a hint and used for backends that may support binaural encoding.
.. _class_AudioServer_voice_get_volume:
- :ref:`float<class_float>` **voice_get_volume** **(** :ref:`RID<class_rid>` voice **)** const
Return the current volume for a given voice.
.. _class_AudioServer_voice_get_pan:
- :ref:`float<class_float>` **voice_get_pan** **(** :ref:`RID<class_rid>` voice **)** const
Return the current pan for a given voice (-1 to +1 range).
.. _class_AudioServer_voice_get_pan_height:
- :ref:`float<class_float>` **voice_get_pan_height** **(** :ref:`RID<class_rid>` voice **)** const
Return the current pan height for a given voice (-1 to +1 range).
.. _class_AudioServer_voice_get_pan_depth:
- :ref:`float<class_float>` **voice_get_pan_depth** **(** :ref:`RID<class_rid>` voice **)** const
Return the current pan depth for a given voice (-1 to +1 range).
.. _class_AudioServer_voice_get_filter_type:
- :ref:`int<class_int>` **voice_get_filter_type** **(** :ref:`RID<class_rid>` voice **)** const
Return the current selected filter type for a given voice, from the FILTER\_\* enum.
Return the current chorus send for a given voice (0 to 1).
.. _class_AudioServer_voice_get_filter_cutoff:
@@ -354,23 +324,11 @@ Return the current filter cutoff (in hz) for a given voice.
Return the current filter resonance for a given voice.
.. _class_AudioServer_voice_get_chorus:
.. _class_AudioServer_voice_get_filter_type:
- :ref:`float<class_float>` **voice_get_chorus** **(** :ref:`RID<class_rid>` voice **)** const
- :ref:`int<class_int>` **voice_get_filter_type** **(** :ref:`RID<class_rid>` voice **)** const
Return the current chorus send for a given voice (0 to 1).
.. _class_AudioServer_voice_get_reverb_type:
- :ref:`int<class_int>` **voice_get_reverb_type** **(** :ref:`RID<class_rid>` voice **)** const
Return the current reverb type for a given voice from the REVERB\_\* enum.
.. _class_AudioServer_voice_get_reverb:
- :ref:`float<class_float>` **voice_get_reverb** **(** :ref:`RID<class_rid>` voice **)** const
Return the current reverb send for a given voice (0 to 1).
Return the current selected filter type for a given voice, from the FILTER\_\* enum.
.. _class_AudioServer_voice_get_mix_rate:
@@ -378,58 +336,100 @@ Return the current reverb send for a given voice (0 to 1).
Return the current mix rate for a given voice.
.. _class_AudioServer_voice_get_pan:
- :ref:`float<class_float>` **voice_get_pan** **(** :ref:`RID<class_rid>` voice **)** const
Return the current pan for a given voice (-1 to +1 range).
.. _class_AudioServer_voice_get_pan_depth:
- :ref:`float<class_float>` **voice_get_pan_depth** **(** :ref:`RID<class_rid>` voice **)** const
Return the current pan depth for a given voice (-1 to +1 range).
.. _class_AudioServer_voice_get_pan_height:
- :ref:`float<class_float>` **voice_get_pan_height** **(** :ref:`RID<class_rid>` voice **)** const
Return the current pan height for a given voice (-1 to +1 range).
.. _class_AudioServer_voice_get_reverb:
- :ref:`float<class_float>` **voice_get_reverb** **(** :ref:`RID<class_rid>` voice **)** const
Return the current reverb send for a given voice (0 to 1).
.. _class_AudioServer_voice_get_reverb_type:
- :ref:`int<class_int>` **voice_get_reverb_type** **(** :ref:`RID<class_rid>` voice **)** const
Return the current reverb type for a given voice from the REVERB\_\* enum.
.. _class_AudioServer_voice_get_volume:
- :ref:`float<class_float>` **voice_get_volume** **(** :ref:`RID<class_rid>` voice **)** const
Return the current volume for a given voice.
.. _class_AudioServer_voice_is_positional:
- :ref:`bool<class_bool>` **voice_is_positional** **(** :ref:`RID<class_rid>` voice **)** const
Return whether the current voice is positional. See :ref:`voice_set_positional<class_AudioServer_voice_set_positional>`.
.. _class_AudioServer_voice_play:
- void **voice_play** **(** :ref:`RID<class_rid>` voice, :ref:`RID<class_rid>` sample **)**
Start playback of a given voice using a given sample. If the voice was already playing it will be restarted.
.. _class_AudioServer_voice_set_chorus:
- void **voice_set_chorus** **(** :ref:`RID<class_rid>` voice, :ref:`float<class_float>` chorus **)**
Set chorus send post processing for the voice (from 0 to 1).
.. _class_AudioServer_voice_set_filter:
- void **voice_set_filter** **(** :ref:`RID<class_rid>` voice, :ref:`int<class_int>` type, :ref:`float<class_float>` cutoff, :ref:`float<class_float>` resonance, :ref:`float<class_float>` gain=0 **)**
Set a resonant filter post processing for the voice. Filter type is a value from the FILTER\_\* enum.
.. _class_AudioServer_voice_set_mix_rate:
- void **voice_set_mix_rate** **(** :ref:`RID<class_rid>` voice, :ref:`int<class_int>` rate **)**
Set a different playback mix rate for the given voice.
.. _class_AudioServer_voice_set_pan:
- void **voice_set_pan** **(** :ref:`RID<class_rid>` voice, :ref:`float<class_float>` pan, :ref:`float<class_float>` depth=0, :ref:`float<class_float>` height=0 **)**
Change the pan of a currently playing voice and, optionally, the depth and height for a positional/3D sound. Panning values are expressed within the -1 to +1 range.
.. _class_AudioServer_voice_set_positional:
- void **voice_set_positional** **(** :ref:`RID<class_rid>` voice, :ref:`bool<class_bool>` enabled **)**
Set whether a given voice is positional. This is only interpreted as a hint and used for backends that may support binaural encoding.
.. _class_AudioServer_voice_set_reverb:
- void **voice_set_reverb** **(** :ref:`RID<class_rid>` voice, :ref:`int<class_int>` room, :ref:`float<class_float>` reverb **)**
Set the reverb send post processing for the voice (from 0 to 1) and the reverb type, from the REVERB\_\* enum.
.. _class_AudioServer_voice_set_volume:
- void **voice_set_volume** **(** :ref:`RID<class_rid>` voice, :ref:`float<class_float>` volume **)**
Change the volume of a currently playing voice. Volume is expressed as linear gain where 0.0 is mute and 1.0 is default.
.. _class_AudioServer_voice_stop:
- void **voice_stop** **(** :ref:`RID<class_rid>` voice **)**
Stop a given voice.
.. _class_AudioServer_free_rid:
- void **free_rid** **(** :ref:`RID<class_rid>` rid **)**
Free a :ref:`RID<class_rid>` resource.
.. _class_AudioServer_set_stream_global_volume_scale:
- void **set_stream_global_volume_scale** **(** :ref:`float<class_float>` scale **)**
Set global scale for stream playback. Default is 1.0.
.. _class_AudioServer_get_stream_global_volume_scale:
- :ref:`float<class_float>` **get_stream_global_volume_scale** **(** **)** const
Return the global scale for stream playback.
.. _class_AudioServer_set_fx_global_volume_scale:
- void **set_fx_global_volume_scale** **(** :ref:`float<class_float>` scale **)**
Set global scale for all voices (not including streams). Default is 1.0.
.. _class_AudioServer_get_fx_global_volume_scale:
- :ref:`float<class_float>` **get_fx_global_volume_scale** **(** **)** const
Return the global scale for all voices.
.. _class_AudioServer_set_event_voice_global_volume_scale:
- void **set_event_voice_global_volume_scale** **(** :ref:`float<class_float>` scale **)**
Set global scale for event-based stream (:ref:`EventStream<class_eventstream>`) playback. Default is 1.0.
.. _class_AudioServer_get_event_voice_global_volume_scale:
- :ref:`float<class_float>` **get_event_voice_global_volume_scale** **(** **)** const
Return the global scale for event-based stream playback.

106
classes/class_audiostreamplayback.rst
View File

@@ -19,80 +19,80 @@ Member Functions
----------------
+----------------------------+------------------------------------------------------------------------------------------------------+
| void | :ref:`play<class_AudioStreamPlayback_play>` **(** :ref:`float<class_float>` from_pos_sec=0 **)** |
+----------------------------+------------------------------------------------------------------------------------------------------+
| void | :ref:`stop<class_AudioStreamPlayback_stop>` **(** **)** |
+----------------------------+------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AudioStreamPlayback_is_playing>` **(** **)** const |
+----------------------------+------------------------------------------------------------------------------------------------------+
| void | :ref:`set_loop<class_AudioStreamPlayback_set_loop>` **(** :ref:`bool<class_bool>` enabled **)** |
+----------------------------+------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_loop<class_AudioStreamPlayback_has_loop>` **(** **)** const |
+----------------------------+------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_loop_count<class_AudioStreamPlayback_get_loop_count>` **(** **)** const |
+----------------------------+------------------------------------------------------------------------------------------------------+
| void | :ref:`seek_pos<class_AudioStreamPlayback_seek_pos>` **(** :ref:`float<class_float>` pos **)** |
+----------------------------+------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_pos<class_AudioStreamPlayback_get_pos>` **(** **)** const |
| :ref:`int<class_int>` | :ref:`get_channels<class_AudioStreamPlayback_get_channels>` **(** **)** const |
+----------------------------+------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_length<class_AudioStreamPlayback_get_length>` **(** **)** const |
+----------------------------+------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_channels<class_AudioStreamPlayback_get_channels>` **(** **)** const |
| :ref:`int<class_int>` | :ref:`get_loop_count<class_AudioStreamPlayback_get_loop_count>` **(** **)** const |
+----------------------------+------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_minimum_buffer_size<class_AudioStreamPlayback_get_minimum_buffer_size>` **(** **)** const |
+----------------------------+------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_mix_rate<class_AudioStreamPlayback_get_mix_rate>` **(** **)** const |
+----------------------------+------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_minimum_buffer_size<class_AudioStreamPlayback_get_minimum_buffer_size>` **(** **)** const |
| :ref:`float<class_float>` | :ref:`get_pos<class_AudioStreamPlayback_get_pos>` **(** **)** const |
+----------------------------+------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_loop<class_AudioStreamPlayback_has_loop>` **(** **)** const |
+----------------------------+------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_playing<class_AudioStreamPlayback_is_playing>` **(** **)** const |
+----------------------------+------------------------------------------------------------------------------------------------------+
| void | :ref:`play<class_AudioStreamPlayback_play>` **(** :ref:`float<class_float>` from_pos_sec=0 **)** |
+----------------------------+------------------------------------------------------------------------------------------------------+
| void | :ref:`seek_pos<class_AudioStreamPlayback_seek_pos>` **(** :ref:`float<class_float>` pos **)** |
+----------------------------+------------------------------------------------------------------------------------------------------+
| void | :ref:`set_loop<class_AudioStreamPlayback_set_loop>` **(** :ref:`bool<class_bool>` enabled **)** |
+----------------------------+------------------------------------------------------------------------------------------------------+
| void | :ref:`stop<class_AudioStreamPlayback_stop>` **(** **)** |
+----------------------------+------------------------------------------------------------------------------------------------------+
Member Function Description
---------------------------
.. _class_AudioStreamPlayback_play:
.. _class_AudioStreamPlayback_get_channels:
- void **play** **(** :ref:`float<class_float>` from_pos_sec=0 **)**
.. _class_AudioStreamPlayback_stop:
- void **stop** **(** **)**
.. _class_AudioStreamPlayback_is_playing:
- :ref:`bool<class_bool>` **is_playing** **(** **)** const
.. _class_AudioStreamPlayback_set_loop:
- void **set_loop** **(** :ref:`bool<class_bool>` enabled **)**
.. _class_AudioStreamPlayback_has_loop:
- :ref:`bool<class_bool>` **has_loop** **(** **)** const
.. _class_AudioStreamPlayback_get_loop_count:
- :ref:`int<class_int>` **get_loop_count** **(** **)** const
.. _class_AudioStreamPlayback_seek_pos:
- void **seek_pos** **(** :ref:`float<class_float>` pos **)**
.. _class_AudioStreamPlayback_get_pos:
- :ref:`float<class_float>` **get_pos** **(** **)** const
- :ref:`int<class_int>` **get_channels** **(** **)** const
.. _class_AudioStreamPlayback_get_length:
- :ref:`float<class_float>` **get_length** **(** **)** const
.. _class_AudioStreamPlayback_get_channels:
.. _class_AudioStreamPlayback_get_loop_count:
- :ref:`int<class_int>` **get_channels** **(** **)** const
.. _class_AudioStreamPlayback_get_mix_rate:
- :ref:`int<class_int>` **get_mix_rate** **(** **)** const
- :ref:`int<class_int>` **get_loop_count** **(** **)** const
.. _class_AudioStreamPlayback_get_minimum_buffer_size:
- :ref:`int<class_int>` **get_minimum_buffer_size** **(** **)** const
.. _class_AudioStreamPlayback_get_mix_rate:
- :ref:`int<class_int>` **get_mix_rate** **(** **)** const
.. _class_AudioStreamPlayback_get_pos:
- :ref:`float<class_float>` **get_pos** **(** **)** const
.. _class_AudioStreamPlayback_has_loop:
- :ref:`bool<class_bool>` **has_loop** **(** **)** const
.. _class_AudioStreamPlayback_is_playing:
- :ref:`bool<class_bool>` **is_playing** **(** **)** const
.. _class_AudioStreamPlayback_play:
- void **play** **(** :ref:`float<class_float>` from_pos_sec=0 **)**
.. _class_AudioStreamPlayback_seek_pos:
- void **seek_pos** **(** :ref:`float<class_float>` pos **)**
.. _class_AudioStreamPlayback_set_loop:
- void **set_loop** **(** :ref:`bool<class_bool>` enabled **)**
.. _class_AudioStreamPlayback_stop:
- void **stop** **(** **)**

16
classes/class_backbuffercopy.rst
View File

@@ -19,13 +19,13 @@ Member Functions
----------------
+----------------------------+--------------------------------------------------------------------------------------------------------+
| void | :ref:`set_rect<class_BackBufferCopy_set_rect>` **(** :ref:`Rect2<class_rect2>` rect **)** |
| :ref:`int<class_int>` | :ref:`get_copy_mode<class_BackBufferCopy_get_copy_mode>` **(** **)** const |
+----------------------------+--------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>` | :ref:`get_rect<class_BackBufferCopy_get_rect>` **(** **)** const |
+----------------------------+--------------------------------------------------------------------------------------------------------+
| void | :ref:`set_copy_mode<class_BackBufferCopy_set_copy_mode>` **(** :ref:`int<class_int>` copy_mode **)** |
+----------------------------+--------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_copy_mode<class_BackBufferCopy_get_copy_mode>` **(** **)** const |
| void | :ref:`set_rect<class_BackBufferCopy_set_rect>` **(** :ref:`Rect2<class_rect2>` rect **)** |
+----------------------------+--------------------------------------------------------------------------------------------------------+
Numeric Constants
@@ -43,11 +43,11 @@ Node for back-buffering the currently displayed screen. The region defined in th
Member Function Description
---------------------------
.. _class_BackBufferCopy_set_rect:
.. _class_BackBufferCopy_get_copy_mode:
- void **set_rect** **(** :ref:`Rect2<class_rect2>` rect **)**
- :ref:`int<class_int>` **get_copy_mode** **(** **)** const
Defines the area covered by the BackBufferCopy.
Return the copy mode currently applied to the BackBufferCopy (refer to constants section).
.. _class_BackBufferCopy_get_rect:
@@ -61,10 +61,10 @@ Return the area covered by the BackBufferCopy.
Set the copy mode of the BackBufferCopy (refer to constants section).
.. _class_BackBufferCopy_get_copy_mode:
.. _class_BackBufferCopy_set_rect:
- :ref:`int<class_int>` **get_copy_mode** **(** **)** const
- void **set_rect** **(** :ref:`Rect2<class_rect2>` rect **)**
Return the copy mode currently applied to the BackBufferCopy (refer to constants section).
Defines the area covered by the BackBufferCopy.

432
classes/class_bakedlight.rst
View File

@@ -18,278 +18,278 @@ Brief Description
Member Functions
----------------
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_mode<class_BakedLight_set_mode>` **(** :ref:`int<class_int>` mode **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_mode<class_BakedLight_get_mode>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_octree<class_BakedLight_set_octree>` **(** :ref:`RawArray<class_rawarray>` octree **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RawArray<class_rawarray>` | :ref:`get_octree<class_BakedLight_get_octree>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_light<class_BakedLight_set_light>` **(** :ref:`RawArray<class_rawarray>` light **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RawArray<class_rawarray>` | :ref:`get_light<class_BakedLight_get_light>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_sampler_octree<class_BakedLight_set_sampler_octree>` **(** :ref:`IntArray<class_intarray>` sampler_octree **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`IntArray<class_intarray>` | :ref:`get_sampler_octree<class_BakedLight_get_sampler_octree>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_lightmap<class_BakedLight_add_lightmap>` **(** :ref:`Texture<class_texture>` texture, :ref:`Vector2<class_vector2>` gen_size **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`erase_lightmap<class_BakedLight_erase_lightmap>` **(** :ref:`int<class_int>` id **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_lightmaps<class_BakedLight_clear_lightmaps>` **(** **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_cell_subdivision<class_BakedLight_set_cell_subdivision>` **(** :ref:`int<class_int>` cell_subdivision **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_cell_subdivision<class_BakedLight_get_cell_subdivision>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_initial_lattice_subdiv<class_BakedLight_set_initial_lattice_subdiv>` **(** :ref:`int<class_int>` cell_subdivision **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_initial_lattice_subdiv<class_BakedLight_get_initial_lattice_subdiv>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_plot_size<class_BakedLight_set_plot_size>` **(** :ref:`float<class_float>` plot_size **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_plot_size<class_BakedLight_get_plot_size>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bounces<class_BakedLight_set_bounces>` **(** :ref:`int<class_int>` bounces **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_bounces<class_BakedLight_get_bounces>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_cell_extra_margin<class_BakedLight_set_cell_extra_margin>` **(** :ref:`float<class_float>` cell_extra_margin **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_cell_extra_margin<class_BakedLight_get_cell_extra_margin>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_edge_damp<class_BakedLight_set_edge_damp>` **(** :ref:`float<class_float>` edge_damp **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_edge_damp<class_BakedLight_get_edge_damp>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_normal_damp<class_BakedLight_set_normal_damp>` **(** :ref:`float<class_float>` normal_damp **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_normal_damp<class_BakedLight_get_normal_damp>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tint<class_BakedLight_set_tint>` **(** :ref:`float<class_float>` tint **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_tint<class_BakedLight_get_tint>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_saturation<class_BakedLight_set_saturation>` **(** :ref:`float<class_float>` saturation **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_saturation<class_BakedLight_get_saturation>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_ao_radius<class_BakedLight_set_ao_radius>` **(** :ref:`float<class_float>` ao_radius **)** |
| void | :ref:`erase_lightmap<class_BakedLight_erase_lightmap>` **(** :ref:`int<class_int>` id **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_ao_radius<class_BakedLight_get_ao_radius>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_ao_strength<class_BakedLight_set_ao_strength>` **(** :ref:`float<class_float>` ao_strength **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_ao_strength<class_BakedLight_get_ao_strength>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_format<class_BakedLight_set_format>` **(** :ref:`int<class_int>` format **)** |
| :ref:`bool<class_bool>` | :ref:`get_bake_flag<class_BakedLight_get_bake_flag>` **(** :ref:`int<class_int>` flag **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_format<class_BakedLight_get_format>` **(** **)** const |
| :ref:`int<class_int>` | :ref:`get_bounces<class_BakedLight_get_bounces>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_transfer_lightmaps_only_to_uv2<class_BakedLight_set_transfer_lightmaps_only_to_uv2>` **(** :ref:`bool<class_bool>` enable **)** |
| :ref:`float<class_float>` | :ref:`get_cell_extra_margin<class_BakedLight_get_cell_extra_margin>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_transfer_lightmaps_only_to_uv2<class_BakedLight_get_transfer_lightmaps_only_to_uv2>` **(** **)** const |
| :ref:`int<class_int>` | :ref:`get_cell_subdivision<class_BakedLight_get_cell_subdivision>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_energy_multiplier<class_BakedLight_set_energy_multiplier>` **(** :ref:`float<class_float>` energy_multiplier **)** |
| :ref:`float<class_float>` | :ref:`get_edge_damp<class_BakedLight_get_edge_damp>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_energy_multiplier<class_BakedLight_get_energy_multiplier>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_gamma_adjust<class_BakedLight_set_gamma_adjust>` **(** :ref:`float<class_float>` gamma_adjust **)** |
| :ref:`int<class_int>` | :ref:`get_format<class_BakedLight_get_format>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_gamma_adjust<class_BakedLight_get_gamma_adjust>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_initial_lattice_subdiv<class_BakedLight_get_initial_lattice_subdiv>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RawArray<class_rawarray>` | :ref:`get_light<class_BakedLight_get_light>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_mode<class_BakedLight_get_mode>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_normal_damp<class_BakedLight_get_normal_damp>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RawArray<class_rawarray>` | :ref:`get_octree<class_BakedLight_get_octree>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_plot_size<class_BakedLight_get_plot_size>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`IntArray<class_intarray>` | :ref:`get_sampler_octree<class_BakedLight_get_sampler_octree>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_saturation<class_BakedLight_get_saturation>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_tint<class_BakedLight_get_tint>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_transfer_lightmaps_only_to_uv2<class_BakedLight_get_transfer_lightmaps_only_to_uv2>` **(** **)** const |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_ao_radius<class_BakedLight_set_ao_radius>` **(** :ref:`float<class_float>` ao_radius **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_ao_strength<class_BakedLight_set_ao_strength>` **(** :ref:`float<class_float>` ao_strength **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bake_flag<class_BakedLight_set_bake_flag>` **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` enabled **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_bake_flag<class_BakedLight_get_bake_flag>` **(** :ref:`int<class_int>` flag **)** const |
| void | :ref:`set_bounces<class_BakedLight_set_bounces>` **(** :ref:`int<class_int>` bounces **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_cell_extra_margin<class_BakedLight_set_cell_extra_margin>` **(** :ref:`float<class_float>` cell_extra_margin **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_cell_subdivision<class_BakedLight_set_cell_subdivision>` **(** :ref:`int<class_int>` cell_subdivision **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_edge_damp<class_BakedLight_set_edge_damp>` **(** :ref:`float<class_float>` edge_damp **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_energy_multiplier<class_BakedLight_set_energy_multiplier>` **(** :ref:`float<class_float>` energy_multiplier **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_format<class_BakedLight_set_format>` **(** :ref:`int<class_int>` format **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_gamma_adjust<class_BakedLight_set_gamma_adjust>` **(** :ref:`float<class_float>` gamma_adjust **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_initial_lattice_subdiv<class_BakedLight_set_initial_lattice_subdiv>` **(** :ref:`int<class_int>` cell_subdivision **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_light<class_BakedLight_set_light>` **(** :ref:`RawArray<class_rawarray>` light **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_mode<class_BakedLight_set_mode>` **(** :ref:`int<class_int>` mode **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_normal_damp<class_BakedLight_set_normal_damp>` **(** :ref:`float<class_float>` normal_damp **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_octree<class_BakedLight_set_octree>` **(** :ref:`RawArray<class_rawarray>` octree **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_plot_size<class_BakedLight_set_plot_size>` **(** :ref:`float<class_float>` plot_size **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_sampler_octree<class_BakedLight_set_sampler_octree>` **(** :ref:`IntArray<class_intarray>` sampler_octree **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_saturation<class_BakedLight_set_saturation>` **(** :ref:`float<class_float>` saturation **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tint<class_BakedLight_set_tint>` **(** :ref:`float<class_float>` tint **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_transfer_lightmaps_only_to_uv2<class_BakedLight_set_transfer_lightmaps_only_to_uv2>` **(** :ref:`bool<class_bool>` enable **)** |
+----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
Numeric Constants
-----------------
- **MODE_OCTREE** = **0**
- **MODE_LIGHTMAPS** = **1**
- **BAKE_DIFFUSE** = **0**
- **BAKE_SPECULAR** = **1**
- **BAKE_TRANSLUCENT** = **2**
- **BAKE_CONSERVE_ENERGY** = **3**
- **BAKE_MAX** = **5**
- **MODE_OCTREE** = **0**
- **MODE_LIGHTMAPS** = **1**
Member Function Description
---------------------------
.. _class_BakedLight_set_mode:
- void **set_mode** **(** :ref:`int<class_int>` mode **)**
.. _class_BakedLight_get_mode:
- :ref:`int<class_int>` **get_mode** **(** **)** const
.. _class_BakedLight_set_octree:
- void **set_octree** **(** :ref:`RawArray<class_rawarray>` octree **)**
.. _class_BakedLight_get_octree:
- :ref:`RawArray<class_rawarray>` **get_octree** **(** **)** const
.. _class_BakedLight_set_light:
- void **set_light** **(** :ref:`RawArray<class_rawarray>` light **)**
.. _class_BakedLight_get_light:
- :ref:`RawArray<class_rawarray>` **get_light** **(** **)** const
.. _class_BakedLight_set_sampler_octree:
- void **set_sampler_octree** **(** :ref:`IntArray<class_intarray>` sampler_octree **)**
.. _class_BakedLight_get_sampler_octree:
- :ref:`IntArray<class_intarray>` **get_sampler_octree** **(** **)** const
.. _class_BakedLight_add_lightmap:
- void **add_lightmap** **(** :ref:`Texture<class_texture>` texture, :ref:`Vector2<class_vector2>` gen_size **)**
.. _class_BakedLight_erase_lightmap:
- void **erase_lightmap** **(** :ref:`int<class_int>` id **)**
.. _class_BakedLight_clear_lightmaps:
- void **clear_lightmaps** **(** **)**
.. _class_BakedLight_set_cell_subdivision:
.. _class_BakedLight_erase_lightmap:
- void **set_cell_subdivision** **(** :ref:`int<class_int>` cell_subdivision **)**
.. _class_BakedLight_get_cell_subdivision:
- :ref:`int<class_int>` **get_cell_subdivision** **(** **)** const
.. _class_BakedLight_set_initial_lattice_subdiv:
- void **set_initial_lattice_subdiv** **(** :ref:`int<class_int>` cell_subdivision **)**
.. _class_BakedLight_get_initial_lattice_subdiv:
- :ref:`int<class_int>` **get_initial_lattice_subdiv** **(** **)** const
.. _class_BakedLight_set_plot_size:
- void **set_plot_size** **(** :ref:`float<class_float>` plot_size **)**
.. _class_BakedLight_get_plot_size:
- :ref:`float<class_float>` **get_plot_size** **(** **)** const
.. _class_BakedLight_set_bounces:
- void **set_bounces** **(** :ref:`int<class_int>` bounces **)**
.. _class_BakedLight_get_bounces:
- :ref:`int<class_int>` **get_bounces** **(** **)** const
.. _class_BakedLight_set_cell_extra_margin:
- void **set_cell_extra_margin** **(** :ref:`float<class_float>` cell_extra_margin **)**
.. _class_BakedLight_get_cell_extra_margin:
- :ref:`float<class_float>` **get_cell_extra_margin** **(** **)** const
.. _class_BakedLight_set_edge_damp:
- void **set_edge_damp** **(** :ref:`float<class_float>` edge_damp **)**
.. _class_BakedLight_get_edge_damp:
- :ref:`float<class_float>` **get_edge_damp** **(** **)** const
.. _class_BakedLight_set_normal_damp:
- void **set_normal_damp** **(** :ref:`float<class_float>` normal_damp **)**
.. _class_BakedLight_get_normal_damp:
- :ref:`float<class_float>` **get_normal_damp** **(** **)** const
.. _class_BakedLight_set_tint:
- void **set_tint** **(** :ref:`float<class_float>` tint **)**
.. _class_BakedLight_get_tint:
- :ref:`float<class_float>` **get_tint** **(** **)** const
.. _class_BakedLight_set_saturation:
- void **set_saturation** **(** :ref:`float<class_float>` saturation **)**
.. _class_BakedLight_get_saturation:
- :ref:`float<class_float>` **get_saturation** **(** **)** const
.. _class_BakedLight_set_ao_radius:
- void **set_ao_radius** **(** :ref:`float<class_float>` ao_radius **)**
- void **erase_lightmap** **(** :ref:`int<class_int>` id **)**
.. _class_BakedLight_get_ao_radius:
- :ref:`float<class_float>` **get_ao_radius** **(** **)** const
.. _class_BakedLight_set_ao_strength:
- void **set_ao_strength** **(** :ref:`float<class_float>` ao_strength **)**
.. _class_BakedLight_get_ao_strength:
- :ref:`float<class_float>` **get_ao_strength** **(** **)** const
.. _class_BakedLight_set_format:
- void **set_format** **(** :ref:`int<class_int>` format **)**
.. _class_BakedLight_get_format:
- :ref:`int<class_int>` **get_format** **(** **)** const
.. _class_BakedLight_set_transfer_lightmaps_only_to_uv2:
- void **set_transfer_lightmaps_only_to_uv2** **(** :ref:`bool<class_bool>` enable **)**
.. _class_BakedLight_get_transfer_lightmaps_only_to_uv2:
- :ref:`bool<class_bool>` **get_transfer_lightmaps_only_to_uv2** **(** **)** const
.. _class_BakedLight_set_energy_multiplier:
- void **set_energy_multiplier** **(** :ref:`float<class_float>` energy_multiplier **)**
.. _class_BakedLight_get_energy_multiplier:
- :ref:`float<class_float>` **get_energy_multiplier** **(** **)** const
.. _class_BakedLight_set_gamma_adjust:
- void **set_gamma_adjust** **(** :ref:`float<class_float>` gamma_adjust **)**
.. _class_BakedLight_get_gamma_adjust:
- :ref:`float<class_float>` **get_gamma_adjust** **(** **)** const
.. _class_BakedLight_set_bake_flag:
- void **set_bake_flag** **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` enabled **)**
.. _class_BakedLight_get_bake_flag:
- :ref:`bool<class_bool>` **get_bake_flag** **(** :ref:`int<class_int>` flag **)** const
.. _class_BakedLight_get_bounces:
- :ref:`int<class_int>` **get_bounces** **(** **)** const
.. _class_BakedLight_get_cell_extra_margin:
- :ref:`float<class_float>` **get_cell_extra_margin** **(** **)** const
.. _class_BakedLight_get_cell_subdivision:
- :ref:`int<class_int>` **get_cell_subdivision** **(** **)** const
.. _class_BakedLight_get_edge_damp:
- :ref:`float<class_float>` **get_edge_damp** **(** **)** const
.. _class_BakedLight_get_energy_multiplier:
- :ref:`float<class_float>` **get_energy_multiplier** **(** **)** const
.. _class_BakedLight_get_format:
- :ref:`int<class_int>` **get_format** **(** **)** const
.. _class_BakedLight_get_gamma_adjust:
- :ref:`float<class_float>` **get_gamma_adjust** **(** **)** const
.. _class_BakedLight_get_initial_lattice_subdiv:
- :ref:`int<class_int>` **get_initial_lattice_subdiv** **(** **)** const
.. _class_BakedLight_get_light:
- :ref:`RawArray<class_rawarray>` **get_light** **(** **)** const
.. _class_BakedLight_get_mode:
- :ref:`int<class_int>` **get_mode** **(** **)** const
.. _class_BakedLight_get_normal_damp:
- :ref:`float<class_float>` **get_normal_damp** **(** **)** const
.. _class_BakedLight_get_octree:
- :ref:`RawArray<class_rawarray>` **get_octree** **(** **)** const
.. _class_BakedLight_get_plot_size:
- :ref:`float<class_float>` **get_plot_size** **(** **)** const
.. _class_BakedLight_get_sampler_octree:
- :ref:`IntArray<class_intarray>` **get_sampler_octree** **(** **)** const
.. _class_BakedLight_get_saturation:
- :ref:`float<class_float>` **get_saturation** **(** **)** const
.. _class_BakedLight_get_tint:
- :ref:`float<class_float>` **get_tint** **(** **)** const
.. _class_BakedLight_get_transfer_lightmaps_only_to_uv2:
- :ref:`bool<class_bool>` **get_transfer_lightmaps_only_to_uv2** **(** **)** const
.. _class_BakedLight_set_ao_radius:
- void **set_ao_radius** **(** :ref:`float<class_float>` ao_radius **)**
.. _class_BakedLight_set_ao_strength:
- void **set_ao_strength** **(** :ref:`float<class_float>` ao_strength **)**
.. _class_BakedLight_set_bake_flag:
- void **set_bake_flag** **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` enabled **)**
.. _class_BakedLight_set_bounces:
- void **set_bounces** **(** :ref:`int<class_int>` bounces **)**
.. _class_BakedLight_set_cell_extra_margin:
- void **set_cell_extra_margin** **(** :ref:`float<class_float>` cell_extra_margin **)**
.. _class_BakedLight_set_cell_subdivision:
- void **set_cell_subdivision** **(** :ref:`int<class_int>` cell_subdivision **)**
.. _class_BakedLight_set_edge_damp:
- void **set_edge_damp** **(** :ref:`float<class_float>` edge_damp **)**
.. _class_BakedLight_set_energy_multiplier:
- void **set_energy_multiplier** **(** :ref:`float<class_float>` energy_multiplier **)**
.. _class_BakedLight_set_format:
- void **set_format** **(** :ref:`int<class_int>` format **)**
.. _class_BakedLight_set_gamma_adjust:
- void **set_gamma_adjust** **(** :ref:`float<class_float>` gamma_adjust **)**
.. _class_BakedLight_set_initial_lattice_subdiv:
- void **set_initial_lattice_subdiv** **(** :ref:`int<class_int>` cell_subdivision **)**
.. _class_BakedLight_set_light:
- void **set_light** **(** :ref:`RawArray<class_rawarray>` light **)**
.. _class_BakedLight_set_mode:
- void **set_mode** **(** :ref:`int<class_int>` mode **)**
.. _class_BakedLight_set_normal_damp:
- void **set_normal_damp** **(** :ref:`float<class_float>` normal_damp **)**
.. _class_BakedLight_set_octree:
- void **set_octree** **(** :ref:`RawArray<class_rawarray>` octree **)**
.. _class_BakedLight_set_plot_size:
- void **set_plot_size** **(** :ref:`float<class_float>` plot_size **)**
.. _class_BakedLight_set_sampler_octree:
- void **set_sampler_octree** **(** :ref:`IntArray<class_intarray>` sampler_octree **)**
.. _class_BakedLight_set_saturation:
- void **set_saturation** **(** :ref:`float<class_float>` saturation **)**
.. _class_BakedLight_set_tint:
- void **set_tint** **(** :ref:`float<class_float>` tint **)**
.. _class_BakedLight_set_transfer_lightmaps_only_to_uv2:
- void **set_transfer_lightmaps_only_to_uv2** **(** :ref:`bool<class_bool>` enable **)**

12
classes/class_bakedlightinstance.rst
View File

@@ -18,13 +18,13 @@ Brief Description
Member Functions
----------------
+------------------------------+------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_baked_light<class_BakedLightInstance_set_baked_light>` **(** :ref:`Object<class_object>` baked_light **)** |
+------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>` | :ref:`get_baked_light<class_BakedLightInstance_get_baked_light>` **(** **)** const |
+------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`get_baked_light_instance<class_BakedLightInstance_get_baked_light_instance>` **(** **)** const |
+------------------------------+------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_baked_light<class_BakedLightInstance_set_baked_light>` **(** :ref:`Object<class_object>` baked_light **)** |
+------------------------------+------------------------------------------------------------------------------------------------------------------------+
Signals
-------
@@ -34,10 +34,6 @@ Signals
Member Function Description
---------------------------
.. _class_BakedLightInstance_set_baked_light:
- void **set_baked_light** **(** :ref:`Object<class_object>` baked_light **)**
.. _class_BakedLightInstance_get_baked_light:
- :ref:`Object<class_object>` **get_baked_light** **(** **)** const
@@ -46,4 +42,8 @@ Member Function Description
- :ref:`RID<class_rid>` **get_baked_light_instance** **(** **)** const
.. _class_BakedLightInstance_set_baked_light:
- void **set_baked_light** **(** :ref:`Object<class_object>` baked_light **)**

24
classes/class_bakedlightsampler.rst
View File

@@ -18,15 +18,15 @@ Brief Description
Member Functions
----------------
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_param<class_BakedLightSampler_set_param>` **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)** |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_param<class_BakedLightSampler_get_param>` **(** :ref:`int<class_int>` param **)** const |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_resolution<class_BakedLightSampler_set_resolution>` **(** :ref:`int<class_int>` resolution **)** |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_resolution<class_BakedLightSampler_get_resolution>` **(** **)** const |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_param<class_BakedLightSampler_set_param>` **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)** |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_resolution<class_BakedLightSampler_set_resolution>` **(** :ref:`int<class_int>` resolution **)** |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------------+
Numeric Constants
-----------------
@@ -40,20 +40,20 @@ Numeric Constants
Member Function Description
---------------------------
.. _class_BakedLightSampler_set_param:
- void **set_param** **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)**
.. _class_BakedLightSampler_get_param:
- :ref:`float<class_float>` **get_param** **(** :ref:`int<class_int>` param **)** const
.. _class_BakedLightSampler_set_resolution:
- void **set_resolution** **(** :ref:`int<class_int>` resolution **)**
.. _class_BakedLightSampler_get_resolution:
- :ref:`int<class_int>` **get_resolution** **(** **)** const
.. _class_BakedLightSampler_set_param:
- void **set_param** **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)**
.. _class_BakedLightSampler_set_resolution:
- void **set_resolution** **(** :ref:`int<class_int>` resolution **)**

130
classes/class_basebutton.rst
View File

@@ -25,33 +25,33 @@ Member Functions
+--------------------------+-------------------------------------------------------------------------------------------------------------+
| void | :ref:`_toggled<class_BaseButton__toggled>` **(** :ref:`bool<class_bool>` pressed **)** virtual |
+--------------------------+-------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_pressed<class_BaseButton_set_pressed>` **(** :ref:`bool<class_bool>` pressed **)** |
+--------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_pressed<class_BaseButton_is_pressed>` **(** **)** const |
+--------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_hovered<class_BaseButton_is_hovered>` **(** **)** const |
+--------------------------+-------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_toggle_mode<class_BaseButton_set_toggle_mode>` **(** :ref:`bool<class_bool>` enabled **)** |
+--------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_toggle_mode<class_BaseButton_is_toggle_mode>` **(** **)** const |
+--------------------------+-------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_disabled<class_BaseButton_set_disabled>` **(** :ref:`bool<class_bool>` disabled **)** |
+--------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_disabled<class_BaseButton_is_disabled>` **(** **)** const |
+--------------------------+-------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_click_on_press<class_BaseButton_set_click_on_press>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_click_on_press<class_BaseButton_get_click_on_press>` **(** **)** const |
+--------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_draw_mode<class_BaseButton_get_draw_mode>` **(** **)** const |
+--------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_disabled<class_BaseButton_is_disabled>` **(** **)** const |
+--------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_hovered<class_BaseButton_is_hovered>` **(** **)** const |
+--------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_pressed<class_BaseButton_is_pressed>` **(** **)** const |
+--------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_toggle_mode<class_BaseButton_is_toggle_mode>` **(** **)** const |
+--------------------------+-------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_click_on_press<class_BaseButton_set_click_on_press>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------+-------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_disabled<class_BaseButton_set_disabled>` **(** :ref:`bool<class_bool>` disabled **)** |
+--------------------------+-------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_pressed<class_BaseButton_set_pressed>` **(** :ref:`bool<class_bool>` pressed **)** |
+--------------------------+-------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_toggle_mode<class_BaseButton_set_toggle_mode>` **(** :ref:`bool<class_bool>` enabled **)** |
+--------------------------+-------------------------------------------------------------------------------------------------------------+
Signals
-------
- **pressed** **(** **)**
- **released** **(** **)**
- **toggled** **(** :ref:`bool<class_bool>` pressed **)**
- **pressed** **(** **)**
Numeric Constants
-----------------
@@ -81,54 +81,6 @@ Called when button is pressed.
Called when button is toggled (only if toggle_mode is active).
.. _class_BaseButton_set_pressed:
- void **set_pressed** **(** :ref:`bool<class_bool>` pressed **)**
Set the button to pressed state (only if toggle_mode is active).
.. _class_BaseButton_is_pressed:
- :ref:`bool<class_bool>` **is_pressed** **(** **)** const
If toggle_mode is active, return whether the button is toggled. If toggle_mode is not active, return whether the button is pressed down.
.. _class_BaseButton_is_hovered:
- :ref:`bool<class_bool>` **is_hovered** **(** **)** const
Return true if mouse entered the button before it exit.
.. _class_BaseButton_set_toggle_mode:
- void **set_toggle_mode** **(** :ref:`bool<class_bool>` enabled **)**
Set the button toggle_mode property. Toggle mode makes the button flip state between pressed and unpressed each time its area is clicked.
.. _class_BaseButton_is_toggle_mode:
- :ref:`bool<class_bool>` **is_toggle_mode** **(** **)** const
Return the toggle_mode property (see :ref:`set_toggle_mode<class_BaseButton_set_toggle_mode>`).
.. _class_BaseButton_set_disabled:
- void **set_disabled** **(** :ref:`bool<class_bool>` disabled **)**
Set the button into disabled state. When a button is disabled, it can't be clicked or toggled.
.. _class_BaseButton_is_disabled:
- :ref:`bool<class_bool>` **is_disabled** **(** **)** const
Return whether the button is in disabled state (see :ref:`set_disabled<class_BaseButton_set_disabled>`).
.. _class_BaseButton_set_click_on_press:
- void **set_click_on_press** **(** :ref:`bool<class_bool>` enable **)**
Set the button click_on_press mode. This mode generates click events when a mouse button or key is just pressed (by default events are generated when the button/keys are released and both press and release occur in the visual area of the Button).
.. _class_BaseButton_get_click_on_press:
- :ref:`bool<class_bool>` **get_click_on_press** **(** **)** const
@@ -141,4 +93,52 @@ Return the state of the click_on_press property (see :ref:`set_click_on_press<cl
Return the visual state used to draw the button. This is useful mainly when implementing your own draw code by either overriding _draw() or connecting to "draw" signal. The visual state of the button is defined by the DRAW\_\* enum.
.. _class_BaseButton_is_disabled:
- :ref:`bool<class_bool>` **is_disabled** **(** **)** const
Return whether the button is in disabled state (see :ref:`set_disabled<class_BaseButton_set_disabled>`).
.. _class_BaseButton_is_hovered:
- :ref:`bool<class_bool>` **is_hovered** **(** **)** const
Return true if mouse entered the button before it exit.
.. _class_BaseButton_is_pressed:
- :ref:`bool<class_bool>` **is_pressed** **(** **)** const
If toggle_mode is active, return whether the button is toggled. If toggle_mode is not active, return whether the button is pressed down.
.. _class_BaseButton_is_toggle_mode:
- :ref:`bool<class_bool>` **is_toggle_mode** **(** **)** const
Return the toggle_mode property (see :ref:`set_toggle_mode<class_BaseButton_set_toggle_mode>`).
.. _class_BaseButton_set_click_on_press:
- void **set_click_on_press** **(** :ref:`bool<class_bool>` enable **)**
Set the button click_on_press mode. This mode generates click events when a mouse button or key is just pressed (by default events are generated when the button/keys are released and both press and release occur in the visual area of the Button).
.. _class_BaseButton_set_disabled:
- void **set_disabled** **(** :ref:`bool<class_bool>` disabled **)**
Set the button into disabled state. When a button is disabled, it can't be clicked or toggled.
.. _class_BaseButton_set_pressed:
- void **set_pressed** **(** :ref:`bool<class_bool>` pressed **)**
Set the button to pressed state (only if toggle_mode is active).
.. _class_BaseButton_set_toggle_mode:
- void **set_toggle_mode** **(** :ref:`bool<class_bool>` enabled **)**
Set the button toggle_mode property. Toggle mode makes the button flip state between pressed and unpressed each time its area is clicked.

32
classes/class_bitmap.rst
View File

@@ -23,15 +23,15 @@ Member Functions
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`create_from_image_alpha<class_BitMap_create_from_image_alpha>` **(** :ref:`Image<class_image>` image **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bit<class_BitMap_set_bit>` **(** :ref:`Vector2<class_vector2>` pos, :ref:`bool<class_bool>` bit **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_bit<class_BitMap_get_bit>` **(** :ref:`Vector2<class_vector2>` pos **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bit_rect<class_BitMap_set_bit_rect>` **(** :ref:`Rect2<class_rect2>` p_rect, :ref:`bool<class_bool>` bit **)** |
| :ref:`Vector2<class_vector2>` | :ref:`get_size<class_BitMap_get_size>` **(** **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_true_bit_count<class_BitMap_get_true_bit_count>` **(** **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_size<class_BitMap_get_size>` **(** **)** const |
| void | :ref:`set_bit<class_BitMap_set_bit>` **(** :ref:`Vector2<class_vector2>` pos, :ref:`bool<class_bool>` bit **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bit_rect<class_BitMap_set_bit_rect>` **(** :ref:`Rect2<class_rect2>` p_rect, :ref:`bool<class_bool>` bit **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------+
Member Function Description
@@ -45,24 +45,24 @@ Member Function Description
- void **create_from_image_alpha** **(** :ref:`Image<class_image>` image **)**
.. _class_BitMap_set_bit:
- void **set_bit** **(** :ref:`Vector2<class_vector2>` pos, :ref:`bool<class_bool>` bit **)**
.. _class_BitMap_get_bit:
- :ref:`bool<class_bool>` **get_bit** **(** :ref:`Vector2<class_vector2>` pos **)** const
.. _class_BitMap_set_bit_rect:
- void **set_bit_rect** **(** :ref:`Rect2<class_rect2>` p_rect, :ref:`bool<class_bool>` bit **)**
.. _class_BitMap_get_true_bit_count:
- :ref:`int<class_int>` **get_true_bit_count** **(** **)** const
.. _class_BitMap_get_size:
- :ref:`Vector2<class_vector2>` **get_size** **(** **)** const
.. _class_BitMap_get_true_bit_count:
- :ref:`int<class_int>` **get_true_bit_count** **(** **)** const
.. _class_BitMap_set_bit:
- void **set_bit** **(** :ref:`Vector2<class_vector2>` pos, :ref:`bool<class_bool>` bit **)**
.. _class_BitMap_set_bit_rect:
- void **set_bit_rect** **(** :ref:`Rect2<class_rect2>` p_rect, :ref:`bool<class_bool>` bit **)**

5
classes/class_boneattachment.rst
View File

@@ -13,5 +13,10 @@ BoneAttachment
Brief Description
-----------------
A node that will attach to a bone.
Description
-----------
This node must be the child of a :ref:`Skeleton<class_skeleton>` node. You can then select a bone for this node to attach to. The BoneAttachment node will copy the transform of the selected bone.

16
classes/class_boxshape.rst
View File

@@ -18,11 +18,11 @@ Box shape resource.
Member Functions
----------------
+--------------------------------+----------------------------------------------------------------------------------------------------+
| void | :ref:`set_extents<class_BoxShape_set_extents>` **(** :ref:`Vector3<class_vector3>` extents **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_extents<class_BoxShape_get_extents>` **(** **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------+
| void | :ref:`set_extents<class_BoxShape_set_extents>` **(** :ref:`Vector3<class_vector3>` extents **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------+
Description
-----------
@@ -32,16 +32,16 @@ Box shape resource, which can be set into a :ref:`PhysicsBody<class_physicsbody>
Member Function Description
---------------------------
.. _class_BoxShape_set_extents:
- void **set_extents** **(** :ref:`Vector3<class_vector3>` extents **)**
Set the half extents for the shape.
.. _class_BoxShape_get_extents:
- :ref:`Vector3<class_vector3>` **get_extents** **(** **)** const
Return the half extents of the shape.
.. _class_BoxShape_set_extents:
- void **set_extents** **(** :ref:`Vector3<class_vector3>` extents **)**
Set the half extents for the shape.

88
classes/class_button.rst
View File

@@ -20,27 +20,27 @@ Standard themed Button.
Member Functions
----------------
+--------------------------------+----------------------------------------------------------------------------------------------------------+
| void | :ref:`set_text<class_Button_set_text>` **(** :ref:`String<class_string>` text **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_text<class_Button_get_text>` **(** **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------+
| void | :ref:`set_button_icon<class_Button_set_button_icon>` **(** :ref:`Texture<class_texture>` texture **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>` | :ref:`get_button_icon<class_Button_get_button_icon>` **(** **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------+
| void | :ref:`set_flat<class_Button_set_flat>` **(** :ref:`bool<class_bool>` enabled **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------+
| void | :ref:`set_clip_text<class_Button_set_clip_text>` **(** :ref:`bool<class_bool>` enabled **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_clip_text<class_Button_get_clip_text>` **(** **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------+
| void | :ref:`set_text_align<class_Button_set_text_align>` **(** :ref:`int<class_int>` align **)** |
| :ref:`String<class_string>` | :ref:`get_text<class_Button_get_text>` **(** **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_text_align<class_Button_get_text_align>` **(** **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_flat<class_Button_is_flat>` **(** **)** const |
+--------------------------------+----------------------------------------------------------------------------------------------------------+
| void | :ref:`set_button_icon<class_Button_set_button_icon>` **(** :ref:`Texture<class_texture>` texture **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------+
| void | :ref:`set_clip_text<class_Button_set_clip_text>` **(** :ref:`bool<class_bool>` enabled **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------+
| void | :ref:`set_flat<class_Button_set_flat>` **(** :ref:`bool<class_bool>` enabled **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------+
| void | :ref:`set_text<class_Button_set_text>` **(** :ref:`String<class_string>` text **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------+
| void | :ref:`set_text_align<class_Button_set_text_align>` **(** :ref:`int<class_int>` align **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------+
Numeric Constants
-----------------
@@ -57,53 +57,23 @@ Button is the standard themed button. It can contain text and an icon, and will
Member Function Description
---------------------------
.. _class_Button_set_text:
- void **set_text** **(** :ref:`String<class_string>` text **)**
Set the button text, which will be displayed inside the button area.
.. _class_Button_get_text:
- :ref:`String<class_string>` **get_text** **(** **)** const
Return the button text.
.. _class_Button_set_button_icon:
- void **set_button_icon** **(** :ref:`Texture<class_texture>` texture **)**
Set the icon that will be displayed next to the text inside the button area.
.. _class_Button_get_button_icon:
- :ref:`Texture<class_texture>` **get_button_icon** **(** **)** const
Return the button icon.
.. _class_Button_set_flat:
- void **set_flat** **(** :ref:`bool<class_bool>` enabled **)**
Set the *flat* property of a Button. Flat buttons don't display decoration unless hovered or pressed.
.. _class_Button_set_clip_text:
- void **set_clip_text** **(** :ref:`bool<class_bool>` enabled **)**
Set the *clip_text* property of a Button. When this property is enabled, text that is too large to fit the button is clipped, when disabled (default) the Button will always be wide enough to hold the text.
.. _class_Button_get_clip_text:
- :ref:`bool<class_bool>` **get_clip_text** **(** **)** const
Return the state of the *clip_text* property (see :ref:`set_clip_text<class_Button_set_clip_text>`)
.. _class_Button_set_text_align:
.. _class_Button_get_text:
- void **set_text_align** **(** :ref:`int<class_int>` align **)**
- :ref:`String<class_string>` **get_text** **(** **)** const
Set the text alignment policy, using one of the ALIGN\_\* constants.
Return the button text.
.. _class_Button_get_text_align:
@@ -117,4 +87,34 @@ Return the text alignment policy.
Return the state of the *flat* property (see :ref:`set_flat<class_Button_set_flat>`).
.. _class_Button_set_button_icon:
- void **set_button_icon** **(** :ref:`Texture<class_texture>` texture **)**
Set the icon that will be displayed next to the text inside the button area.
.. _class_Button_set_clip_text:
- void **set_clip_text** **(** :ref:`bool<class_bool>` enabled **)**
Set the *clip_text* property of a Button. When this property is enabled, text that is too large to fit the button is clipped, when disabled (default) the Button will always be wide enough to hold the text.
.. _class_Button_set_flat:
- void **set_flat** **(** :ref:`bool<class_bool>` enabled **)**
Set the *flat* property of a Button. Flat buttons don't display decoration unless hovered or pressed.
.. _class_Button_set_text:
- void **set_text** **(** :ref:`String<class_string>` text **)**
Set the button text, which will be displayed inside the button area.
.. _class_Button_set_text_align:
- void **set_text_align** **(** :ref:`int<class_int>` align **)**
Set the text alignment policy, using one of the ALIGN\_\* constants.

128
classes/class_buttonarray.rst
View File

@@ -25,25 +25,25 @@ Member Functions
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_icon_button<class_ButtonArray_add_icon_button>` **(** :ref:`Texture<class_texture>` icon, :ref:`String<class_string>` text="" **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_button_text<class_ButtonArray_set_button_text>` **(** :ref:`int<class_int>` button_idx, :ref:`String<class_string>` text **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_button_icon<class_ButtonArray_set_button_icon>` **(** :ref:`int<class_int>` button_idx, :ref:`Texture<class_texture>` icon **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_button_text<class_ButtonArray_get_button_text>` **(** :ref:`int<class_int>` button_idx **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>` | :ref:`get_button_icon<class_ButtonArray_get_button_icon>` **(** :ref:`int<class_int>` button_idx **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_button_count<class_ButtonArray_get_button_count>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_selected<class_ButtonArray_get_selected>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_hovered<class_ButtonArray_get_hovered>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_selected<class_ButtonArray_set_selected>` **(** :ref:`int<class_int>` button_idx **)** |
| void | :ref:`clear<class_ButtonArray_clear>` **(** **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`erase_button<class_ButtonArray_erase_button>` **(** :ref:`int<class_int>` button_idx **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_ButtonArray_clear>` **(** **)** |
| :ref:`int<class_int>` | :ref:`get_button_count<class_ButtonArray_get_button_count>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>` | :ref:`get_button_icon<class_ButtonArray_get_button_icon>` **(** :ref:`int<class_int>` button_idx **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_button_text<class_ButtonArray_get_button_text>` **(** :ref:`int<class_int>` button_idx **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_hovered<class_ButtonArray_get_hovered>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_selected<class_ButtonArray_get_selected>` **(** **)** const |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_button_icon<class_ButtonArray_set_button_icon>` **(** :ref:`int<class_int>` button_idx, :ref:`Texture<class_texture>` icon **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_button_text<class_ButtonArray_set_button_text>` **(** :ref:`int<class_int>` button_idx, :ref:`String<class_string>` text **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_selected<class_ButtonArray_set_selected>` **(** :ref:`int<class_int>` button_idx **)** |
+--------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
@@ -82,53 +82,11 @@ Append a new button to the array, with the specified text.
Append a new button to the array, with the specified icon and text.
.. _class_ButtonArray_set_button_text:
.. _class_ButtonArray_clear:
- void **set_button_text** **(** :ref:`int<class_int>` button_idx, :ref:`String<class_string>` text **)**
- void **clear** **(** **)**
Define the text of the specified button.
.. _class_ButtonArray_set_button_icon:
- void **set_button_icon** **(** :ref:`int<class_int>` button_idx, :ref:`Texture<class_texture>` icon **)**
Set the icon of the specified button.
.. _class_ButtonArray_get_button_text:
- :ref:`String<class_string>` **get_button_text** **(** :ref:`int<class_int>` button_idx **)** const
Return the text of the specified button.
.. _class_ButtonArray_get_button_icon:
- :ref:`Texture<class_texture>` **get_button_icon** **(** :ref:`int<class_int>` button_idx **)** const
Return the icon of the specified button.
.. _class_ButtonArray_get_button_count:
- :ref:`int<class_int>` **get_button_count** **(** **)** const
Return the amount of buttons in the array.
.. _class_ButtonArray_get_selected:
- :ref:`int<class_int>` **get_selected** **(** **)** const
Return the index of the currently selected button in the array.
.. _class_ButtonArray_get_hovered:
- :ref:`int<class_int>` **get_hovered** **(** **)** const
Return the index of the currently hovered button in the array.
.. _class_ButtonArray_set_selected:
- void **set_selected** **(** :ref:`int<class_int>` button_idx **)**
Select a button in the array based on the given index.
Remove all buttons from the array.
.. _class_ButtonArray_erase_button:
@@ -136,10 +94,52 @@ Select a button in the array based on the given index.
Remove the specified button in the array.
.. _class_ButtonArray_clear:
.. _class_ButtonArray_get_button_count:
- void **clear** **(** **)**
- :ref:`int<class_int>` **get_button_count** **(** **)** const
Remove all buttons from the array.
Return the amount of buttons in the array.
.. _class_ButtonArray_get_button_icon:
- :ref:`Texture<class_texture>` **get_button_icon** **(** :ref:`int<class_int>` button_idx **)** const
Return the icon of the specified button.
.. _class_ButtonArray_get_button_text:
- :ref:`String<class_string>` **get_button_text** **(** :ref:`int<class_int>` button_idx **)** const
Return the text of the specified button.
.. _class_ButtonArray_get_hovered:
- :ref:`int<class_int>` **get_hovered** **(** **)** const
Return the index of the currently hovered button in the array.
.. _class_ButtonArray_get_selected:
- :ref:`int<class_int>` **get_selected** **(** **)** const
Return the index of the currently selected button in the array.
.. _class_ButtonArray_set_button_icon:
- void **set_button_icon** **(** :ref:`int<class_int>` button_idx, :ref:`Texture<class_texture>` icon **)**
Set the icon of the specified button.
.. _class_ButtonArray_set_button_text:
- void **set_button_text** **(** :ref:`int<class_int>` button_idx, :ref:`String<class_string>` text **)**
Define the text of the specified button.
.. _class_ButtonArray_set_selected:
- void **set_selected** **(** :ref:`int<class_int>` button_idx **)**
Select a button in the array based on the given index.

32
classes/class_buttongroup.rst
View File

@@ -19,13 +19,13 @@ Member Functions
----------------
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :ref:`BaseButton<class_basebutton>` | :ref:`get_pressed_button<class_ButtonGroup_get_pressed_button>` **(** **)** const |
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_pressed_button_index<class_ButtonGroup_get_pressed_button_index>` **(** **)** const |
| :ref:`Array<class_array>` | :ref:`get_button_list<class_ButtonGroup_get_button_list>` **(** **)** const |
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :ref:`BaseButton<class_basebutton>` | :ref:`get_focused_button<class_ButtonGroup_get_focused_button>` **(** **)** const |
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_button_list<class_ButtonGroup_get_button_list>` **(** **)** const |
| :ref:`BaseButton<class_basebutton>` | :ref:`get_pressed_button<class_ButtonGroup_get_pressed_button>` **(** **)** const |
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_pressed_button_index<class_ButtonGroup_get_pressed_button_index>` **(** **)** const |
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_pressed_button<class_ButtonGroup_set_pressed_button>` **(** :ref:`BaseButton<class_basebutton>` button **)** |
+--------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
@@ -38,6 +38,18 @@ Group of :ref:`Button<class_button>`. All direct and indirect children buttons b
Member Function Description
---------------------------
.. _class_ButtonGroup_get_button_list:
- :ref:`Array<class_array>` **get_button_list** **(** **)** const
Return the list of all the buttons in the group.
.. _class_ButtonGroup_get_focused_button:
- :ref:`BaseButton<class_basebutton>` **get_focused_button** **(** **)** const
Return the focused button.
.. _class_ButtonGroup_get_pressed_button:
- :ref:`BaseButton<class_basebutton>` **get_pressed_button** **(** **)** const
@@ -50,18 +62,6 @@ Return the pressed button.
Return the index of the pressed button (by tree order).
.. _class_ButtonGroup_get_focused_button:
- :ref:`BaseButton<class_basebutton>` **get_focused_button** **(** **)** const
Return the focused button.
.. _class_ButtonGroup_get_button_list:
- :ref:`Array<class_array>` **get_button_list** **(** **)** const
Return the list of all the buttons in the group.
.. _class_ButtonGroup_set_pressed_button:
- void **set_pressed_button** **(** :ref:`BaseButton<class_basebutton>` button **)**

188
classes/class_camera.rst
View File

@@ -20,61 +20,61 @@ Camera node, displays from a point of view.
Member Functions
----------------
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`project_ray_normal<class_Camera_project_ray_normal>` **(** :ref:`Vector2<class_vector2>` screen_point **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`project_local_ray_normal<class_Camera_project_local_ray_normal>` **(** :ref:`Vector2<class_vector2>` screen_point **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`project_ray_origin<class_Camera_project_ray_origin>` **(** :ref:`Vector2<class_vector2>` screen_point **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`unproject_position<class_Camera_unproject_position>` **(** :ref:`Vector3<class_vector3>` world_point **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_position_behind<class_Camera_is_position_behind>` **(** :ref:`Vector3<class_vector3>` world_point **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`project_position<class_Camera_project_position>` **(** :ref:`Vector2<class_vector2>` screen_point **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_perspective<class_Camera_set_perspective>` **(** :ref:`float<class_float>` fov, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_orthogonal<class_Camera_set_orthogonal>` **(** :ref:`float<class_float>` size, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`make_current<class_Camera_make_current>` **(** **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_current<class_Camera_clear_current>` **(** **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_current<class_Camera_is_current>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform<class_transform>` | :ref:`get_camera_transform<class_Camera_get_camera_transform>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Environment<class_environment>` | :ref:`get_environment<class_Camera_get_environment>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_fov<class_Camera_get_fov>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_keep_aspect_mode<class_Camera_get_keep_aspect_mode>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_projection<class_Camera_get_projection>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_size<class_Camera_get_size>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_visible_layers<class_Camera_get_visible_layers>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_zfar<class_Camera_get_zfar>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_znear<class_Camera_get_znear>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_projection<class_Camera_get_projection>` **(** **)** const |
| :ref:`bool<class_bool>` | :ref:`is_current<class_Camera_is_current>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_visible_layers<class_Camera_set_visible_layers>` **(** :ref:`int<class_int>` mask **)** |
| :ref:`bool<class_bool>` | :ref:`is_position_behind<class_Camera_is_position_behind>` **(** :ref:`Vector3<class_vector3>` world_point **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_visible_layers<class_Camera_get_visible_layers>` **(** **)** const |
| void | :ref:`make_current<class_Camera_make_current>` **(** **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`project_local_ray_normal<class_Camera_project_local_ray_normal>` **(** :ref:`Vector2<class_vector2>` screen_point **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`project_position<class_Camera_project_position>` **(** :ref:`Vector2<class_vector2>` screen_point **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`project_ray_normal<class_Camera_project_ray_normal>` **(** :ref:`Vector2<class_vector2>` screen_point **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`project_ray_origin<class_Camera_project_ray_origin>` **(** :ref:`Vector2<class_vector2>` screen_point **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_environment<class_Camera_set_environment>` **(** :ref:`Environment<class_environment>` env **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Environment<class_environment>` | :ref:`get_environment<class_Camera_get_environment>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_keep_aspect_mode<class_Camera_set_keep_aspect_mode>` **(** :ref:`int<class_int>` mode **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_keep_aspect_mode<class_Camera_get_keep_aspect_mode>` **(** **)** const |
| void | :ref:`set_orthogonal<class_Camera_set_orthogonal>` **(** :ref:`float<class_float>` size, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_perspective<class_Camera_set_perspective>` **(** :ref:`float<class_float>` fov, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_visible_layers<class_Camera_set_visible_layers>` **(** :ref:`int<class_int>` mask **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`unproject_position<class_Camera_unproject_position>` **(** :ref:`Vector3<class_vector3>` world_point **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Numeric Constants
-----------------
- **PROJECTION_PERSPECTIVE** = **0** --- Perspective Projection (object's size on the screen becomes smaller when far away).
- **PROJECTION_ORTHOGONAL** = **1** --- Orthogonal Projection (objects remain the same size on the screen no matter how far away they are).
- **KEEP_WIDTH** = **0**
- **KEEP_HEIGHT** = **1**
- **PROJECTION_PERSPECTIVE** = **0** --- Perspective Projection (object's size on the screen becomes smaller when far away).
- **PROJECTION_ORTHOGONAL** = **1** --- Orthogonal Projection (objects remain the same size on the screen no matter how far away they are).
Description
-----------
@@ -84,78 +84,40 @@ Camera is a special node that displays what is visible from its current location
Member Function Description
---------------------------
.. _class_Camera_project_ray_normal:
- :ref:`Vector3<class_vector3>` **project_ray_normal** **(** :ref:`Vector2<class_vector2>` screen_point **)** const
Return a normal vector in worldspace, that is the result of projecting a point on the :ref:`Viewport<class_viewport>` rectangle by the camera projection. This is useful for casting rays in the form of (origin,normal) for object intersection or picking.
.. _class_Camera_project_local_ray_normal:
- :ref:`Vector3<class_vector3>` **project_local_ray_normal** **(** :ref:`Vector2<class_vector2>` screen_point **)** const
.. _class_Camera_project_ray_origin:
- :ref:`Vector3<class_vector3>` **project_ray_origin** **(** :ref:`Vector2<class_vector2>` screen_point **)** const
Return a 3D position in worldspace, that is the result of projecting a point on the :ref:`Viewport<class_viewport>` rectangle by the camera projection. This is useful for casting rays in the form of (origin,normal) for object intersection or picking.
.. _class_Camera_unproject_position:
- :ref:`Vector2<class_vector2>` **unproject_position** **(** :ref:`Vector3<class_vector3>` world_point **)** const
Return how a 3D point in worldspace maps to a 2D coordinate in the :ref:`Viewport<class_viewport>` rectangle.
.. _class_Camera_is_position_behind:
- :ref:`bool<class_bool>` **is_position_behind** **(** :ref:`Vector3<class_vector3>` world_point **)** const
.. _class_Camera_project_position:
- :ref:`Vector3<class_vector3>` **project_position** **(** :ref:`Vector2<class_vector2>` screen_point **)** const
.. _class_Camera_set_perspective:
- void **set_perspective** **(** :ref:`float<class_float>` fov, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)**
Set the camera projection to perspective mode, by specifying a *FOV* Y angle in degrees (FOV means Field of View), and the *near* and *far* clip planes in worldspace units.
.. _class_Camera_set_orthogonal:
- void **set_orthogonal** **(** :ref:`float<class_float>` size, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)**
Set the camera projection to orthogonal mode, by specifying a width and the *near* and *far* clip planes in worldspace units. (As a hint, 2D games often use this projection, with values specified in pixels)
.. _class_Camera_make_current:
- void **make_current** **(** **)**
Make this camera the current Camera for the :ref:`Viewport<class_viewport>` (see class description). If the Camera Node is outside the scene tree, it will attempt to become current once it's added.
.. _class_Camera_clear_current:
- void **clear_current** **(** **)**
.. _class_Camera_is_current:
- :ref:`bool<class_bool>` **is_current** **(** **)** const
Return whether the Camera is the current one in the :ref:`Viewport<class_viewport>`, or plans to become current (if outside the scene tree).
.. _class_Camera_get_camera_transform:
- :ref:`Transform<class_transform>` **get_camera_transform** **(** **)** const
Get the camera transform. Subclassed cameras (such as CharacterCamera) may provide different transforms than the :ref:`Node<class_node>` transform.
.. _class_Camera_get_environment:
- :ref:`Environment<class_environment>` **get_environment** **(** **)** const
.. _class_Camera_get_fov:
- :ref:`float<class_float>` **get_fov** **(** **)** const
.. _class_Camera_get_keep_aspect_mode:
- :ref:`int<class_int>` **get_keep_aspect_mode** **(** **)** const
.. _class_Camera_get_projection:
- :ref:`int<class_int>` **get_projection** **(** **)** const
.. _class_Camera_get_size:
- :ref:`float<class_float>` **get_size** **(** **)** const
.. _class_Camera_get_visible_layers:
- :ref:`int<class_int>` **get_visible_layers** **(** **)** const
.. _class_Camera_get_zfar:
- :ref:`float<class_float>` **get_zfar** **(** **)** const
@@ -164,32 +126,70 @@ Get the camera transform. Subclassed cameras (such as CharacterCamera) may provi
- :ref:`float<class_float>` **get_znear** **(** **)** const
.. _class_Camera_get_projection:
.. _class_Camera_is_current:
- :ref:`int<class_int>` **get_projection** **(** **)** const
- :ref:`bool<class_bool>` **is_current** **(** **)** const
.. _class_Camera_set_visible_layers:
Return whether the Camera is the current one in the :ref:`Viewport<class_viewport>`, or plans to become current (if outside the scene tree).
- void **set_visible_layers** **(** :ref:`int<class_int>` mask **)**
.. _class_Camera_is_position_behind:
.. _class_Camera_get_visible_layers:
- :ref:`bool<class_bool>` **is_position_behind** **(** :ref:`Vector3<class_vector3>` world_point **)** const
- :ref:`int<class_int>` **get_visible_layers** **(** **)** const
.. _class_Camera_make_current:
- void **make_current** **(** **)**
Make this camera the current Camera for the :ref:`Viewport<class_viewport>` (see class description). If the Camera Node is outside the scene tree, it will attempt to become current once it's added.
.. _class_Camera_project_local_ray_normal:
- :ref:`Vector3<class_vector3>` **project_local_ray_normal** **(** :ref:`Vector2<class_vector2>` screen_point **)** const
.. _class_Camera_project_position:
- :ref:`Vector3<class_vector3>` **project_position** **(** :ref:`Vector2<class_vector2>` screen_point **)** const
.. _class_Camera_project_ray_normal:
- :ref:`Vector3<class_vector3>` **project_ray_normal** **(** :ref:`Vector2<class_vector2>` screen_point **)** const
Return a normal vector in worldspace, that is the result of projecting a point on the :ref:`Viewport<class_viewport>` rectangle by the camera projection. This is useful for casting rays in the form of (origin,normal) for object intersection or picking.
.. _class_Camera_project_ray_origin:
- :ref:`Vector3<class_vector3>` **project_ray_origin** **(** :ref:`Vector2<class_vector2>` screen_point **)** const
Return a 3D position in worldspace, that is the result of projecting a point on the :ref:`Viewport<class_viewport>` rectangle by the camera projection. This is useful for casting rays in the form of (origin,normal) for object intersection or picking.
.. _class_Camera_set_environment:
- void **set_environment** **(** :ref:`Environment<class_environment>` env **)**
.. _class_Camera_get_environment:
- :ref:`Environment<class_environment>` **get_environment** **(** **)** const
.. _class_Camera_set_keep_aspect_mode:
- void **set_keep_aspect_mode** **(** :ref:`int<class_int>` mode **)**
.. _class_Camera_get_keep_aspect_mode:
.. _class_Camera_set_orthogonal:
- :ref:`int<class_int>` **get_keep_aspect_mode** **(** **)** const
- void **set_orthogonal** **(** :ref:`float<class_float>` size, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)**
Set the camera projection to orthogonal mode, by specifying a width and the *near* and *far* clip planes in worldspace units. (As a hint, 2D games often use this projection, with values specified in pixels)
.. _class_Camera_set_perspective:
- void **set_perspective** **(** :ref:`float<class_float>` fov, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)**
Set the camera projection to perspective mode, by specifying a *FOV* Y angle in degrees (FOV means Field of View), and the *near* and *far* clip planes in worldspace units.
.. _class_Camera_set_visible_layers:
- void **set_visible_layers** **(** :ref:`int<class_int>` mask **)**
.. _class_Camera_unproject_position:
- :ref:`Vector2<class_vector2>` **unproject_position** **(** :ref:`Vector3<class_vector3>` world_point **)** const
Return how a 3D point in worldspace maps to a 2D coordinate in the :ref:`Viewport<class_viewport>` rectangle.

302
classes/class_camera2d.rst
View File

@@ -18,73 +18,73 @@ Camera node for 2D scenes.
Member Functions
----------------
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_offset<class_Camera2D_set_offset>` **(** :ref:`Vector2<class_vector2>` offset **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_offset<class_Camera2D_get_offset>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_anchor_mode<class_Camera2D_set_anchor_mode>` **(** :ref:`int<class_int>` anchor_mode **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_anchor_mode<class_Camera2D_get_anchor_mode>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_rotating<class_Camera2D_set_rotating>` **(** :ref:`bool<class_bool>` rotating **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_rotating<class_Camera2D_is_rotating>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`make_current<class_Camera2D_make_current>` **(** **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_current<class_Camera2D_clear_current>` **(** **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_current<class_Camera2D_is_current>` **(** **)** const |
| void | :ref:`force_update_scroll<class_Camera2D_force_update_scroll>` **(** **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_limit<class_Camera2D_set_limit>` **(** :ref:`int<class_int>` margin, :ref:`int<class_int>` limit **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_limit<class_Camera2D_get_limit>` **(** :ref:`int<class_int>` margin **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_v_drag_enabled<class_Camera2D_set_v_drag_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_v_drag_enabled<class_Camera2D_is_v_drag_enabled>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_h_drag_enabled<class_Camera2D_set_h_drag_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_h_drag_enabled<class_Camera2D_is_h_drag_enabled>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_v_offset<class_Camera2D_set_v_offset>` **(** :ref:`float<class_float>` ofs **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_v_offset<class_Camera2D_get_v_offset>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_h_offset<class_Camera2D_set_h_offset>` **(** :ref:`float<class_float>` ofs **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_h_offset<class_Camera2D_get_h_offset>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_drag_margin<class_Camera2D_set_drag_margin>` **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` drag_margin **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_drag_margin<class_Camera2D_get_drag_margin>` **(** :ref:`int<class_int>` margin **)** const |
| :ref:`int<class_int>` | :ref:`get_anchor_mode<class_Camera2D_get_anchor_mode>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_camera_pos<class_Camera2D_get_camera_pos>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_camera_screen_center<class_Camera2D_get_camera_screen_center>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_zoom<class_Camera2D_set_zoom>` **(** :ref:`Vector2<class_vector2>` zoom **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_zoom<class_Camera2D_get_zoom>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_follow_smoothing<class_Camera2D_set_follow_smoothing>` **(** :ref:`float<class_float>` follow_smoothing **)** |
| :ref:`float<class_float>` | :ref:`get_drag_margin<class_Camera2D_get_drag_margin>` **(** :ref:`int<class_int>` margin **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_follow_smoothing<class_Camera2D_get_follow_smoothing>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_enable_follow_smoothing<class_Camera2D_set_enable_follow_smoothing>` **(** :ref:`bool<class_bool>` follow_smoothing **)** |
| :ref:`float<class_float>` | :ref:`get_h_offset<class_Camera2D_get_h_offset>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_limit<class_Camera2D_get_limit>` **(** :ref:`int<class_int>` margin **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_offset<class_Camera2D_get_offset>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_v_offset<class_Camera2D_get_v_offset>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_zoom<class_Camera2D_get_zoom>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_current<class_Camera2D_is_current>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_follow_smoothing_enabled<class_Camera2D_is_follow_smoothing_enabled>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`force_update_scroll<class_Camera2D_force_update_scroll>` **(** **)** |
| :ref:`bool<class_bool>` | :ref:`is_h_drag_enabled<class_Camera2D_is_h_drag_enabled>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_rotating<class_Camera2D_is_rotating>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_v_drag_enabled<class_Camera2D_is_v_drag_enabled>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`make_current<class_Camera2D_make_current>` **(** **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_anchor_mode<class_Camera2D_set_anchor_mode>` **(** :ref:`int<class_int>` anchor_mode **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_drag_margin<class_Camera2D_set_drag_margin>` **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` drag_margin **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_enable_follow_smoothing<class_Camera2D_set_enable_follow_smoothing>` **(** :ref:`bool<class_bool>` follow_smoothing **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_follow_smoothing<class_Camera2D_set_follow_smoothing>` **(** :ref:`float<class_float>` follow_smoothing **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_h_drag_enabled<class_Camera2D_set_h_drag_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_h_offset<class_Camera2D_set_h_offset>` **(** :ref:`float<class_float>` ofs **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_limit<class_Camera2D_set_limit>` **(** :ref:`int<class_int>` margin, :ref:`int<class_int>` limit **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_offset<class_Camera2D_set_offset>` **(** :ref:`Vector2<class_vector2>` offset **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_rotating<class_Camera2D_set_rotating>` **(** :ref:`bool<class_bool>` rotating **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_v_drag_enabled<class_Camera2D_set_v_drag_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_v_offset<class_Camera2D_set_v_offset>` **(** :ref:`float<class_float>` ofs **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_zoom<class_Camera2D_set_zoom>` **(** :ref:`Vector2<class_vector2>` zoom **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
Numeric Constants
-----------------
- **ANCHOR_MODE_DRAG_CENTER** = **1**
- **ANCHOR_MODE_FIXED_TOP_LEFT** = **0**
- **ANCHOR_MODE_DRAG_CENTER** = **1**
Description
-----------
@@ -96,105 +96,19 @@ This node is intended to be a simple helper get get things going quickly and it
Member Function Description
---------------------------
.. _class_Camera2D_set_offset:
- void **set_offset** **(** :ref:`Vector2<class_vector2>` offset **)**
Set the scroll offset. Useful for looking around or camera shake animations.
.. _class_Camera2D_get_offset:
- :ref:`Vector2<class_vector2>` **get_offset** **(** **)** const
Return the scroll offset.
.. _class_Camera2D_set_anchor_mode:
- void **set_anchor_mode** **(** :ref:`int<class_int>` anchor_mode **)**
.. _class_Camera2D_get_anchor_mode:
- :ref:`int<class_int>` **get_anchor_mode** **(** **)** const
.. _class_Camera2D_set_rotating:
- void **set_rotating** **(** :ref:`bool<class_bool>` rotating **)**
.. _class_Camera2D_is_rotating:
- :ref:`bool<class_bool>` **is_rotating** **(** **)** const
.. _class_Camera2D_make_current:
- void **make_current** **(** **)**
Make this the current 2D camera for the scene (viewport and layer), in case there's many cameras in the scene.
.. _class_Camera2D_clear_current:
- void **clear_current** **(** **)**
.. _class_Camera2D_is_current:
.. _class_Camera2D_force_update_scroll:
- :ref:`bool<class_bool>` **is_current** **(** **)** const
- void **force_update_scroll** **(** **)**
Return true of this is the current camera (see :ref:`make_current<class_Camera2D_make_current>`).
Force the camera to update scroll immediately.
.. _class_Camera2D_set_limit:
.. _class_Camera2D_get_anchor_mode:
- void **set_limit** **(** :ref:`int<class_int>` margin, :ref:`int<class_int>` limit **)**
Set the scrolling limit in pixels.
.. _class_Camera2D_get_limit:
- :ref:`int<class_int>` **get_limit** **(** :ref:`int<class_int>` margin **)** const
Return the scrolling limit in pixels.
.. _class_Camera2D_set_v_drag_enabled:
- void **set_v_drag_enabled** **(** :ref:`bool<class_bool>` enabled **)**
.. _class_Camera2D_is_v_drag_enabled:
- :ref:`bool<class_bool>` **is_v_drag_enabled** **(** **)** const
.. _class_Camera2D_set_h_drag_enabled:
- void **set_h_drag_enabled** **(** :ref:`bool<class_bool>` enabled **)**
.. _class_Camera2D_is_h_drag_enabled:
- :ref:`bool<class_bool>` **is_h_drag_enabled** **(** **)** const
.. _class_Camera2D_set_v_offset:
- void **set_v_offset** **(** :ref:`float<class_float>` ofs **)**
.. _class_Camera2D_get_v_offset:
- :ref:`float<class_float>` **get_v_offset** **(** **)** const
.. _class_Camera2D_set_h_offset:
- void **set_h_offset** **(** :ref:`float<class_float>` ofs **)**
.. _class_Camera2D_get_h_offset:
- :ref:`float<class_float>` **get_h_offset** **(** **)** const
.. _class_Camera2D_set_drag_margin:
- void **set_drag_margin** **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` drag_margin **)**
Set the margins needed to drag the camera (relative to the screen size). Margin uses the MARGIN\_\* enum. Drag margins of 0,0,0,0 will keep the camera at the center of the screen, while drag margins of 1,1,1,1 will only move when the camera is at the edges.
.. _class_Camera2D_get_drag_margin:
- :ref:`float<class_float>` **get_drag_margin** **(** :ref:`int<class_int>` margin **)** const
Return the margins needed to drag the camera (see :ref:`set_drag_margin<class_Camera2D_set_drag_margin>`).
- :ref:`int<class_int>` **get_anchor_mode** **(** **)** const
.. _class_Camera2D_get_camera_pos:
@@ -206,34 +120,120 @@ Return the camera position.
- :ref:`Vector2<class_vector2>` **get_camera_screen_center** **(** **)** const
.. _class_Camera2D_set_zoom:
.. _class_Camera2D_get_drag_margin:
- void **set_zoom** **(** :ref:`Vector2<class_vector2>` zoom **)**
- :ref:`float<class_float>` **get_drag_margin** **(** :ref:`int<class_int>` margin **)** const
.. _class_Camera2D_get_zoom:
- :ref:`Vector2<class_vector2>` **get_zoom** **(** **)** const
.. _class_Camera2D_set_follow_smoothing:
- void **set_follow_smoothing** **(** :ref:`float<class_float>` follow_smoothing **)**
Return the margins needed to drag the camera (see :ref:`set_drag_margin<class_Camera2D_set_drag_margin>`).
.. _class_Camera2D_get_follow_smoothing:
- :ref:`float<class_float>` **get_follow_smoothing** **(** **)** const
.. _class_Camera2D_set_enable_follow_smoothing:
.. _class_Camera2D_get_h_offset:
- void **set_enable_follow_smoothing** **(** :ref:`bool<class_bool>` follow_smoothing **)**
- :ref:`float<class_float>` **get_h_offset** **(** **)** const
.. _class_Camera2D_get_limit:
- :ref:`int<class_int>` **get_limit** **(** :ref:`int<class_int>` margin **)** const
Return the scrolling limit in pixels.
.. _class_Camera2D_get_offset:
- :ref:`Vector2<class_vector2>` **get_offset** **(** **)** const
Return the scroll offset.
.. _class_Camera2D_get_v_offset:
- :ref:`float<class_float>` **get_v_offset** **(** **)** const
.. _class_Camera2D_get_zoom:
- :ref:`Vector2<class_vector2>` **get_zoom** **(** **)** const
.. _class_Camera2D_is_current:
- :ref:`bool<class_bool>` **is_current** **(** **)** const
Return true of this is the current camera (see :ref:`make_current<class_Camera2D_make_current>`).
.. _class_Camera2D_is_follow_smoothing_enabled:
- :ref:`bool<class_bool>` **is_follow_smoothing_enabled** **(** **)** const
.. _class_Camera2D_force_update_scroll:
.. _class_Camera2D_is_h_drag_enabled:
- void **force_update_scroll** **(** **)**
- :ref:`bool<class_bool>` **is_h_drag_enabled** **(** **)** const
Force the camera to update scroll immediately.
.. _class_Camera2D_is_rotating:
- :ref:`bool<class_bool>` **is_rotating** **(** **)** const
.. _class_Camera2D_is_v_drag_enabled:
- :ref:`bool<class_bool>` **is_v_drag_enabled** **(** **)** const
.. _class_Camera2D_make_current:
- void **make_current** **(** **)**
Make this the current 2D camera for the scene (viewport and layer), in case there's many cameras in the scene.
.. _class_Camera2D_set_anchor_mode:
- void **set_anchor_mode** **(** :ref:`int<class_int>` anchor_mode **)**
.. _class_Camera2D_set_drag_margin:
- void **set_drag_margin** **(** :ref:`int<class_int>` margin, :ref:`float<class_float>` drag_margin **)**
Set the margins needed to drag the camera (relative to the screen size). Margin uses the MARGIN\_\* enum. Drag margins of 0,0,0,0 will keep the camera at the center of the screen, while drag margins of 1,1,1,1 will only move when the camera is at the edges.
.. _class_Camera2D_set_enable_follow_smoothing:
- void **set_enable_follow_smoothing** **(** :ref:`bool<class_bool>` follow_smoothing **)**
.. _class_Camera2D_set_follow_smoothing:
- void **set_follow_smoothing** **(** :ref:`float<class_float>` follow_smoothing **)**
.. _class_Camera2D_set_h_drag_enabled:
- void **set_h_drag_enabled** **(** :ref:`bool<class_bool>` enabled **)**
.. _class_Camera2D_set_h_offset:
- void **set_h_offset** **(** :ref:`float<class_float>` ofs **)**
.. _class_Camera2D_set_limit:
- void **set_limit** **(** :ref:`int<class_int>` margin, :ref:`int<class_int>` limit **)**
Set the scrolling limit in pixels.
.. _class_Camera2D_set_offset:
- void **set_offset** **(** :ref:`Vector2<class_vector2>` offset **)**
Set the scroll offset. Useful for looking around or camera shake animations.
.. _class_Camera2D_set_rotating:
- void **set_rotating** **(** :ref:`bool<class_bool>` rotating **)**
.. _class_Camera2D_set_v_drag_enabled:
- void **set_v_drag_enabled** **(** :ref:`bool<class_bool>` enabled **)**
.. _class_Camera2D_set_v_offset:
- void **set_v_offset** **(** :ref:`float<class_float>` ofs **)**
.. _class_Camera2D_set_zoom:
- void **set_zoom** **(** :ref:`Vector2<class_vector2>` zoom **)**

566
classes/class_canvasitem.rst
View File

@@ -23,59 +23,25 @@ Member Functions
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`_draw<class_CanvasItem__draw>` **(** **)** virtual |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`edit_set_state<class_CanvasItem_edit_set_state>` **(** var state **)** |
| :ref:`float<class_float>` | :ref:`draw_char<class_CanvasItem_draw_char>` **(** :ref:`Font<class_font>` font, :ref:`Vector2<class_vector2>` pos, :ref:`String<class_string>` char, :ref:`String<class_string>` next, :ref:`Color<class_color>` modulate=Color(1,1,1,1) **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`edit_get<class_CanvasItem_edit_get>` **(** **)** const |
| void | :ref:`draw_circle<class_CanvasItem_draw_circle>` **(** :ref:`Vector2<class_vector2>` pos, :ref:`float<class_float>` radius, :ref:`Color<class_color>` color **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`edit_set_rect<class_CanvasItem_edit_set_rect>` **(** :ref:`Rect2<class_rect2>` rect **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`edit_rotate<class_CanvasItem_edit_rotate>` **(** :ref:`float<class_float>` degrees **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>` | :ref:`get_item_rect<class_CanvasItem_get_item_rect>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`get_canvas_item<class_CanvasItem_get_canvas_item>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_visible<class_CanvasItem_is_visible>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_hidden<class_CanvasItem_is_hidden>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`show<class_CanvasItem_show>` **(** **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`hide<class_CanvasItem_hide>` **(** **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_hidden<class_CanvasItem_set_hidden>` **(** :ref:`bool<class_bool>` hidden **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`update<class_CanvasItem_update>` **(** **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_as_toplevel<class_CanvasItem_set_as_toplevel>` **(** :ref:`bool<class_bool>` enable **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_set_as_toplevel<class_CanvasItem_is_set_as_toplevel>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_blend_mode<class_CanvasItem_set_blend_mode>` **(** :ref:`int<class_int>` blend_mode **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_blend_mode<class_CanvasItem_get_blend_mode>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_light_mask<class_CanvasItem_set_light_mask>` **(** :ref:`int<class_int>` light_mask **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_light_mask<class_CanvasItem_get_light_mask>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_opacity<class_CanvasItem_set_opacity>` **(** :ref:`float<class_float>` opacity **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_opacity<class_CanvasItem_get_opacity>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_self_opacity<class_CanvasItem_set_self_opacity>` **(** :ref:`float<class_float>` self_opacity **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_self_opacity<class_CanvasItem_get_self_opacity>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_draw_behind_parent<class_CanvasItem_set_draw_behind_parent>` **(** :ref:`bool<class_bool>` enable **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_draw_behind_parent_enabled<class_CanvasItem_is_draw_behind_parent_enabled>` **(** **)** const |
| void | :ref:`draw_colored_polygon<class_CanvasItem_draw_colored_polygon>` **(** :ref:`Vector2Array<class_vector2array>` points, :ref:`Color<class_color>` color, :ref:`Vector2Array<class_vector2array>` uvs=Vector2Array(), :ref:`Texture<class_texture>` texture=NULL **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`draw_line<class_CanvasItem_draw_line>` **(** :ref:`Vector2<class_vector2>` from, :ref:`Vector2<class_vector2>` to, :ref:`Color<class_color>` color, :ref:`float<class_float>` width=1 **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`draw_polygon<class_CanvasItem_draw_polygon>` **(** :ref:`Vector2Array<class_vector2array>` points, :ref:`ColorArray<class_colorarray>` colors, :ref:`Vector2Array<class_vector2array>` uvs=Vector2Array(), :ref:`Texture<class_texture>` texture=NULL **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`draw_primitive<class_CanvasItem_draw_primitive>` **(** :ref:`Vector2Array<class_vector2array>` points, :ref:`ColorArray<class_colorarray>` colors, :ref:`Vector2Array<class_vector2array>` uvs, :ref:`Texture<class_texture>` texture=NULL, :ref:`float<class_float>` width=1 **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`draw_rect<class_CanvasItem_draw_rect>` **(** :ref:`Rect2<class_rect2>` rect, :ref:`Color<class_color>` color **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`draw_circle<class_CanvasItem_draw_circle>` **(** :ref:`Vector2<class_vector2>` pos, :ref:`float<class_float>` radius, :ref:`Color<class_color>` color **)** |
| void | :ref:`draw_set_transform<class_CanvasItem_draw_set_transform>` **(** :ref:`Vector2<class_vector2>` pos, :ref:`float<class_float>` rot, :ref:`Vector2<class_vector2>` scale **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`draw_string<class_CanvasItem_draw_string>` **(** :ref:`Font<class_font>` font, :ref:`Vector2<class_vector2>` pos, :ref:`String<class_string>` text, :ref:`Color<class_color>` modulate=Color(1,1,1,1), :ref:`int<class_int>` clip_w=-1 **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`draw_style_box<class_CanvasItem_draw_style_box>` **(** :ref:`StyleBox<class_stylebox>` style_box, :ref:`Rect2<class_rect2>` rect **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`draw_texture<class_CanvasItem_draw_texture>` **(** :ref:`Texture<class_texture>` texture, :ref:`Vector2<class_vector2>` pos, :ref:`Color<class_color>` modulate=Color(1,1,1,1) **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -83,58 +49,92 @@ Member Functions
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`draw_texture_rect_region<class_CanvasItem_draw_texture_rect_region>` **(** :ref:`Texture<class_texture>` texture, :ref:`Rect2<class_rect2>` rect, :ref:`Rect2<class_rect2>` src_rect, :ref:`Color<class_color>` modulate=Color(1,1,1,1), :ref:`bool<class_bool>` transpose=false **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`draw_style_box<class_CanvasItem_draw_style_box>` **(** :ref:`StyleBox<class_stylebox>` style_box, :ref:`Rect2<class_rect2>` rect **)** |
| Variant | :ref:`edit_get_state<class_CanvasItem_edit_get_state>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`draw_primitive<class_CanvasItem_draw_primitive>` **(** :ref:`Vector2Array<class_vector2array>` points, :ref:`ColorArray<class_colorarray>` colors, :ref:`Vector2Array<class_vector2array>` uvs, :ref:`Texture<class_texture>` texture=NULL, :ref:`float<class_float>` width=1 **)** |
| void | :ref:`edit_rotate<class_CanvasItem_edit_rotate>` **(** :ref:`float<class_float>` degrees **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`draw_polygon<class_CanvasItem_draw_polygon>` **(** :ref:`Vector2Array<class_vector2array>` points, :ref:`ColorArray<class_colorarray>` colors, :ref:`Vector2Array<class_vector2array>` uvs=Vector2Array(), :ref:`Texture<class_texture>` texture=NULL **)** |
| void | :ref:`edit_set_rect<class_CanvasItem_edit_set_rect>` **(** :ref:`Rect2<class_rect2>` rect **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`draw_colored_polygon<class_CanvasItem_draw_colored_polygon>` **(** :ref:`Vector2Array<class_vector2array>` points, :ref:`Color<class_color>` color, :ref:`Vector2Array<class_vector2array>` uvs=Vector2Array(), :ref:`Texture<class_texture>` texture=NULL **)** |
| void | :ref:`edit_set_state<class_CanvasItem_edit_set_state>` **(** var state **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`draw_string<class_CanvasItem_draw_string>` **(** :ref:`Font<class_font>` font, :ref:`Vector2<class_vector2>` pos, :ref:`String<class_string>` text, :ref:`Color<class_color>` modulate=Color(1,1,1,1), :ref:`int<class_int>` clip_w=-1 **)** |
| :ref:`int<class_int>` | :ref:`get_blend_mode<class_CanvasItem_get_blend_mode>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`draw_char<class_CanvasItem_draw_char>` **(** :ref:`Font<class_font>` font, :ref:`Vector2<class_vector2>` pos, :ref:`String<class_string>` char, :ref:`String<class_string>` next, :ref:`Color<class_color>` modulate=Color(1,1,1,1) **)** |
| :ref:`RID<class_rid>` | :ref:`get_canvas<class_CanvasItem_get_canvas>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`draw_set_transform<class_CanvasItem_draw_set_transform>` **(** :ref:`Vector2<class_vector2>` pos, :ref:`float<class_float>` rot, :ref:`Vector2<class_vector2>` scale **)** |
| :ref:`RID<class_rid>` | :ref:`get_canvas_item<class_CanvasItem_get_canvas_item>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Matrix32<class_matrix32>` | :ref:`get_transform<class_CanvasItem_get_transform>` **(** **)** const |
| :ref:`Matrix32<class_matrix32>` | :ref:`get_canvas_transform<class_CanvasItem_get_canvas_transform>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_global_mouse_pos<class_CanvasItem_get_global_mouse_pos>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Matrix32<class_matrix32>` | :ref:`get_global_transform<class_CanvasItem_get_global_transform>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Matrix32<class_matrix32>` | :ref:`get_global_transform_with_canvas<class_CanvasItem_get_global_transform_with_canvas>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Matrix32<class_matrix32>` | :ref:`get_viewport_transform<class_CanvasItem_get_viewport_transform>` **(** **)** const |
| :ref:`Rect2<class_rect2>` | :ref:`get_item_rect<class_CanvasItem_get_item_rect>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>` | :ref:`get_viewport_rect<class_CanvasItem_get_viewport_rect>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Matrix32<class_matrix32>` | :ref:`get_canvas_transform<class_CanvasItem_get_canvas_transform>` **(** **)** const |
| :ref:`int<class_int>` | :ref:`get_light_mask<class_CanvasItem_get_light_mask>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_local_mouse_pos<class_CanvasItem_get_local_mouse_pos>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_global_mouse_pos<class_CanvasItem_get_global_mouse_pos>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`get_canvas<class_CanvasItem_get_canvas>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>` | :ref:`get_world_2d<class_CanvasItem_get_world_2d>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_material<class_CanvasItem_set_material>` **(** :ref:`CanvasItemMaterial<class_canvasitemmaterial>` material **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`CanvasItemMaterial<class_canvasitemmaterial>` | :ref:`get_material<class_CanvasItem_get_material>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_use_parent_material<class_CanvasItem_set_use_parent_material>` **(** :ref:`bool<class_bool>` enable **)** |
| :ref:`float<class_float>` | :ref:`get_opacity<class_CanvasItem_get_opacity>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_self_opacity<class_CanvasItem_get_self_opacity>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Matrix32<class_matrix32>` | :ref:`get_transform<class_CanvasItem_get_transform>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_use_parent_material<class_CanvasItem_get_use_parent_material>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>` | :ref:`get_viewport_rect<class_CanvasItem_get_viewport_rect>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Matrix32<class_matrix32>` | :ref:`get_viewport_transform<class_CanvasItem_get_viewport_transform>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>` | :ref:`get_world_2d<class_CanvasItem_get_world_2d>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`hide<class_CanvasItem_hide>` **(** **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_draw_behind_parent_enabled<class_CanvasItem_is_draw_behind_parent_enabled>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_hidden<class_CanvasItem_is_hidden>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_set_as_toplevel<class_CanvasItem_is_set_as_toplevel>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_visible<class_CanvasItem_is_visible>` **(** **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`InputEvent<class_inputevent>` | :ref:`make_input_local<class_CanvasItem_make_input_local>` **(** :ref:`InputEvent<class_inputevent>` event **)** const |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_as_toplevel<class_CanvasItem_set_as_toplevel>` **(** :ref:`bool<class_bool>` enable **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_blend_mode<class_CanvasItem_set_blend_mode>` **(** :ref:`int<class_int>` blend_mode **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_draw_behind_parent<class_CanvasItem_set_draw_behind_parent>` **(** :ref:`bool<class_bool>` enable **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_hidden<class_CanvasItem_set_hidden>` **(** :ref:`bool<class_bool>` hidden **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_light_mask<class_CanvasItem_set_light_mask>` **(** :ref:`int<class_int>` light_mask **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_material<class_CanvasItem_set_material>` **(** :ref:`CanvasItemMaterial<class_canvasitemmaterial>` material **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_opacity<class_CanvasItem_set_opacity>` **(** :ref:`float<class_float>` opacity **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_self_opacity<class_CanvasItem_set_self_opacity>` **(** :ref:`float<class_float>` self_opacity **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_use_parent_material<class_CanvasItem_set_use_parent_material>` **(** :ref:`bool<class_bool>` enable **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`show<class_CanvasItem_show>` **(** **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`update<class_CanvasItem_update>` **(** **)** |
+------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
- **item_rect_changed** **(** **)**
- **draw** **(** **)**
- **visibility_changed** **(** **)**
- **hide** **(** **)**
- **item_rect_changed** **(** **)**
- **visibility_changed** **(** **)**
Numeric Constants
-----------------
@@ -144,11 +144,11 @@ Numeric Constants
- **BLEND_MODE_SUB** = **2** --- Subtractive blending mode.
- **BLEND_MODE_MUL** = **3** --- Multiplicative blending mode.
- **BLEND_MODE_PREMULT_ALPHA** = **4** --- Mix blending mode. Colors are assumed to be premultiplied by the alpha (opacity) value.
- **NOTIFICATION_TRANSFORM_CHANGED** = **29** --- Canvas item transform has changed. Only received if requested.
- **NOTIFICATION_DRAW** = **30** --- CanvasItem is requested to draw.
- **NOTIFICATION_VISIBILITY_CHANGED** = **31** --- Canvas item visibility has changed.
- **NOTIFICATION_ENTER_CANVAS** = **32** --- Canvas item has entered the canvas.
- **NOTIFICATION_EXIT_CANVAS** = **33** --- Canvas item has exited the canvas.
- **NOTIFICATION_TRANSFORM_CHANGED** = **29** --- Canvas item transform has changed. Only received if requested.
Description
-----------
@@ -172,139 +172,23 @@ Member Function Description
Called (if exists) to draw the canvas item.
.. _class_CanvasItem_edit_set_state:
.. _class_CanvasItem_draw_char:
- void **edit_set_state** **(** var state **)**
- :ref:`float<class_float>` **draw_char** **(** :ref:`Font<class_font>` font, :ref:`Vector2<class_vector2>` pos, :ref:`String<class_string>` char, :ref:`String<class_string>` next, :ref:`Color<class_color>` modulate=Color(1,1,1,1) **)**
Used for editing, returns an opaque value representing the transform state.
Draw a string character using a custom font. Returns the advance, depending on the char width and kerning with an optional next char.
.. _class_CanvasItem_edit_get:
.. _class_CanvasItem_draw_circle:
- void **edit_get** **(** **)** const
- void **draw_circle** **(** :ref:`Vector2<class_vector2>` pos, :ref:`float<class_float>` radius, :ref:`Color<class_color>` color **)**
.. _class_CanvasItem_edit_set_rect:
Draw a colored circle.
- void **edit_set_rect** **(** :ref:`Rect2<class_rect2>` rect **)**
.. _class_CanvasItem_draw_colored_polygon:
.. _class_CanvasItem_edit_rotate:
- void **draw_colored_polygon** **(** :ref:`Vector2Array<class_vector2array>` points, :ref:`Color<class_color>` color, :ref:`Vector2Array<class_vector2array>` uvs=Vector2Array(), :ref:`Texture<class_texture>` texture=NULL **)**
- void **edit_rotate** **(** :ref:`float<class_float>` degrees **)**
Used for editing, handle rotation.
.. _class_CanvasItem_get_item_rect:
- :ref:`Rect2<class_rect2>` **get_item_rect** **(** **)** const
Return a rect containing the editable contents of the item.
.. _class_CanvasItem_get_canvas_item:
- :ref:`RID<class_rid>` **get_canvas_item** **(** **)** const
Return the canvas item RID used by :ref:`VisualServer<class_visualserver>` for this item.
.. _class_CanvasItem_is_visible:
- :ref:`bool<class_bool>` **is_visible** **(** **)** const
Return true if this CanvasItem is visible. It may be invisible because itself or a parent canvas item is hidden.
.. _class_CanvasItem_is_hidden:
- :ref:`bool<class_bool>` **is_hidden** **(** **)** const
Return true if this CanvasItem is hidden. Note that the CanvasItem may not be visible, but as long as it's not hidden (:ref:`hide<class_CanvasItem_hide>` called) the function will return false.
.. _class_CanvasItem_show:
- void **show** **(** **)**
Show the CanvasItem currently hidden.
.. _class_CanvasItem_hide:
- void **hide** **(** **)**
Hide the CanvasItem currently visible.
.. _class_CanvasItem_set_hidden:
- void **set_hidden** **(** :ref:`bool<class_bool>` hidden **)**
.. _class_CanvasItem_update:
- void **update** **(** **)**
Queue the CanvasItem for update. NOTIFICATION_DRAW will be called on idle time to request redraw.
.. _class_CanvasItem_set_as_toplevel:
- void **set_as_toplevel** **(** :ref:`bool<class_bool>` enable **)**
Set as toplevel. This means that it will not inherit transform from parent canvas items.
.. _class_CanvasItem_is_set_as_toplevel:
- :ref:`bool<class_bool>` **is_set_as_toplevel** **(** **)** const
Return if set as toplevel. See :ref:`set_as_toplevel<class_CanvasItem_set_as_toplevel>`.
.. _class_CanvasItem_set_blend_mode:
- void **set_blend_mode** **(** :ref:`int<class_int>` blend_mode **)**
Set the blending mode from enum BLEND_MODE\_\*.
.. _class_CanvasItem_get_blend_mode:
- :ref:`int<class_int>` **get_blend_mode** **(** **)** const
Return the current blending mode from enum BLEND_MODE\_\*.
.. _class_CanvasItem_set_light_mask:
- void **set_light_mask** **(** :ref:`int<class_int>` light_mask **)**
.. _class_CanvasItem_get_light_mask:
- :ref:`int<class_int>` **get_light_mask** **(** **)** const
.. _class_CanvasItem_set_opacity:
- void **set_opacity** **(** :ref:`float<class_float>` opacity **)**
Set canvas item opacity. This will affect the canvas item and all the children.
.. _class_CanvasItem_get_opacity:
- :ref:`float<class_float>` **get_opacity** **(** **)** const
Return the canvas item opacity. This affects the canvas item and all the children.
.. _class_CanvasItem_set_self_opacity:
- void **set_self_opacity** **(** :ref:`float<class_float>` self_opacity **)**
Set canvas item self-opacity. This does not affect the opacity of children items.
.. _class_CanvasItem_get_self_opacity:
- :ref:`float<class_float>` **get_self_opacity** **(** **)** const
Return the canvas item self-opacity.
.. _class_CanvasItem_set_draw_behind_parent:
- void **set_draw_behind_parent** **(** :ref:`bool<class_bool>` enable **)**
Sets whether the canvas item is drawn behind its parent.
.. _class_CanvasItem_is_draw_behind_parent_enabled:
- :ref:`bool<class_bool>` **is_draw_behind_parent_enabled** **(** **)** const
Return whether the item is drawn behind its parent.
Draw a colored polygon of any amount of points, convex or concave.
.. _class_CanvasItem_draw_line:
@@ -312,17 +196,41 @@ Return whether the item is drawn behind its parent.
Draw a line from a 2D point to another, with a given color and width.
.. _class_CanvasItem_draw_polygon:
- void **draw_polygon** **(** :ref:`Vector2Array<class_vector2array>` points, :ref:`ColorArray<class_colorarray>` colors, :ref:`Vector2Array<class_vector2array>` uvs=Vector2Array(), :ref:`Texture<class_texture>` texture=NULL **)**
Draw a polygon of any amount of points, convex or concave.
.. _class_CanvasItem_draw_primitive:
- void **draw_primitive** **(** :ref:`Vector2Array<class_vector2array>` points, :ref:`ColorArray<class_colorarray>` colors, :ref:`Vector2Array<class_vector2array>` uvs, :ref:`Texture<class_texture>` texture=NULL, :ref:`float<class_float>` width=1 **)**
Draw a custom primitive, 1 point for a point, 2 points for a line, 3 points for a triangle and 4 points for a quad.
.. _class_CanvasItem_draw_rect:
- void **draw_rect** **(** :ref:`Rect2<class_rect2>` rect, :ref:`Color<class_color>` color **)**
Draw a colored rectangle.
.. _class_CanvasItem_draw_circle:
.. _class_CanvasItem_draw_set_transform:
- void **draw_circle** **(** :ref:`Vector2<class_vector2>` pos, :ref:`float<class_float>` radius, :ref:`Color<class_color>` color **)**
- void **draw_set_transform** **(** :ref:`Vector2<class_vector2>` pos, :ref:`float<class_float>` rot, :ref:`Vector2<class_vector2>` scale **)**
Draw a colored circle.
Set a custom transform for drawing. Anything drawn afterwards will be transformed by this.
.. _class_CanvasItem_draw_string:
- void **draw_string** **(** :ref:`Font<class_font>` font, :ref:`Vector2<class_vector2>` pos, :ref:`String<class_string>` text, :ref:`Color<class_color>` modulate=Color(1,1,1,1), :ref:`int<class_int>` clip_w=-1 **)**
Draw a string using a custom font.
.. _class_CanvasItem_draw_style_box:
- void **draw_style_box** **(** :ref:`StyleBox<class_stylebox>` style_box, :ref:`Rect2<class_rect2>` rect **)**
Draw a styled rectangle.
.. _class_CanvasItem_draw_texture:
@@ -342,106 +250,236 @@ Draw a textured rectangle at a given position, optionally modulated by a color.
Draw a textured rectangle region at a given position, optionally modulated by a color. Transpose swaps the x and y coordinates when reading the texture.
.. _class_CanvasItem_draw_style_box:
.. _class_CanvasItem_edit_get_state:
- void **draw_style_box** **(** :ref:`StyleBox<class_stylebox>` style_box, :ref:`Rect2<class_rect2>` rect **)**
- Variant **edit_get_state** **(** **)** const
Draw a styled rectangle.
Used for editing, returns an opaque value representing the transform state.
.. _class_CanvasItem_draw_primitive:
.. _class_CanvasItem_edit_rotate:
- void **draw_primitive** **(** :ref:`Vector2Array<class_vector2array>` points, :ref:`ColorArray<class_colorarray>` colors, :ref:`Vector2Array<class_vector2array>` uvs, :ref:`Texture<class_texture>` texture=NULL, :ref:`float<class_float>` width=1 **)**
- void **edit_rotate** **(** :ref:`float<class_float>` degrees **)**
Draw a custom primitive, 1 point for a point, 2 points for a line, 3 points for a triangle and 4 points for a quad.
Used for editing, handle rotation.
.. _class_CanvasItem_draw_polygon:
.. _class_CanvasItem_edit_set_rect:
- void **draw_polygon** **(** :ref:`Vector2Array<class_vector2array>` points, :ref:`ColorArray<class_colorarray>` colors, :ref:`Vector2Array<class_vector2array>` uvs=Vector2Array(), :ref:`Texture<class_texture>` texture=NULL **)**
- void **edit_set_rect** **(** :ref:`Rect2<class_rect2>` rect **)**
Draw a polygon of any amount of points, convex or concave.
.. _class_CanvasItem_edit_set_state:
.. _class_CanvasItem_draw_colored_polygon:
- void **edit_set_state** **(** var state **)**
- void **draw_colored_polygon** **(** :ref:`Vector2Array<class_vector2array>` points, :ref:`Color<class_color>` color, :ref:`Vector2Array<class_vector2array>` uvs=Vector2Array(), :ref:`Texture<class_texture>` texture=NULL **)**
Set the transform state of this CanvasItem. For :ref:`Node2D<class_node2d>`, this is an :ref:`Array<class_array>` with (in order) a :ref:`Vector2<class_vector2>` for position, a float for rotation and another :ref:`Vector2<class_vector2>` for scale. For :ref:`Control<class_control>` this is a :ref:`Rect2<class_rect2>` with the position and size.
Draw a colored polygon of any amount of points, convex or concave.
.. _class_CanvasItem_get_blend_mode:
.. _class_CanvasItem_draw_string:
- :ref:`int<class_int>` **get_blend_mode** **(** **)** const
- void **draw_string** **(** :ref:`Font<class_font>` font, :ref:`Vector2<class_vector2>` pos, :ref:`String<class_string>` text, :ref:`Color<class_color>` modulate=Color(1,1,1,1), :ref:`int<class_int>` clip_w=-1 **)**
Draw a string using a custom font.
.. _class_CanvasItem_draw_char:
- :ref:`float<class_float>` **draw_char** **(** :ref:`Font<class_font>` font, :ref:`Vector2<class_vector2>` pos, :ref:`String<class_string>` char, :ref:`String<class_string>` next, :ref:`Color<class_color>` modulate=Color(1,1,1,1) **)**
Draw a string character using a custom font. Returns the advance, depending on the char width and kerning with an optional next char.
.. _class_CanvasItem_draw_set_transform:
- void **draw_set_transform** **(** :ref:`Vector2<class_vector2>` pos, :ref:`float<class_float>` rot, :ref:`Vector2<class_vector2>` scale **)**
Set a custom transform for drawing. Anything drawn afterwards will be transformed by this.
.. _class_CanvasItem_get_transform:
- :ref:`Matrix32<class_matrix32>` **get_transform** **(** **)** const
.. _class_CanvasItem_get_global_transform:
- :ref:`Matrix32<class_matrix32>` **get_global_transform** **(** **)** const
.. _class_CanvasItem_get_global_transform_with_canvas:
- :ref:`Matrix32<class_matrix32>` **get_global_transform_with_canvas** **(** **)** const
.. _class_CanvasItem_get_viewport_transform:
- :ref:`Matrix32<class_matrix32>` **get_viewport_transform** **(** **)** const
.. _class_CanvasItem_get_viewport_rect:
- :ref:`Rect2<class_rect2>` **get_viewport_rect** **(** **)** const
.. _class_CanvasItem_get_canvas_transform:
- :ref:`Matrix32<class_matrix32>` **get_canvas_transform** **(** **)** const
.. _class_CanvasItem_get_local_mouse_pos:
- :ref:`Vector2<class_vector2>` **get_local_mouse_pos** **(** **)** const
.. _class_CanvasItem_get_global_mouse_pos:
- :ref:`Vector2<class_vector2>` **get_global_mouse_pos** **(** **)** const
Return the current blending mode from enum BLEND_MODE\_\*.
.. _class_CanvasItem_get_canvas:
- :ref:`RID<class_rid>` **get_canvas** **(** **)** const
.. _class_CanvasItem_get_world_2d:
Return the :ref:`RID<class_rid>` of the :ref:`World2D<class_world2d>` canvas where this item is in.
- :ref:`Object<class_object>` **get_world_2d** **(** **)** const
.. _class_CanvasItem_get_canvas_item:
.. _class_CanvasItem_set_material:
- :ref:`RID<class_rid>` **get_canvas_item** **(** **)** const
- void **set_material** **(** :ref:`CanvasItemMaterial<class_canvasitemmaterial>` material **)**
Return the canvas item RID used by :ref:`VisualServer<class_visualserver>` for this item.
.. _class_CanvasItem_get_canvas_transform:
- :ref:`Matrix32<class_matrix32>` **get_canvas_transform** **(** **)** const
Get the transform matrix of this item's canvas.
.. _class_CanvasItem_get_global_mouse_pos:
- :ref:`Vector2<class_vector2>` **get_global_mouse_pos** **(** **)** const
Get the global position of the mouse.
.. _class_CanvasItem_get_global_transform:
- :ref:`Matrix32<class_matrix32>` **get_global_transform** **(** **)** const
Get the global transform matrix of this item.
.. _class_CanvasItem_get_global_transform_with_canvas:
- :ref:`Matrix32<class_matrix32>` **get_global_transform_with_canvas** **(** **)** const
Get the global transform matrix of this item in relation to the canvas.
.. _class_CanvasItem_get_item_rect:
- :ref:`Rect2<class_rect2>` **get_item_rect** **(** **)** const
Return a rect containing the editable boundaries of the item.
.. _class_CanvasItem_get_light_mask:
- :ref:`int<class_int>` **get_light_mask** **(** **)** const
Get this item's light mask number.
.. _class_CanvasItem_get_local_mouse_pos:
- :ref:`Vector2<class_vector2>` **get_local_mouse_pos** **(** **)** const
Get the mouse position relative to this item's position.
.. _class_CanvasItem_get_material:
- :ref:`CanvasItemMaterial<class_canvasitemmaterial>` **get_material** **(** **)** const
.. _class_CanvasItem_set_use_parent_material:
Get the material of this item.
- void **set_use_parent_material** **(** :ref:`bool<class_bool>` enable **)**
.. _class_CanvasItem_get_opacity:
- :ref:`float<class_float>` **get_opacity** **(** **)** const
Return the canvas item opacity. This affects the canvas item and all the children.
.. _class_CanvasItem_get_self_opacity:
- :ref:`float<class_float>` **get_self_opacity** **(** **)** const
Return the canvas item self-opacity.
.. _class_CanvasItem_get_transform:
- :ref:`Matrix32<class_matrix32>` **get_transform** **(** **)** const
Get the transform matrix of this item.
.. _class_CanvasItem_get_use_parent_material:
- :ref:`bool<class_bool>` **get_use_parent_material** **(** **)** const
Get whether this item uses its parent's material.
.. _class_CanvasItem_get_viewport_rect:
- :ref:`Rect2<class_rect2>` **get_viewport_rect** **(** **)** const
Get the viewport's boundaries as a :ref:`Rect2<class_rect2>`.
.. _class_CanvasItem_get_viewport_transform:
- :ref:`Matrix32<class_matrix32>` **get_viewport_transform** **(** **)** const
Get this item's transform in relation to the viewport.
.. _class_CanvasItem_get_world_2d:
- :ref:`Object<class_object>` **get_world_2d** **(** **)** const
Get the :ref:`World2D<class_world2d>` where this item is in.
.. _class_CanvasItem_hide:
- void **hide** **(** **)**
Hide the CanvasItem currently visible.
.. _class_CanvasItem_is_draw_behind_parent_enabled:
- :ref:`bool<class_bool>` **is_draw_behind_parent_enabled** **(** **)** const
Return whether the item is drawn behind its parent.
.. _class_CanvasItem_is_hidden:
- :ref:`bool<class_bool>` **is_hidden** **(** **)** const
Return true if this CanvasItem is hidden. Note that the CanvasItem may not be visible, but as long as it's not hidden (:ref:`hide<class_CanvasItem_hide>` called) the function will return false.
.. _class_CanvasItem_is_set_as_toplevel:
- :ref:`bool<class_bool>` **is_set_as_toplevel** **(** **)** const
Return if set as toplevel. See :ref:`set_as_toplevel<class_CanvasItem_set_as_toplevel>`.
.. _class_CanvasItem_is_visible:
- :ref:`bool<class_bool>` **is_visible** **(** **)** const
Return true if this CanvasItem is visible. It may be invisible because itself or a parent canvas item is hidden.
.. _class_CanvasItem_make_input_local:
- :ref:`InputEvent<class_inputevent>` **make_input_local** **(** :ref:`InputEvent<class_inputevent>` event **)** const
Takes a global input event and convert to this item's coordinate system.
.. _class_CanvasItem_set_as_toplevel:
- void **set_as_toplevel** **(** :ref:`bool<class_bool>` enable **)**
Set as top level. This means that it will not inherit transform from parent canvas items.
.. _class_CanvasItem_set_blend_mode:
- void **set_blend_mode** **(** :ref:`int<class_int>` blend_mode **)**
Set the blending mode from enum BLEND_MODE\_\*.
.. _class_CanvasItem_set_draw_behind_parent:
- void **set_draw_behind_parent** **(** :ref:`bool<class_bool>` enable **)**
Set whether the canvas item is drawn behind its parent.
.. _class_CanvasItem_set_hidden:
- void **set_hidden** **(** :ref:`bool<class_bool>` hidden **)**
Set whether this item should be hidden or not. Note that no matter what is set here this item won't be shown if its parent or grandparents nodes are also hidden. A hidden CanvasItem make all children hidden too.
.. _class_CanvasItem_set_light_mask:
- void **set_light_mask** **(** :ref:`int<class_int>` light_mask **)**
Set the ligtht mask number of this item.
.. _class_CanvasItem_set_material:
- void **set_material** **(** :ref:`CanvasItemMaterial<class_canvasitemmaterial>` material **)**
Set the material of this item.
.. _class_CanvasItem_set_opacity:
- void **set_opacity** **(** :ref:`float<class_float>` opacity **)**
Set canvas item opacity. This will affect the canvas item and all the children.
.. _class_CanvasItem_set_self_opacity:
- void **set_self_opacity** **(** :ref:`float<class_float>` self_opacity **)**
Set canvas item self-opacity. This does not affect the opacity of children items.
.. _class_CanvasItem_set_use_parent_material:
- void **set_use_parent_material** **(** :ref:`bool<class_bool>` enable **)**
Set whether or not this item should use its parent's material.
.. _class_CanvasItem_show:
- void **show** **(** **)**
Show the CanvasItem currently hidden.
.. _class_CanvasItem_update:
- void **update** **(** **)**
Queue the CanvasItem for update. ``NOTIFICATION_DRAW`` will be called on idle time to request redraw.

36
classes/class_canvasitemmaterial.rst
View File

@@ -18,19 +18,19 @@ Brief Description
Member Functions
----------------
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_shader<class_CanvasItemMaterial_set_shader>` **(** :ref:`Shader<class_shader>` shader **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Shader<class_shader>` | :ref:`get_shader<class_CanvasItemMaterial_get_shader>` **(** **)** const |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_shader_param<class_CanvasItemMaterial_set_shader_param>` **(** :ref:`String<class_string>` param, var value **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`get_shader_param<class_CanvasItemMaterial_get_shader_param>` **(** :ref:`String<class_string>` param **)** const |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_shading_mode<class_CanvasItemMaterial_set_shading_mode>` **(** :ref:`int<class_int>` mode **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_shading_mode<class_CanvasItemMaterial_get_shading_mode>` **(** **)** const |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_shader<class_CanvasItemMaterial_set_shader>` **(** :ref:`Shader<class_shader>` shader **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_shader_param<class_CanvasItemMaterial_set_shader_param>` **(** :ref:`String<class_string>` param, var value **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_shading_mode<class_CanvasItemMaterial_set_shading_mode>` **(** :ref:`int<class_int>` mode **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
Numeric Constants
-----------------
@@ -42,28 +42,28 @@ Numeric Constants
Member Function Description
---------------------------
.. _class_CanvasItemMaterial_set_shader:
- void **set_shader** **(** :ref:`Shader<class_shader>` shader **)**
.. _class_CanvasItemMaterial_get_shader:
- :ref:`Shader<class_shader>` **get_shader** **(** **)** const
.. _class_CanvasItemMaterial_set_shader_param:
- void **set_shader_param** **(** :ref:`String<class_string>` param, var value **)**
.. _class_CanvasItemMaterial_get_shader_param:
- void **get_shader_param** **(** :ref:`String<class_string>` param **)** const
.. _class_CanvasItemMaterial_set_shading_mode:
- void **set_shading_mode** **(** :ref:`int<class_int>` mode **)**
.. _class_CanvasItemMaterial_get_shading_mode:
- :ref:`int<class_int>` **get_shading_mode** **(** **)** const
.. _class_CanvasItemMaterial_set_shader:
- void **set_shader** **(** :ref:`Shader<class_shader>` shader **)**
.. _class_CanvasItemMaterial_set_shader_param:
- void **set_shader_param** **(** :ref:`String<class_string>` param, var value **)**
.. _class_CanvasItemMaterial_set_shading_mode:
- void **set_shading_mode** **(** :ref:`int<class_int>` mode **)**

120
classes/class_canvaslayer.rst
View File

@@ -20,34 +20,34 @@ Canvas Item layer.
Member Functions
----------------
+----------------------------------+---------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_layer<class_CanvasLayer_set_layer>` **(** :ref:`int<class_int>` layer **)** |
+----------------------------------+---------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_layer<class_CanvasLayer_get_layer>` **(** **)** const |
+----------------------------------+---------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_transform<class_CanvasLayer_set_transform>` **(** :ref:`Matrix32<class_matrix32>` transform **)** |
+----------------------------------+---------------------------------------------------------------------------------------------------------------+
| :ref:`Matrix32<class_matrix32>` | :ref:`get_transform<class_CanvasLayer_get_transform>` **(** **)** const |
+----------------------------------+---------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_offset<class_CanvasLayer_set_offset>` **(** :ref:`Vector2<class_vector2>` offset **)** |
+----------------------------------+---------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_offset<class_CanvasLayer_get_offset>` **(** **)** const |
+----------------------------------+---------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_rotation<class_CanvasLayer_set_rotation>` **(** :ref:`float<class_float>` radians **)** |
+----------------------------------+---------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_rotation<class_CanvasLayer_get_rotation>` **(** **)** const |
+----------------------------------+---------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_rotationd<class_CanvasLayer_set_rotationd>` **(** :ref:`float<class_float>` degrees **)** |
+----------------------------------+---------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_rotationd<class_CanvasLayer_get_rotationd>` **(** **)** const |
+----------------------------------+---------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_scale<class_CanvasLayer_set_scale>` **(** :ref:`Vector2<class_vector2>` scale **)** |
+----------------------------------+---------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_scale<class_CanvasLayer_get_scale>` **(** **)** const |
+----------------------------------+---------------------------------------------------------------------------------------------------------------+
| :ref:`Matrix32<class_matrix32>` | :ref:`get_transform<class_CanvasLayer_get_transform>` **(** **)** const |
+----------------------------------+---------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`get_viewport<class_CanvasLayer_get_viewport>` **(** **)** const |
+----------------------------------+---------------------------------------------------------------------------------------------------------------+
| :ref:`World2D<class_world2d>` | :ref:`get_world_2d<class_CanvasLayer_get_world_2d>` **(** **)** const |
+----------------------------------+---------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`get_viewport<class_CanvasLayer_get_viewport>` **(** **)** const |
| void | :ref:`set_layer<class_CanvasLayer_set_layer>` **(** :ref:`int<class_int>` layer **)** |
+----------------------------------+---------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_offset<class_CanvasLayer_set_offset>` **(** :ref:`Vector2<class_vector2>` offset **)** |
+----------------------------------+---------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_rotation<class_CanvasLayer_set_rotation>` **(** :ref:`float<class_float>` radians **)** |
+----------------------------------+---------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_rotationd<class_CanvasLayer_set_rotationd>` **(** :ref:`float<class_float>` degrees **)** |
+----------------------------------+---------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_scale<class_CanvasLayer_set_scale>` **(** :ref:`Vector2<class_vector2>` scale **)** |
+----------------------------------+---------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_transform<class_CanvasLayer_set_transform>` **(** :ref:`Matrix32<class_matrix32>` transform **)** |
+----------------------------------+---------------------------------------------------------------------------------------------------------------+
Description
@@ -58,83 +58,41 @@ Canvas Item layer. :ref:`CanvasItem<class_canvasitem>` nodes that are direct or
Member Function Description
---------------------------
.. _class_CanvasLayer_set_layer:
- void **set_layer** **(** :ref:`int<class_int>` layer **)**
Set the layer index, determines the draw order, a lower value will be below a higher one.
.. _class_CanvasLayer_get_layer:
- :ref:`int<class_int>` **get_layer** **(** **)** const
Return the layer index, determines the draw order, a lower value will be below a higher one.
.. _class_CanvasLayer_set_transform:
- void **set_transform** **(** :ref:`Matrix32<class_matrix32>` transform **)**
Set the base transform for this layer.
.. _class_CanvasLayer_get_transform:
- :ref:`Matrix32<class_matrix32>` **get_transform** **(** **)** const
Return the base transform for this layer.
.. _class_CanvasLayer_set_offset:
- void **set_offset** **(** :ref:`Vector2<class_vector2>` offset **)**
Set the base offset for this layer (helper).
.. _class_CanvasLayer_get_offset:
- :ref:`Vector2<class_vector2>` **get_offset** **(** **)** const
Return the base offset for this layer (helper).
.. _class_CanvasLayer_set_rotation:
- void **set_rotation** **(** :ref:`float<class_float>` radians **)**
Set the base rotation for this layer (helper).
.. _class_CanvasLayer_get_rotation:
- :ref:`float<class_float>` **get_rotation** **(** **)** const
Return the base rotation for this layer (helper).
.. _class_CanvasLayer_set_rotationd:
- void **set_rotationd** **(** :ref:`float<class_float>` degrees **)**
Set rotation of the layer in degree.
.. _class_CanvasLayer_get_rotationd:
- :ref:`float<class_float>` **get_rotationd** **(** **)** const
Get rotation of the layer in degree.
.. _class_CanvasLayer_set_scale:
- void **set_scale** **(** :ref:`Vector2<class_vector2>` scale **)**
Set the base scale for this layer (helper).
.. _class_CanvasLayer_get_scale:
- :ref:`Vector2<class_vector2>` **get_scale** **(** **)** const
Return the base scale for this layer (helper).
.. _class_CanvasLayer_get_world_2d:
.. _class_CanvasLayer_get_transform:
- :ref:`World2D<class_world2d>` **get_world_2d** **(** **)** const
- :ref:`Matrix32<class_matrix32>` **get_transform** **(** **)** const
Return the :ref:`World2D<class_world2d>` used by this layer.
Return the base transform for this layer.
.. _class_CanvasLayer_get_viewport:
@@ -142,4 +100,46 @@ Return the :ref:`World2D<class_world2d>` used by this layer.
Return the viewport RID for this layer.
.. _class_CanvasLayer_get_world_2d:
- :ref:`World2D<class_world2d>` **get_world_2d** **(** **)** const
Return the :ref:`World2D<class_world2d>` used by this layer.
.. _class_CanvasLayer_set_layer:
- void **set_layer** **(** :ref:`int<class_int>` layer **)**
Set the layer index, determines the draw order, a lower value will be below a higher one.
.. _class_CanvasLayer_set_offset:
- void **set_offset** **(** :ref:`Vector2<class_vector2>` offset **)**
Set the base offset for this layer (helper).
.. _class_CanvasLayer_set_rotation:
- void **set_rotation** **(** :ref:`float<class_float>` radians **)**
Set the base rotation for this layer (helper).
.. _class_CanvasLayer_set_rotationd:
- void **set_rotationd** **(** :ref:`float<class_float>` degrees **)**
Set rotation of the layer in degree.
.. _class_CanvasLayer_set_scale:
- void **set_scale** **(** :ref:`Vector2<class_vector2>` scale **)**
Set the base scale for this layer (helper).
.. _class_CanvasLayer_set_transform:
- void **set_transform** **(** :ref:`Matrix32<class_matrix32>` transform **)**
Set the base transform for this layer.

16
classes/class_canvasmodulate.rst
View File

@@ -18,11 +18,11 @@ Tint the entire canvas
Member Functions
----------------
+----------------------------+------------------------------------------------------------------------------------------------+
| void | :ref:`set_color<class_CanvasModulate_set_color>` **(** :ref:`Color<class_color>` color **)** |
+----------------------------+------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_color<class_CanvasModulate_get_color>` **(** **)** const |
+----------------------------+------------------------------------------------------------------------------------------------+
| void | :ref:`set_color<class_CanvasModulate_set_color>` **(** :ref:`Color<class_color>` color **)** |
+----------------------------+------------------------------------------------------------------------------------------------+
Description
-----------
@@ -32,16 +32,16 @@ CanvasModulate tints the canvas elements using its asigned color
Member Function Description
---------------------------
.. _class_CanvasModulate_set_color:
- void **set_color** **(** :ref:`Color<class_color>` color **)**
Sets the canvas tint color
.. _class_CanvasModulate_get_color:
- :ref:`Color<class_color>` **get_color** **(** **)** const
Gets the canvas tint color
.. _class_CanvasModulate_set_color:
- void **set_color** **(** :ref:`Color<class_color>` color **)**
Sets the canvas tint color

16
classes/class_capsuleshape.rst
View File

@@ -19,13 +19,13 @@ Member Functions
----------------
+----------------------------+-------------------------------------------------------------------------------------------------+
| void | :ref:`set_radius<class_CapsuleShape_set_radius>` **(** :ref:`float<class_float>` radius **)** |
| :ref:`float<class_float>` | :ref:`get_height<class_CapsuleShape_get_height>` **(** **)** const |
+----------------------------+-------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_radius<class_CapsuleShape_get_radius>` **(** **)** const |
+----------------------------+-------------------------------------------------------------------------------------------------+
| void | :ref:`set_height<class_CapsuleShape_set_height>` **(** :ref:`float<class_float>` height **)** |
+----------------------------+-------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_height<class_CapsuleShape_get_height>` **(** **)** const |
| void | :ref:`set_radius<class_CapsuleShape_set_radius>` **(** :ref:`float<class_float>` radius **)** |
+----------------------------+-------------------------------------------------------------------------------------------------+
Description
@@ -36,11 +36,11 @@ Capsule shape resource, which can be set into a :ref:`PhysicsBody<class_physicsb
Member Function Description
---------------------------
.. _class_CapsuleShape_set_radius:
.. _class_CapsuleShape_get_height:
- void **set_radius** **(** :ref:`float<class_float>` radius **)**
- :ref:`float<class_float>` **get_height** **(** **)** const
Set the capsule radius.
Return the capsule height.
.. _class_CapsuleShape_get_radius:
@@ -54,10 +54,10 @@ Return the capsule radius.
Set the capsule height.
.. _class_CapsuleShape_get_height:
.. _class_CapsuleShape_set_radius:
- :ref:`float<class_float>` **get_height** **(** **)** const
- void **set_radius** **(** :ref:`float<class_float>` radius **)**
Return the capsule height.
Set the capsule radius.

16
classes/class_capsuleshape2d.rst
View File

@@ -19,13 +19,13 @@ Member Functions
----------------
+----------------------------+---------------------------------------------------------------------------------------------------+
| void | :ref:`set_radius<class_CapsuleShape2D_set_radius>` **(** :ref:`float<class_float>` radius **)** |
| :ref:`float<class_float>` | :ref:`get_height<class_CapsuleShape2D_get_height>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_radius<class_CapsuleShape2D_get_radius>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------+
| void | :ref:`set_height<class_CapsuleShape2D_set_height>` **(** :ref:`float<class_float>` height **)** |
+----------------------------+---------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_height<class_CapsuleShape2D_get_height>` **(** **)** const |
| void | :ref:`set_radius<class_CapsuleShape2D_set_radius>` **(** :ref:`float<class_float>` radius **)** |
+----------------------------+---------------------------------------------------------------------------------------------------+
Description
@@ -36,11 +36,11 @@ Capsule 2D shape resource for physics. A capsule (or sometimes called "pill") is
Member Function Description
---------------------------
.. _class_CapsuleShape2D_set_radius:
.. _class_CapsuleShape2D_get_height:
- void **set_radius** **(** :ref:`float<class_float>` radius **)**
- :ref:`float<class_float>` **get_height** **(** **)** const
Set the radius of the :ref:`CapsuleShape2D<class_capsuleshape2d>`.
Return the height of the :ref:`CapsuleShape2D<class_capsuleshape2d>`.
.. _class_CapsuleShape2D_get_radius:
@@ -54,10 +54,10 @@ Return the radius of the :ref:`CapsuleShape2D<class_capsuleshape2d>`.
Set the height of the :ref:`CapsuleShape2D<class_capsuleshape2d>`.
.. _class_CapsuleShape2D_get_height:
.. _class_CapsuleShape2D_set_radius:
- :ref:`float<class_float>` **get_height** **(** **)** const
- void **set_radius** **(** :ref:`float<class_float>` radius **)**
Return the height of the :ref:`CapsuleShape2D<class_capsuleshape2d>`.
Set the radius of the :ref:`CapsuleShape2D<class_capsuleshape2d>`.

16
classes/class_centercontainer.rst
View File

@@ -18,11 +18,11 @@ Keeps children controls centered.
Member Functions
----------------
+--------------------------+--------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_use_top_left<class_CenterContainer_set_use_top_left>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_using_top_left<class_CenterContainer_is_using_top_left>` **(** **)** const |
+--------------------------+--------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_use_top_left<class_CenterContainer_set_use_top_left>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------+--------------------------------------------------------------------------------------------------------------+
Description
-----------
@@ -32,16 +32,16 @@ CenterContainer Keeps children controls centered. This container keeps all child
Member Function Description
---------------------------
.. _class_CenterContainer_set_use_top_left:
- void **set_use_top_left** **(** :ref:`bool<class_bool>` enable **)**
This function will anchor the container children to the top left corner of the the container boundaries, moving all its children to that position, (the children new center will be the top left corner of the container).
.. _class_CenterContainer_is_using_top_left:
- :ref:`bool<class_bool>` **is_using_top_left** **(** **)** const
Should put children to the top left corner instead of center of the container.
.. _class_CenterContainer_set_use_top_left:
- void **set_use_top_left** **(** :ref:`bool<class_bool>` enable **)**
This function will anchor the container children to the top left corner of the the container boundaries, moving all its children to that position, (the children new center will be the top left corner of the container).

16
classes/class_circleshape2d.rst
View File

@@ -18,11 +18,11 @@ Circular Shape for 2D Physics.
Member Functions
----------------
+----------------------------+--------------------------------------------------------------------------------------------------+
| void | :ref:`set_radius<class_CircleShape2D_set_radius>` **(** :ref:`float<class_float>` radius **)** |
+----------------------------+--------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_radius<class_CircleShape2D_get_radius>` **(** **)** const |
+----------------------------+--------------------------------------------------------------------------------------------------+
| void | :ref:`set_radius<class_CircleShape2D_set_radius>` **(** :ref:`float<class_float>` radius **)** |
+----------------------------+--------------------------------------------------------------------------------------------------+
Description
-----------
@@ -32,16 +32,16 @@ Circular Shape for 2D Physics. This shape is useful for modeling balls or small
Member Function Description
---------------------------
.. _class_CircleShape2D_set_radius:
- void **set_radius** **(** :ref:`float<class_float>` radius **)**
Set the radius of the circle shape.
.. _class_CircleShape2D_get_radius:
- :ref:`float<class_float>` **get_radius** **(** **)** const
Return the radius of the circle shape.
.. _class_CircleShape2D_set_radius:
- void **set_radius** **(** :ref:`float<class_float>` radius **)**
Set the radius of the circle shape.

134
classes/class_collisionobject.rst
View File

@@ -25,40 +25,40 @@ Member Functions
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_shape<class_CollisionObject_add_shape>` **(** :ref:`Shape<class_shape>` shape, :ref:`Transform<class_transform>` transform=Transform() **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_shape_count<class_CollisionObject_get_shape_count>` **(** **)** const |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_shape<class_CollisionObject_set_shape>` **(** :ref:`int<class_int>` shape_idx, :ref:`Shape<class_shape>` shape **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_shape_transform<class_CollisionObject_set_shape_transform>` **(** :ref:`int<class_int>` shape_idx, :ref:`Transform<class_transform>` transform **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_shape_as_trigger<class_CollisionObject_set_shape_as_trigger>` **(** :ref:`int<class_int>` shape_idx, :ref:`bool<class_bool>` enable **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_shape_set_as_trigger<class_CollisionObject_is_shape_set_as_trigger>` **(** :ref:`int<class_int>` shape_idx **)** const |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Shape<class_shape>` | :ref:`get_shape<class_CollisionObject_get_shape>` **(** :ref:`int<class_int>` shape_idx **)** const |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform<class_transform>` | :ref:`get_shape_transform<class_CollisionObject_get_shape_transform>` **(** :ref:`int<class_int>` shape_idx **)** const |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_shape<class_CollisionObject_remove_shape>` **(** :ref:`int<class_int>` shape_idx **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_shapes<class_CollisionObject_clear_shapes>` **(** **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_ray_pickable<class_CollisionObject_set_ray_pickable>` **(** :ref:`bool<class_bool>` ray_pickable **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_ray_pickable<class_CollisionObject_is_ray_pickable>` **(** **)** const |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_capture_input_on_drag<class_CollisionObject_set_capture_input_on_drag>` **(** :ref:`bool<class_bool>` enable **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_capture_input_on_drag<class_CollisionObject_get_capture_input_on_drag>` **(** **)** const |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`get_rid<class_CollisionObject_get_rid>` **(** **)** const |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Shape<class_shape>` | :ref:`get_shape<class_CollisionObject_get_shape>` **(** :ref:`int<class_int>` shape_idx **)** const |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_shape_count<class_CollisionObject_get_shape_count>` **(** **)** const |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform<class_transform>` | :ref:`get_shape_transform<class_CollisionObject_get_shape_transform>` **(** :ref:`int<class_int>` shape_idx **)** const |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_ray_pickable<class_CollisionObject_is_ray_pickable>` **(** **)** const |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_shape_set_as_trigger<class_CollisionObject_is_shape_set_as_trigger>` **(** :ref:`int<class_int>` shape_idx **)** const |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_shape<class_CollisionObject_remove_shape>` **(** :ref:`int<class_int>` shape_idx **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_capture_input_on_drag<class_CollisionObject_set_capture_input_on_drag>` **(** :ref:`bool<class_bool>` enable **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_ray_pickable<class_CollisionObject_set_ray_pickable>` **(** :ref:`bool<class_bool>` ray_pickable **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_shape<class_CollisionObject_set_shape>` **(** :ref:`int<class_int>` shape_idx, :ref:`Shape<class_shape>` shape **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_shape_as_trigger<class_CollisionObject_set_shape_as_trigger>` **(** :ref:`int<class_int>` shape_idx, :ref:`bool<class_bool>` enable **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_shape_transform<class_CollisionObject_set_shape_transform>` **(** :ref:`int<class_int>` shape_idx, :ref:`Transform<class_transform>` transform **)** |
+------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
- **mouse_enter** **(** **)**
- **input_event** **(** :ref:`Object<class_object>` camera, :ref:`InputEvent<class_inputevent>` event, :ref:`Vector3<class_vector3>` click_pos, :ref:`Vector3<class_vector3>` click_normal, :ref:`int<class_int>` shape_idx **)**
- **mouse_enter** **(** **)**
- **mouse_exit** **(** **)**
Member Function Description
@@ -72,54 +72,10 @@ Member Function Description
- void **add_shape** **(** :ref:`Shape<class_shape>` shape, :ref:`Transform<class_transform>` transform=Transform() **)**
.. _class_CollisionObject_get_shape_count:
- :ref:`int<class_int>` **get_shape_count** **(** **)** const
.. _class_CollisionObject_set_shape:
- void **set_shape** **(** :ref:`int<class_int>` shape_idx, :ref:`Shape<class_shape>` shape **)**
.. _class_CollisionObject_set_shape_transform:
- void **set_shape_transform** **(** :ref:`int<class_int>` shape_idx, :ref:`Transform<class_transform>` transform **)**
.. _class_CollisionObject_set_shape_as_trigger:
- void **set_shape_as_trigger** **(** :ref:`int<class_int>` shape_idx, :ref:`bool<class_bool>` enable **)**
.. _class_CollisionObject_is_shape_set_as_trigger:
- :ref:`bool<class_bool>` **is_shape_set_as_trigger** **(** :ref:`int<class_int>` shape_idx **)** const
.. _class_CollisionObject_get_shape:
- :ref:`Shape<class_shape>` **get_shape** **(** :ref:`int<class_int>` shape_idx **)** const
.. _class_CollisionObject_get_shape_transform:
- :ref:`Transform<class_transform>` **get_shape_transform** **(** :ref:`int<class_int>` shape_idx **)** const
.. _class_CollisionObject_remove_shape:
- void **remove_shape** **(** :ref:`int<class_int>` shape_idx **)**
.. _class_CollisionObject_clear_shapes:
- void **clear_shapes** **(** **)**
.. _class_CollisionObject_set_ray_pickable:
- void **set_ray_pickable** **(** :ref:`bool<class_bool>` ray_pickable **)**
.. _class_CollisionObject_is_ray_pickable:
- :ref:`bool<class_bool>` **is_ray_pickable** **(** **)** const
.. _class_CollisionObject_set_capture_input_on_drag:
- void **set_capture_input_on_drag** **(** :ref:`bool<class_bool>` enable **)**
.. _class_CollisionObject_get_capture_input_on_drag:
- :ref:`bool<class_bool>` **get_capture_input_on_drag** **(** **)** const
@@ -128,4 +84,48 @@ Member Function Description
- :ref:`RID<class_rid>` **get_rid** **(** **)** const
.. _class_CollisionObject_get_shape:
- :ref:`Shape<class_shape>` **get_shape** **(** :ref:`int<class_int>` shape_idx **)** const
.. _class_CollisionObject_get_shape_count:
- :ref:`int<class_int>` **get_shape_count** **(** **)** const
.. _class_CollisionObject_get_shape_transform:
- :ref:`Transform<class_transform>` **get_shape_transform** **(** :ref:`int<class_int>` shape_idx **)** const
.. _class_CollisionObject_is_ray_pickable:
- :ref:`bool<class_bool>` **is_ray_pickable** **(** **)** const
.. _class_CollisionObject_is_shape_set_as_trigger:
- :ref:`bool<class_bool>` **is_shape_set_as_trigger** **(** :ref:`int<class_int>` shape_idx **)** const
.. _class_CollisionObject_remove_shape:
- void **remove_shape** **(** :ref:`int<class_int>` shape_idx **)**
.. _class_CollisionObject_set_capture_input_on_drag:
- void **set_capture_input_on_drag** **(** :ref:`bool<class_bool>` enable **)**
.. _class_CollisionObject_set_ray_pickable:
- void **set_ray_pickable** **(** :ref:`bool<class_bool>` ray_pickable **)**
.. _class_CollisionObject_set_shape:
- void **set_shape** **(** :ref:`int<class_int>` shape_idx, :ref:`Shape<class_shape>` shape **)**
.. _class_CollisionObject_set_shape_as_trigger:
- void **set_shape_as_trigger** **(** :ref:`int<class_int>` shape_idx, :ref:`bool<class_bool>` enable **)**
.. _class_CollisionObject_set_shape_transform:
- void **set_shape_transform** **(** :ref:`int<class_int>` shape_idx, :ref:`Transform<class_transform>` transform **)**

90
classes/class_collisionobject2d.rst
View File

@@ -25,36 +25,36 @@ Member Functions
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_shape<class_CollisionObject2D_add_shape>` **(** :ref:`Shape2D<class_shape2d>` shape, :ref:`Matrix32<class_matrix32>` transform=1,0, 0,1, 0,0 **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_shape_count<class_CollisionObject2D_get_shape_count>` **(** **)** const |
| void | :ref:`clear_shapes<class_CollisionObject2D_clear_shapes>` **(** **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_shape<class_CollisionObject2D_set_shape>` **(** :ref:`int<class_int>` shape_idx, :ref:`Shape<class_shape>` shape **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_shape_transform<class_CollisionObject2D_set_shape_transform>` **(** :ref:`int<class_int>` shape_idx, :ref:`Matrix32<class_matrix32>` transform **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_shape_as_trigger<class_CollisionObject2D_set_shape_as_trigger>` **(** :ref:`int<class_int>` shape_idx, :ref:`bool<class_bool>` enable **)** |
| :ref:`RID<class_rid>` | :ref:`get_rid<class_CollisionObject2D_get_rid>` **(** **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Shape2D<class_shape2d>` | :ref:`get_shape<class_CollisionObject2D_get_shape>` **(** :ref:`int<class_int>` shape_idx **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_shape_count<class_CollisionObject2D_get_shape_count>` **(** **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Matrix32<class_matrix32>` | :ref:`get_shape_transform<class_CollisionObject2D_get_shape_transform>` **(** :ref:`int<class_int>` shape_idx **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_pickable<class_CollisionObject2D_is_pickable>` **(** **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_shape_set_as_trigger<class_CollisionObject2D_is_shape_set_as_trigger>` **(** :ref:`int<class_int>` shape_idx **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_shape<class_CollisionObject2D_remove_shape>` **(** :ref:`int<class_int>` shape_idx **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_shapes<class_CollisionObject2D_clear_shapes>` **(** **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`get_rid<class_CollisionObject2D_get_rid>` **(** **)** const |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_pickable<class_CollisionObject2D_set_pickable>` **(** :ref:`bool<class_bool>` enabled **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_pickable<class_CollisionObject2D_is_pickable>` **(** **)** const |
| void | :ref:`set_shape<class_CollisionObject2D_set_shape>` **(** :ref:`int<class_int>` shape_idx, :ref:`Shape<class_shape>` shape **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_shape_as_trigger<class_CollisionObject2D_set_shape_as_trigger>` **(** :ref:`int<class_int>` shape_idx, :ref:`bool<class_bool>` enable **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_shape_transform<class_CollisionObject2D_set_shape_transform>` **(** :ref:`int<class_int>` shape_idx, :ref:`Matrix32<class_matrix32>` transform **)** |
+----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
- **mouse_enter** **(** **)**
- **input_event** **(** :ref:`Object<class_object>` viewport, :ref:`InputEvent<class_inputevent>` event, :ref:`int<class_int>` shape_idx **)**
- **mouse_enter** **(** **)**
- **mouse_exit** **(** **)**
Description
@@ -77,29 +77,17 @@ This method can be used to override normal input processing. The first parameter
Add a :ref:`Shape2D<class_shape2d>` to the collision body, with a given custom transform.
.. _class_CollisionObject2D_get_shape_count:
.. _class_CollisionObject2D_clear_shapes:
- :ref:`int<class_int>` **get_shape_count** **(** **)** const
- void **clear_shapes** **(** **)**
Return the amount of shapes in the collision body. Because a :ref:`CollisionPolygon2D<class_collisionpolygon2d>` can generate more than one :ref:`Shape2D<class_shape2d>`, the amount returned does not have to match the sum of :ref:`CollisionShape2D<class_collisionshape2d>` and :ref:`CollisionPolygon2D<class_collisionpolygon2d>`.
Remove all shapes.
.. _class_CollisionObject2D_set_shape:
.. _class_CollisionObject2D_get_rid:
- void **set_shape** **(** :ref:`int<class_int>` shape_idx, :ref:`Shape<class_shape>` shape **)**
- :ref:`RID<class_rid>` **get_rid** **(** **)** const
Change a shape in the collision body.
.. _class_CollisionObject2D_set_shape_transform:
- void **set_shape_transform** **(** :ref:`int<class_int>` shape_idx, :ref:`Matrix32<class_matrix32>` transform **)**
Change the shape transform in the collision body.
.. _class_CollisionObject2D_set_shape_as_trigger:
- void **set_shape_as_trigger** **(** :ref:`int<class_int>` shape_idx, :ref:`bool<class_bool>` enable **)**
Set whether a shape is a trigger. A trigger shape detects collisions, but is otherwise unaffected by physics (i.e. colliding objects will not get blocked).
Return the RID of this object.
.. _class_CollisionObject2D_get_shape:
@@ -107,12 +95,24 @@ Set whether a shape is a trigger. A trigger shape detects collisions, but is oth
Return the shape in the given index.
.. _class_CollisionObject2D_get_shape_count:
- :ref:`int<class_int>` **get_shape_count** **(** **)** const
Return the amount of shapes in the collision body. Because a :ref:`CollisionPolygon2D<class_collisionpolygon2d>` can generate more than one :ref:`Shape2D<class_shape2d>`, the amount returned does not have to match the sum of :ref:`CollisionShape2D<class_collisionshape2d>` and :ref:`CollisionPolygon2D<class_collisionpolygon2d>`.
.. _class_CollisionObject2D_get_shape_transform:
- :ref:`Matrix32<class_matrix32>` **get_shape_transform** **(** :ref:`int<class_int>` shape_idx **)** const
Return the shape transform in the given index.
.. _class_CollisionObject2D_is_pickable:
- :ref:`bool<class_bool>` **is_pickable** **(** **)** const
Return whether this object is pickable.
.. _class_CollisionObject2D_is_shape_set_as_trigger:
- :ref:`bool<class_bool>` **is_shape_set_as_trigger** **(** :ref:`int<class_int>` shape_idx **)** const
@@ -125,28 +125,28 @@ Return whether a shape is a trigger. A trigger shape detects collisions, but is
Remove the shape in the given index.
.. _class_CollisionObject2D_clear_shapes:
- void **clear_shapes** **(** **)**
Remove all shapes.
.. _class_CollisionObject2D_get_rid:
- :ref:`RID<class_rid>` **get_rid** **(** **)** const
Return the RID of this object.
.. _class_CollisionObject2D_set_pickable:
- void **set_pickable** **(** :ref:`bool<class_bool>` enabled **)**
Set whether this object is pickable. A pickable object can detect the mouse pointer enter/leave it and, if the mouse is inside it, report input events.
.. _class_CollisionObject2D_is_pickable:
.. _class_CollisionObject2D_set_shape:
- :ref:`bool<class_bool>` **is_pickable** **(** **)** const
- void **set_shape** **(** :ref:`int<class_int>` shape_idx, :ref:`Shape<class_shape>` shape **)**
Return whether this object is pickable.
Change a shape in the collision body.
.. _class_CollisionObject2D_set_shape_as_trigger:
- void **set_shape_as_trigger** **(** :ref:`int<class_int>` shape_idx, :ref:`bool<class_bool>` enable **)**
Set whether a shape is a trigger. A trigger shape detects collisions, but is otherwise unaffected by physics (i.e. colliding objects will not get blocked).
.. _class_CollisionObject2D_set_shape_transform:
- void **set_shape_transform** **(** :ref:`int<class_int>` shape_idx, :ref:`Matrix32<class_matrix32>` transform **)**
Change the shape transform in the collision body.

60
classes/class_collisionpolygon.rst
View File

@@ -18,51 +18,31 @@ Brief Description
Member Functions
----------------
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_build_mode<class_CollisionPolygon_set_build_mode>` **(** :ref:`int<class_int>` build_mode **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_build_mode<class_CollisionPolygon_get_build_mode>` **(** **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_depth<class_CollisionPolygon_set_depth>` **(** :ref:`float<class_float>` depth **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_depth<class_CollisionPolygon_get_depth>` **(** **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_polygon<class_CollisionPolygon_set_polygon>` **(** :ref:`Vector2Array<class_vector2array>` polygon **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2Array<class_vector2array>` | :ref:`get_polygon<class_CollisionPolygon_get_polygon>` **(** **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_collision_object_first_shape<class_CollisionPolygon_get_collision_object_first_shape>` **(** **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_collision_object_last_shape<class_CollisionPolygon_get_collision_object_last_shape>` **(** **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_depth<class_CollisionPolygon_get_depth>` **(** **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2Array<class_vector2array>` | :ref:`get_polygon<class_CollisionPolygon_get_polygon>` **(** **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_build_mode<class_CollisionPolygon_set_build_mode>` **(** :ref:`int<class_int>` build_mode **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_depth<class_CollisionPolygon_set_depth>` **(** :ref:`float<class_float>` depth **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_polygon<class_CollisionPolygon_set_polygon>` **(** :ref:`Vector2Array<class_vector2array>` polygon **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------+
Member Function Description
---------------------------
.. _class_CollisionPolygon_set_build_mode:
- void **set_build_mode** **(** :ref:`int<class_int>` build_mode **)**
.. _class_CollisionPolygon_get_build_mode:
- :ref:`int<class_int>` **get_build_mode** **(** **)** const
.. _class_CollisionPolygon_set_depth:
- void **set_depth** **(** :ref:`float<class_float>` depth **)**
.. _class_CollisionPolygon_get_depth:
- :ref:`float<class_float>` **get_depth** **(** **)** const
.. _class_CollisionPolygon_set_polygon:
- void **set_polygon** **(** :ref:`Vector2Array<class_vector2array>` polygon **)**
.. _class_CollisionPolygon_get_polygon:
- :ref:`Vector2Array<class_vector2array>` **get_polygon** **(** **)** const
.. _class_CollisionPolygon_get_collision_object_first_shape:
- :ref:`int<class_int>` **get_collision_object_first_shape** **(** **)** const
@@ -71,4 +51,24 @@ Member Function Description
- :ref:`int<class_int>` **get_collision_object_last_shape** **(** **)** const
.. _class_CollisionPolygon_get_depth:
- :ref:`float<class_float>` **get_depth** **(** **)** const
.. _class_CollisionPolygon_get_polygon:
- :ref:`Vector2Array<class_vector2array>` **get_polygon** **(** **)** const
.. _class_CollisionPolygon_set_build_mode:
- void **set_build_mode** **(** :ref:`int<class_int>` build_mode **)**
.. _class_CollisionPolygon_set_depth:
- void **set_depth** **(** :ref:`float<class_float>` depth **)**
.. _class_CollisionPolygon_set_polygon:
- void **set_polygon** **(** :ref:`Vector2Array<class_vector2array>` polygon **)**

84
classes/class_collisionpolygon2d.rst
View File

@@ -18,23 +18,23 @@ Editor-only class for easy editing of collision polygons.
Member Functions
----------------
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_polygon<class_CollisionPolygon2D_set_polygon>` **(** :ref:`Vector2Array<class_vector2array>` polygon **)** |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2Array<class_vector2array>` | :ref:`get_polygon<class_CollisionPolygon2D_get_polygon>` **(** **)** const |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_build_mode<class_CollisionPolygon2D_set_build_mode>` **(** :ref:`int<class_int>` build_mode **)** |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_build_mode<class_CollisionPolygon2D_get_build_mode>` **(** **)** const |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_trigger<class_CollisionPolygon2D_set_trigger>` **(** :ref:`bool<class_bool>` trigger **)** |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_trigger<class_CollisionPolygon2D_is_trigger>` **(** **)** const |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_collision_object_first_shape<class_CollisionPolygon2D_get_collision_object_first_shape>` **(** **)** const |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_collision_object_last_shape<class_CollisionPolygon2D_get_collision_object_last_shape>` **(** **)** const |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2Array<class_vector2array>` | :ref:`get_polygon<class_CollisionPolygon2D_get_polygon>` **(** **)** const |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_trigger<class_CollisionPolygon2D_is_trigger>` **(** **)** const |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_build_mode<class_CollisionPolygon2D_set_build_mode>` **(** :ref:`int<class_int>` build_mode **)** |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_polygon<class_CollisionPolygon2D_set_polygon>` **(** :ref:`Vector2Array<class_vector2array>` polygon **)** |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_trigger<class_CollisionPolygon2D_set_trigger>` **(** :ref:`bool<class_bool>` trigger **)** |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------+
Description
-----------
@@ -44,44 +44,12 @@ Editor-only class. This is not present when running the game. It's used in the e
Member Function Description
---------------------------
.. _class_CollisionPolygon2D_set_polygon:
- void **set_polygon** **(** :ref:`Vector2Array<class_vector2array>` polygon **)**
Set the array of points forming the polygon.
When editing the point list via the editor, depending on :ref:`get_build_mode<class_CollisionPolygon2D_get_build_mode>`, it has to be a list of points (for ``build_mode==0``), or a list of lines (for ``build_mode==1``). In the second case, the even elements of the array define the start point of the line, and the odd elements the end point.
.. _class_CollisionPolygon2D_get_polygon:
- :ref:`Vector2Array<class_vector2array>` **get_polygon** **(** **)** const
Return the list of points that define the polygon.
.. _class_CollisionPolygon2D_set_build_mode:
- void **set_build_mode** **(** :ref:`int<class_int>` build_mode **)**
Set whether the polygon is to be a :ref:`ConvexPolygonShape2D<class_convexpolygonshape2d>` (``build_mode==0``), or a :ref:`ConcavePolygonShape2D<class_concavepolygonshape2d>` (``build_mode==1``).
.. _class_CollisionPolygon2D_get_build_mode:
- :ref:`int<class_int>` **get_build_mode** **(** **)** const
Return whether the polygon is a :ref:`ConvexPolygonShape2D<class_convexpolygonshape2d>` (``build_mode==0``), or a :ref:`ConcavePolygonShape2D<class_concavepolygonshape2d>` (``build_mode==1``).
.. _class_CollisionPolygon2D_set_trigger:
- void **set_trigger** **(** :ref:`bool<class_bool>` trigger **)**
Set whether this polygon is a trigger. A trigger polygon detects collisions, but is otherwise unaffected by physics (i.e. colliding objects will not get blocked).
.. _class_CollisionPolygon2D_is_trigger:
- :ref:`bool<class_bool>` **is_trigger** **(** **)** const
Return whether this polygon is a trigger.
.. _class_CollisionPolygon2D_get_collision_object_first_shape:
- :ref:`int<class_int>` **get_collision_object_first_shape** **(** **)** const
@@ -98,4 +66,36 @@ When ``build_mode`` is set to generate concave polygons, there is only one :ref:
Return the index of the last shape generated by the editor.
.. _class_CollisionPolygon2D_get_polygon:
- :ref:`Vector2Array<class_vector2array>` **get_polygon** **(** **)** const
Return the list of points that define the polygon.
.. _class_CollisionPolygon2D_is_trigger:
- :ref:`bool<class_bool>` **is_trigger** **(** **)** const
Return whether this polygon is a trigger.
.. _class_CollisionPolygon2D_set_build_mode:
- void **set_build_mode** **(** :ref:`int<class_int>` build_mode **)**
Set whether the polygon is to be a :ref:`ConvexPolygonShape2D<class_convexpolygonshape2d>` (``build_mode==0``), or a :ref:`ConcavePolygonShape2D<class_concavepolygonshape2d>` (``build_mode==1``).
.. _class_CollisionPolygon2D_set_polygon:
- void **set_polygon** **(** :ref:`Vector2Array<class_vector2array>` polygon **)**
Set the array of points forming the polygon.
When editing the point list via the editor, depending on :ref:`get_build_mode<class_CollisionPolygon2D_get_build_mode>`, it has to be a list of points (for ``build_mode==0``), or a list of lines (for ``build_mode==1``). In the second case, the even elements of the array define the start point of the line, and the odd elements the end point.
.. _class_CollisionPolygon2D_set_trigger:
- void **set_trigger** **(** :ref:`bool<class_bool>` trigger **)**
Set whether this polygon is a trigger. A trigger polygon detects collisions, but is otherwise unaffected by physics (i.e. colliding objects will not get blocked).

36
classes/class_collisionshape.rst
View File

@@ -19,40 +19,32 @@ Member Functions
----------------
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
| void | :ref:`resource_changed<class_CollisionShape_resource_changed>` **(** :ref:`Object<class_object>` resource **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_shape<class_CollisionShape_set_shape>` **(** :ref:`Object<class_object>` shape **)** |
| :ref:`int<class_int>` | :ref:`get_collision_object_shape_index<class_CollisionShape_get_collision_object_shape_index>` **(** **)** const |
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>` | :ref:`get_shape<class_CollisionShape_get_shape>` **(** **)** const |
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_trigger<class_CollisionShape_set_trigger>` **(** :ref:`bool<class_bool>` enable **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_trigger<class_CollisionShape_is_trigger>` **(** **)** const |
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
| void | :ref:`make_convex_from_brothers<class_CollisionShape_make_convex_from_brothers>` **(** **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_collision_object_shape_index<class_CollisionShape_get_collision_object_shape_index>` **(** **)** const |
| void | :ref:`resource_changed<class_CollisionShape_resource_changed>` **(** :ref:`Object<class_object>` resource **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_shape<class_CollisionShape_set_shape>` **(** :ref:`Object<class_object>` shape **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_trigger<class_CollisionShape_set_trigger>` **(** :ref:`bool<class_bool>` enable **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------+
Member Function Description
---------------------------
.. _class_CollisionShape_resource_changed:
.. _class_CollisionShape_get_collision_object_shape_index:
- void **resource_changed** **(** :ref:`Object<class_object>` resource **)**
.. _class_CollisionShape_set_shape:
- void **set_shape** **(** :ref:`Object<class_object>` shape **)**
- :ref:`int<class_int>` **get_collision_object_shape_index** **(** **)** const
.. _class_CollisionShape_get_shape:
- :ref:`Object<class_object>` **get_shape** **(** **)** const
.. _class_CollisionShape_set_trigger:
- void **set_trigger** **(** :ref:`bool<class_bool>` enable **)**
.. _class_CollisionShape_is_trigger:
- :ref:`bool<class_bool>` **is_trigger** **(** **)** const
@@ -61,8 +53,16 @@ Member Function Description
- void **make_convex_from_brothers** **(** **)**
.. _class_CollisionShape_get_collision_object_shape_index:
.. _class_CollisionShape_resource_changed:
- :ref:`int<class_int>` **get_collision_object_shape_index** **(** **)** const
- void **resource_changed** **(** :ref:`Object<class_object>` resource **)**
.. _class_CollisionShape_set_shape:
- void **set_shape** **(** :ref:`Object<class_object>` shape **)**
.. _class_CollisionShape_set_trigger:
- void **set_trigger** **(** :ref:`bool<class_bool>` enable **)**

32
classes/class_collisionshape2d.rst
View File

@@ -19,15 +19,15 @@ Member Functions
----------------
+------------------------------+---------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_shape<class_CollisionShape2D_set_shape>` **(** :ref:`Object<class_object>` shape **)** |
| :ref:`int<class_int>` | :ref:`get_collision_object_shape_index<class_CollisionShape2D_get_collision_object_shape_index>` **(** **)** const |
+------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>` | :ref:`get_shape<class_CollisionShape2D_get_shape>` **(** **)** const |
+------------------------------+---------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_trigger<class_CollisionShape2D_set_trigger>` **(** :ref:`bool<class_bool>` enable **)** |
+------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_trigger<class_CollisionShape2D_is_trigger>` **(** **)** const |
+------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_collision_object_shape_index<class_CollisionShape2D_get_collision_object_shape_index>` **(** **)** const |
| void | :ref:`set_shape<class_CollisionShape2D_set_shape>` **(** :ref:`Object<class_object>` shape **)** |
+------------------------------+---------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_trigger<class_CollisionShape2D_set_trigger>` **(** :ref:`bool<class_bool>` enable **)** |
+------------------------------+---------------------------------------------------------------------------------------------------------------------+
Description
@@ -38,11 +38,11 @@ Editor-only class. This is not present when running the game. It's used in the e
Member Function Description
---------------------------
.. _class_CollisionShape2D_set_shape:
.. _class_CollisionShape2D_get_collision_object_shape_index:
- void **set_shape** **(** :ref:`Object<class_object>` shape **)**
- :ref:`int<class_int>` **get_collision_object_shape_index** **(** **)** const
Set this shape's :ref:`Shape2D<class_shape2d>`. This will not appear as a node, but can be directly edited as a property.
Return the index of this shape inside its container :ref:`CollisionObject2D<class_collisionobject2d>`. This can be used to directly access the underlying :ref:`Shape2D<class_shape2d>`.
.. _class_CollisionShape2D_get_shape:
@@ -50,22 +50,22 @@ Set this shape's :ref:`Shape2D<class_shape2d>`. This will not appear as a node,
Return this shape's :ref:`Shape2D<class_shape2d>`.
.. _class_CollisionShape2D_set_trigger:
- void **set_trigger** **(** :ref:`bool<class_bool>` enable **)**
Set whether this shape is a trigger. A trigger shape detects collisions, but is otherwise unaffected by physics (i.e. will not block movement of colliding objects).
.. _class_CollisionShape2D_is_trigger:
- :ref:`bool<class_bool>` **is_trigger** **(** **)** const
Return whether this shape is a trigger.
.. _class_CollisionShape2D_get_collision_object_shape_index:
.. _class_CollisionShape2D_set_shape:
- :ref:`int<class_int>` **get_collision_object_shape_index** **(** **)** const
- void **set_shape** **(** :ref:`Object<class_object>` shape **)**
Return the index of this shape inside its container :ref:`CollisionObject2D<class_collisionobject2d>`. This can be used to directly access the underlying :ref:`Shape2D<class_shape2d>`.
Set this shape's :ref:`Shape2D<class_shape2d>`. This will not appear as a node, but can be directly edited as a property.
.. _class_CollisionShape2D_set_trigger:
- void **set_trigger** **(** :ref:`bool<class_bool>` enable **)**
Set whether this shape is a trigger. A trigger shape detects collisions, but is otherwise unaffected by physics (i.e. will not block movement of colliding objects).

78
classes/class_color.rst
View File

@@ -16,6 +16,14 @@ Color in RGBA format.
Member Functions
----------------
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`Color<class_Color_Color>` **(** :ref:`float<class_float>` r, :ref:`float<class_float>` g, :ref:`float<class_float>` b, :ref:`float<class_float>` a **)** |
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`Color<class_Color_Color>` **(** :ref:`float<class_float>` r, :ref:`float<class_float>` g, :ref:`float<class_float>` b **)** |
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`Color<class_Color_Color>` **(** :ref:`int<class_int>` from **)** |
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`Color<class_Color_Color>` **(** :ref:`String<class_string>` from **)** |
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`blend<class_Color_blend>` **(** :ref:`Color<class_color>` over **)** |
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -33,29 +41,21 @@ Member Functions
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`to_html<class_Color_to_html>` **(** :ref:`bool<class_bool>` with_alpha=True **)** |
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`Color<class_Color_Color>` **(** :ref:`float<class_float>` r, :ref:`float<class_float>` g, :ref:`float<class_float>` b, :ref:`float<class_float>` a **)** |
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`Color<class_Color_Color>` **(** :ref:`float<class_float>` r, :ref:`float<class_float>` g, :ref:`float<class_float>` b **)** |
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`Color<class_Color_Color>` **(** :ref:`int<class_int>` from **)** |
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`Color<class_Color_Color>` **(** :ref:`String<class_string>` from **)** |
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Member Variables
----------------
- :ref:`float<class_float>` **r** - Red (0 to 1)
- :ref:`float<class_float>` **g** - Green (0 to 1)
- :ref:`float<class_float>` **b** - Blue (0 to 1)
- :ref:`float<class_float>` **a** - Alpha (0 to 1)
- :ref:`int<class_int>` **a8** - Alpha (0 to 255)
- :ref:`float<class_float>` **b** - Blue (0 to 1)
- :ref:`int<class_int>` **b8** - Blue (0 to 255)
- :ref:`float<class_float>` **g** - Green (0 to 1)
- :ref:`int<class_int>` **g8** - Green (0 to 255)
- :ref:`float<class_float>` **h** - Hue (0 to 1)
- :ref:`float<class_float>` **r** - Red (0 to 1)
- :ref:`int<class_int>` **r8** - Red (0 to 255)
- :ref:`float<class_float>` **s** - Saturation (0 to 1)
- :ref:`float<class_float>` **v** - Value (0 to 1)
- :ref:`int<class_int>` **r8** - Red (0 to 255)
- :ref:`int<class_int>` **g8** - Green (0 to 255)
- :ref:`int<class_int>` **b8** - Blue (0 to 255)
- :ref:`int<class_int>` **a8** - Alpha (0 to 255)
Description
-----------
@@ -65,6 +65,30 @@ A color is represented as red, green and blue (r,g,b) components. Additionally,
Member Function Description
---------------------------
.. _class_Color_Color:
- :ref:`Color<class_color>` **Color** **(** :ref:`float<class_float>` r, :ref:`float<class_float>` g, :ref:`float<class_float>` b, :ref:`float<class_float>` a **)**
Construct the color from an RGBA profile.
.. _class_Color_Color:
- :ref:`Color<class_color>` **Color** **(** :ref:`float<class_float>` r, :ref:`float<class_float>` g, :ref:`float<class_float>` b **)**
Construct the color from an RGBA profile.
.. _class_Color_Color:
- :ref:`Color<class_color>` **Color** **(** :ref:`int<class_int>` from **)**
Construct the color from an RGBA profile.
.. _class_Color_Color:
- :ref:`Color<class_color>` **Color** **(** :ref:`String<class_string>` from **)**
Construct the color from an RGBA profile.
.. _class_Color_blend:
- :ref:`Color<class_color>` **blend** **(** :ref:`Color<class_color>` over **)**
@@ -113,28 +137,4 @@ Convert color to ARGB32, more compatible with DirectX.
Return the HTML hexadecimal color string.
.. _class_Color_Color:
- :ref:`Color<class_color>` **Color** **(** :ref:`float<class_float>` r, :ref:`float<class_float>` g, :ref:`float<class_float>` b, :ref:`float<class_float>` a **)**
Construct the color from an RGBA profile.
.. _class_Color_Color:
- :ref:`Color<class_color>` **Color** **(** :ref:`float<class_float>` r, :ref:`float<class_float>` g, :ref:`float<class_float>` b **)**
Construct the color from an RGBA profile.
.. _class_Color_Color:
- :ref:`Color<class_color>` **Color** **(** :ref:`int<class_int>` from **)**
Construct the color from an RGBA profile.
.. _class_Color_Color:
- :ref:`Color<class_color>` **Color** **(** :ref:`String<class_string>` from **)**
Construct the color from an RGBA profile.

20
classes/class_colorarray.rst
View File

@@ -16,6 +16,8 @@ Array of Colors
Member Functions
----------------
+--------------------------------------+-----------------------------------------------------------------------------------------------------------+
| :ref:`ColorArray<class_colorarray>` | :ref:`ColorArray<class_ColorArray_ColorArray>` **(** :ref:`Array<class_array>` from **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------+
| void | :ref:`push_back<class_ColorArray_push_back>` **(** :ref:`Color<class_color>` color **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------+
@@ -25,8 +27,6 @@ Member Functions
+--------------------------------------+-----------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`size<class_ColorArray_size>` **(** **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------+
| :ref:`ColorArray<class_colorarray>` | :ref:`ColorArray<class_ColorArray_ColorArray>` **(** :ref:`Array<class_array>` from **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------+
Description
-----------
@@ -36,6 +36,12 @@ Array of Color, can only contains colors. Optimized for memory usage, can't frag
Member Function Description
---------------------------
.. _class_ColorArray_ColorArray:
- :ref:`ColorArray<class_colorarray>` **ColorArray** **(** :ref:`Array<class_array>` from **)**
Create from a generic array.
.. _class_ColorArray_push_back:
- void **push_back** **(** :ref:`Color<class_color>` color **)**
@@ -46,13 +52,13 @@ Append a value to the array.
- void **resize** **(** :ref:`int<class_int>` idx **)**
Resize the array.
Set the size of the :ref:`ColorArray<class_colorarray>`. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array.
.. _class_ColorArray_set:
- void **set** **(** :ref:`int<class_int>` idx, :ref:`Color<class_color>` color **)**
Set an index in the array.
Change the :ref:`Color<class_color>` at the given index.
.. _class_ColorArray_size:
@@ -60,10 +66,4 @@ Set an index in the array.
Return the array size.
.. _class_ColorArray_ColorArray:
- :ref:`ColorArray<class_colorarray>` **ColorArray** **(** :ref:`Array<class_array>` from **)**
Create from a generic array.

40
classes/class_colorpicker.rst
View File

@@ -19,19 +19,19 @@ Member Functions
----------------
+----------------------------+----------------------------------------------------------------------------------------------------+
| void | :ref:`set_color<class_ColorPicker_set_color>` **(** :ref:`Color<class_color>` color **)** |
| void | :ref:`add_preset<class_ColorPicker_add_preset>` **(** :ref:`Color<class_color>` arg0 **)** |
+----------------------------+----------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_color<class_ColorPicker_get_color>` **(** **)** const |
+----------------------------+----------------------------------------------------------------------------------------------------+
| void | :ref:`set_raw_mode<class_ColorPicker_set_raw_mode>` **(** :ref:`bool<class_bool>` mode **)** |
| :ref:`bool<class_bool>` | :ref:`is_editing_alpha<class_ColorPicker_is_editing_alpha>` **(** **)** const |
+----------------------------+----------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_raw_mode<class_ColorPicker_is_raw_mode>` **(** **)** const |
+----------------------------+----------------------------------------------------------------------------------------------------+
| void | :ref:`set_color<class_ColorPicker_set_color>` **(** :ref:`Color<class_color>` color **)** |
+----------------------------+----------------------------------------------------------------------------------------------------+
| void | :ref:`set_edit_alpha<class_ColorPicker_set_edit_alpha>` **(** :ref:`bool<class_bool>` show **)** |
+----------------------------+----------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_editing_alpha<class_ColorPicker_is_editing_alpha>` **(** **)** const |
+----------------------------+----------------------------------------------------------------------------------------------------+
| void | :ref:`add_preset<class_ColorPicker_add_preset>` **(** :ref:`Color<class_color>` arg0 **)** |
| void | :ref:`set_raw_mode<class_ColorPicker_set_raw_mode>` **(** :ref:`bool<class_bool>` mode **)** |
+----------------------------+----------------------------------------------------------------------------------------------------+
Signals
@@ -47,11 +47,11 @@ This is a simple color picker :ref:`Control<class_control>`. It's useful for sel
Member Function Description
---------------------------
.. _class_ColorPicker_set_color:
.. _class_ColorPicker_add_preset:
- void **set_color** **(** :ref:`Color<class_color>` color **)**
- void **add_preset** **(** :ref:`Color<class_color>` arg0 **)**
Select the current color.
Adds the current selected to color to a list of colors (presets), the presets will be displayed in the color picker and the user will be able to select them, notice that the presets list is only for this color picker.
.. _class_ColorPicker_get_color:
@@ -59,11 +59,11 @@ Select the current color.
Return the current (edited) color.
.. _class_ColorPicker_set_raw_mode:
.. _class_ColorPicker_is_editing_alpha:
- void **set_raw_mode** **(** :ref:`bool<class_bool>` mode **)**
- :ref:`bool<class_bool>` **is_editing_alpha** **(** **)** const
When set to true, every color channel will be represented as a value from 0 to 1, insetead of 0, 255.
Returns whether the color has transparency or not.
.. _class_ColorPicker_is_raw_mode:
@@ -71,22 +71,22 @@ When set to true, every color channel will be represented as a value from 0 to 1
Returns whether this color picker is in raw mode or not
.. _class_ColorPicker_set_color:
- void **set_color** **(** :ref:`Color<class_color>` color **)**
Select the current color.
.. _class_ColorPicker_set_edit_alpha:
- void **set_edit_alpha** **(** :ref:`bool<class_bool>` show **)**
Set true if you want the color to have an alpha channel (transparency), or false if you want a solid color.
.. _class_ColorPicker_is_editing_alpha:
.. _class_ColorPicker_set_raw_mode:
- :ref:`bool<class_bool>` **is_editing_alpha** **(** **)** const
- void **set_raw_mode** **(** :ref:`bool<class_bool>` mode **)**
Returns whether the color has transparency or not.
.. _class_ColorPicker_add_preset:
- void **add_preset** **(** :ref:`Color<class_color>` arg0 **)**
Adds the current selected to color to a list of colors (presets), the presets will be displayed in the color picker and the user will be able to select them, notice that the presets list is only for this color picker.
When set to true, every color channel will be represented as a value from 0 to 1, insetead of 0, 255.

44
classes/class_colorpickerbutton.rst
View File

@@ -18,15 +18,17 @@ Button that pops out a :ref:`ColorPicker<class_colorpicker>`
Member Functions
----------------
+----------------------------+----------------------------------------------------------------------------------------------------------+
| void | :ref:`set_color<class_ColorPickerButton_set_color>` **(** :ref:`Color<class_color>` color **)** |
+----------------------------+----------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_color<class_ColorPickerButton_get_color>` **(** **)** const |
+----------------------------+----------------------------------------------------------------------------------------------------------+
| void | :ref:`set_edit_alpha<class_ColorPickerButton_set_edit_alpha>` **(** :ref:`bool<class_bool>` show **)** |
+----------------------------+----------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_editing_alpha<class_ColorPickerButton_is_editing_alpha>` **(** **)** const |
+----------------------------+----------------------------------------------------------------------------------------------------------+
+----------------------------------------+----------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_color<class_ColorPickerButton_get_color>` **(** **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------+
| :ref:`ColorPicker<class_colorpicker>` | :ref:`get_picker<class_ColorPickerButton_get_picker>` **(** **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_editing_alpha<class_ColorPickerButton_is_editing_alpha>` **(** **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------+
| void | :ref:`set_color<class_ColorPickerButton_set_color>` **(** :ref:`Color<class_color>` color **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------+
| void | :ref:`set_edit_alpha<class_ColorPickerButton_set_edit_alpha>` **(** :ref:`bool<class_bool>` show **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------+
Signals
-------
@@ -41,23 +43,15 @@ Encapsulates a :ref:`ColorPicker<class_colorpicker>` making it accesible by pres
Member Function Description
---------------------------
.. _class_ColorPickerButton_set_color:
- void **set_color** **(** :ref:`Color<class_color>` color **)**
Sets the current color
.. _class_ColorPickerButton_get_color:
- :ref:`Color<class_color>` **get_color** **(** **)** const
Gets the current color
.. _class_ColorPickerButton_set_edit_alpha:
.. _class_ColorPickerButton_get_picker:
- void **set_edit_alpha** **(** :ref:`bool<class_bool>` show **)**
See :ref:`ColorPicker.set_edit_alpha<class_ColorPicker_set_edit_alpha>`
- :ref:`ColorPicker<class_colorpicker>` **get_picker** **(** **)**
.. _class_ColorPickerButton_is_editing_alpha:
@@ -65,4 +59,16 @@ See :ref:`ColorPicker.set_edit_alpha<class_ColorPicker_set_edit_alpha>`
See :ref:`ColorPicker.is_edit_alpha<class_ColorPicker_is_edit_alpha>`
.. _class_ColorPickerButton_set_color:
- void **set_color** **(** :ref:`Color<class_color>` color **)**
Sets the current color
.. _class_ColorPickerButton_set_edit_alpha:
- void **set_edit_alpha** **(** :ref:`bool<class_bool>` show **)**
See :ref:`ColorPicker.set_edit_alpha<class_ColorPicker_set_edit_alpha>`

128
classes/class_colorramp.rst
View File

@@ -21,27 +21,27 @@ Member Functions
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_point<class_ColorRamp_add_point>` **(** :ref:`float<class_float>` offset, :ref:`Color<class_color>` color **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_point<class_ColorRamp_remove_point>` **(** :ref:`int<class_int>` offset **)** |
| :ref:`Color<class_color>` | :ref:`get_color<class_ColorRamp_get_color>` **(** :ref:`int<class_int>` point **)** const |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_offset<class_ColorRamp_set_offset>` **(** :ref:`int<class_int>` point, :ref:`float<class_float>` offset **)** |
| :ref:`ColorArray<class_colorarray>` | :ref:`get_colors<class_ColorRamp_get_colors>` **(** **)** const |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_offset<class_ColorRamp_get_offset>` **(** :ref:`int<class_int>` point **)** const |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_color<class_ColorRamp_set_color>` **(** :ref:`int<class_int>` point, :ref:`Color<class_color>` color **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_color<class_ColorRamp_get_color>` **(** :ref:`int<class_int>` point **)** const |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`interpolate<class_ColorRamp_interpolate>` **(** :ref:`float<class_float>` offset **)** |
| :ref:`RealArray<class_realarray>` | :ref:`get_offsets<class_ColorRamp_get_offsets>` **(** **)** const |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_point_count<class_ColorRamp_get_point_count>` **(** **)** const |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_offsets<class_ColorRamp_set_offsets>` **(** :ref:`RealArray<class_realarray>` offsets **)** |
| :ref:`Color<class_color>` | :ref:`interpolate<class_ColorRamp_interpolate>` **(** :ref:`float<class_float>` offset **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`RealArray<class_realarray>` | :ref:`get_offsets<class_ColorRamp_get_offsets>` **(** **)** const |
| void | :ref:`remove_point<class_ColorRamp_remove_point>` **(** :ref:`int<class_int>` offset **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_color<class_ColorRamp_set_color>` **(** :ref:`int<class_int>` point, :ref:`Color<class_color>` color **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_colors<class_ColorRamp_set_colors>` **(** :ref:`ColorArray<class_colorarray>` colors **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`ColorArray<class_colorarray>` | :ref:`get_colors<class_ColorRamp_get_colors>` **(** **)** const |
| void | :ref:`set_offset<class_ColorRamp_set_offset>` **(** :ref:`int<class_int>` point, :ref:`float<class_float>` offset **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_offsets<class_ColorRamp_set_offsets>` **(** :ref:`RealArray<class_realarray>` offsets **)** |
+--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
Description
@@ -58,70 +58,70 @@ Member Function Description
Adds the specified color to the end of the ramp, with the specified offset
.. _class_ColorRamp_remove_point:
- void **remove_point** **(** :ref:`int<class_int>` offset **)**
Removes the color at the index *offset*
.. _class_ColorRamp_set_offset:
- void **set_offset** **(** :ref:`int<class_int>` point, :ref:`float<class_float>` offset **)**
Sets the offset for the ramp color at index *point*
.. _class_ColorRamp_get_offset:
- :ref:`float<class_float>` **get_offset** **(** :ref:`int<class_int>` point **)** const
Returns the offset of the ramp color at index *point*
.. _class_ColorRamp_set_color:
- void **set_color** **(** :ref:`int<class_int>` point, :ref:`Color<class_color>` color **)**
Sets the color of the ramp color at index *point*
.. _class_ColorRamp_get_color:
- :ref:`Color<class_color>` **get_color** **(** :ref:`int<class_int>` point **)** const
Returns the color of the ramp color at index *point*
.. _class_ColorRamp_interpolate:
- :ref:`Color<class_color>` **interpolate** **(** :ref:`float<class_float>` offset **)**
Returns the interpolated color specified by *offset*
.. _class_ColorRamp_get_point_count:
- :ref:`int<class_int>` **get_point_count** **(** **)** const
Returns the number of colors in the ramp
.. _class_ColorRamp_set_offsets:
- void **set_offsets** **(** :ref:`RealArray<class_realarray>` offsets **)**
Sets the offset for the specified amount of elements. Calling this function with a different number of elements than previously defined causes the ramp to resize its colors and offsets array to accomodate the new elements, all new colors will be black by default.
.. _class_ColorRamp_get_offsets:
- :ref:`RealArray<class_realarray>` **get_offsets** **(** **)** const
Returns the offsets for the colors in this ramp
.. _class_ColorRamp_set_colors:
- void **set_colors** **(** :ref:`ColorArray<class_colorarray>` colors **)**
Sets the colors for the specified amount of elements. Calling this function with a different number of elements than previously defined causes the ramp to resize its colors and offsets array to accomodate the new elements.
.. _class_ColorRamp_get_colors:
- :ref:`ColorArray<class_colorarray>` **get_colors** **(** **)** const
Returns the colors in the ramp
.. _class_ColorRamp_get_offset:
- :ref:`float<class_float>` **get_offset** **(** :ref:`int<class_int>` point **)** const
Returns the offset of the ramp color at index *point*
.. _class_ColorRamp_get_offsets:
- :ref:`RealArray<class_realarray>` **get_offsets** **(** **)** const
Returns the offsets for the colors in this ramp
.. _class_ColorRamp_get_point_count:
- :ref:`int<class_int>` **get_point_count** **(** **)** const
Returns the number of colors in the ramp
.. _class_ColorRamp_interpolate:
- :ref:`Color<class_color>` **interpolate** **(** :ref:`float<class_float>` offset **)**
Returns the interpolated color specified by *offset*
.. _class_ColorRamp_remove_point:
- void **remove_point** **(** :ref:`int<class_int>` offset **)**
Removes the color at the index *offset*
.. _class_ColorRamp_set_color:
- void **set_color** **(** :ref:`int<class_int>` point, :ref:`Color<class_color>` color **)**
Sets the color of the ramp color at index *point*
.. _class_ColorRamp_set_colors:
- void **set_colors** **(** :ref:`ColorArray<class_colorarray>` colors **)**
Sets the colors for the specified amount of elements. Calling this function with a different number of elements than previously defined causes the ramp to resize its colors and offsets array to accomodate the new elements.
.. _class_ColorRamp_set_offset:
- void **set_offset** **(** :ref:`int<class_int>` point, :ref:`float<class_float>` offset **)**
Sets the offset for the ramp color at index *point*
.. _class_ColorRamp_set_offsets:
- void **set_offsets** **(** :ref:`RealArray<class_realarray>` offsets **)**
Sets the offset for the specified amount of elements. Calling this function with a different number of elements than previously defined causes the ramp to resize its colors and offsets array to accomodate the new elements, all new colors will be black by default.

16
classes/class_concavepolygonshape.rst
View File

@@ -18,11 +18,11 @@ Concave polygon shape.
Member Functions
----------------
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_faces<class_ConcavePolygonShape_set_faces>` **(** :ref:`Vector3Array<class_vector3array>` faces **)** |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3Array<class_vector3array>` | :ref:`get_faces<class_ConcavePolygonShape_get_faces>` **(** **)** const |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_faces<class_ConcavePolygonShape_set_faces>` **(** :ref:`Vector3Array<class_vector3array>` faces **)** |
+------------------------------------------+-------------------------------------------------------------------------------------------------------------------+
Description
-----------
@@ -32,16 +32,16 @@ Concave polygon shape resource, which can be set into a :ref:`PhysicsBody<class_
Member Function Description
---------------------------
.. _class_ConcavePolygonShape_set_faces:
- void **set_faces** **(** :ref:`Vector3Array<class_vector3array>` faces **)**
Set the faces (an array of triangles).
.. _class_ConcavePolygonShape_get_faces:
- :ref:`Vector3Array<class_vector3array>` **get_faces** **(** **)** const
Return the faces (an array of triangles).
.. _class_ConcavePolygonShape_set_faces:
- void **set_faces** **(** :ref:`Vector3Array<class_vector3array>` faces **)**
Set the faces (an array of triangles).

18
classes/class_concavepolygonshape2d.rst
View File

@@ -18,32 +18,32 @@ Concave polygon 2D shape resource for physics.
Member Functions
----------------
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_segments<class_ConcavePolygonShape2D_set_segments>` **(** :ref:`Vector2Array<class_vector2array>` segments **)** |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2Array<class_vector2array>` | :ref:`get_segments<class_ConcavePolygonShape2D_get_segments>` **(** **)** const |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_segments<class_ConcavePolygonShape2D_set_segments>` **(** :ref:`Vector2Array<class_vector2array>` segments **)** |
+------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+
Description
-----------
Concave polygon 2D shape resource for physics. It is made out of segments and is very optimal for complex polygonal concave collisions. It is really not advised to use for RigidBody nodes. A CollisionPolygon2D in convex decomposition mode (solids) or several convex objects are advised for that instead. Otherwise, a concave polygon 2D shape is better for static collisions.
Concave polygon 2D shape resource for physics. It is made out of segments and is very optimal for complex polygonal concave collisions. It is really not advised to use for :ref:`RigidBody2D<class_rigidbody2d>` nodes. A CollisionPolygon2D in convex decomposition mode (solids) or several convex objects are advised for that instead. Otherwise, a concave polygon 2D shape is better for static collisions.
The main difference between a :ref:`ConvexPolygonShape2D<class_convexpolygonshape2d>` and a :ref:`ConcavePolygonShape2D<class_concavepolygonshape2d>` is that a concave polygon assumes it is concave and uses a more complex method of collision detection, and a convex one forces itself to be convex in order to speed up collision detection.
Member Function Description
---------------------------
.. _class_ConcavePolygonShape2D_set_segments:
- void **set_segments** **(** :ref:`Vector2Array<class_vector2array>` segments **)**
Set the array of segments.
.. _class_ConcavePolygonShape2D_get_segments:
- :ref:`Vector2Array<class_vector2array>` **get_segments** **(** **)** const
Return the array of segments.
.. _class_ConcavePolygonShape2D_set_segments:
- void **set_segments** **(** :ref:`Vector2Array<class_vector2array>` segments **)**
Set the array of segments.

12
classes/class_conetwistjoint.rst
View File

@@ -18,11 +18,11 @@ Brief Description
Member Functions
----------------
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_param<class_ConeTwistJoint_set_param>` **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_param<class_ConeTwistJoint_get_param>` **(** :ref:`int<class_int>` param **)** const |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_param<class_ConeTwistJoint_set_param>` **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------+
Numeric Constants
-----------------
@@ -37,12 +37,12 @@ Numeric Constants
Member Function Description
---------------------------
.. _class_ConeTwistJoint_set_param:
- void **set_param** **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)**
.. _class_ConeTwistJoint_get_param:
- :ref:`float<class_float>` **get_param** **(** :ref:`int<class_int>` param **)** const
.. _class_ConeTwistJoint_set_param:
- void **set_param** **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)**

40
classes/class_configfile.rst
View File

@@ -19,7 +19,9 @@ Member Functions
----------------
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_value<class_ConfigFile_set_value>` **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key, var value **)** |
| :ref:`StringArray<class_stringarray>` | :ref:`get_section_keys<class_ConfigFile_get_section_keys>` **(** :ref:`String<class_string>` section **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`StringArray<class_stringarray>` | :ref:`get_sections<class_ConfigFile_get_sections>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| Variant | :ref:`get_value<class_ConfigFile_get_value>` **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key, var default=NULL **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -27,14 +29,12 @@ Member Functions
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_section_key<class_ConfigFile_has_section_key>` **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`StringArray<class_stringarray>` | :ref:`get_sections<class_ConfigFile_get_sections>` **(** **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`StringArray<class_stringarray>` | :ref:`get_section_keys<class_ConfigFile_get_section_keys>` **(** :ref:`String<class_string>` section **)** const |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| Error | :ref:`load<class_ConfigFile_load>` **(** :ref:`String<class_string>` path **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| Error | :ref:`save<class_ConfigFile_save>` **(** :ref:`String<class_string>` path **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_value<class_ConfigFile_set_value>` **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key, var value **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
Description
-----------
@@ -59,11 +59,17 @@ The following example shows how to parse a INI-style file from the system, read
Member Function Description
---------------------------
.. _class_ConfigFile_set_value:
.. _class_ConfigFile_get_section_keys:
- void **set_value** **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key, var value **)**
- :ref:`StringArray<class_stringarray>` **get_section_keys** **(** :ref:`String<class_string>` section **)** const
Assign a value to the specified key of the the specified section. If the section and/or the key do not exist, they are created. Passing a ``NULL`` value deletes the specified key if it exists (and deletes the section if it ends up empty once the key has been removed).
Return an array of all defined key identifiers in the specified section.
.. _class_ConfigFile_get_sections:
- :ref:`StringArray<class_stringarray>` **get_sections** **(** **)** const
Return an array of all defined section identifiers.
.. _class_ConfigFile_get_value:
@@ -83,18 +89,6 @@ Check if the specified section exists.
Check if the specified section-key pair exists.
.. _class_ConfigFile_get_sections:
- :ref:`StringArray<class_stringarray>` **get_sections** **(** **)** const
Return an array of all defined section identifiers.
.. _class_ConfigFile_get_section_keys:
- :ref:`StringArray<class_stringarray>` **get_section_keys** **(** :ref:`String<class_string>` section **)** const
Return an array of all defined key identifiers in the specified section.
.. _class_ConfigFile_load:
- Error **load** **(** :ref:`String<class_string>` path **)**
@@ -109,4 +103,10 @@ Save the contents of the ConfigFile object to the file specified as a parameter.
The return value is one of the OK, FAILED or ERR\_\* constants listed in :ref:`@Global Scope<class_@global scope>` (if the save was successful, it returns OK).
.. _class_ConfigFile_set_value:
- void **set_value** **(** :ref:`String<class_string>` section, :ref:`String<class_string>` key, var value **)**
Assign a value to the specified key of the the specified section. If the section and/or the key do not exist, they are created. Passing a ``NULL`` value deletes the specified key if it exists (and deletes the section if it ends up empty once the key has been removed).

16
classes/class_container.rst
View File

@@ -20,11 +20,11 @@ Base node for containers.
Member Functions
----------------
+-------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`queue_sort<class_Container_queue_sort>` **(** **)** |
+-------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`fit_child_in_rect<class_Container_fit_child_in_rect>` **(** :ref:`Control<class_control>` child, :ref:`Rect2<class_rect2>` rect **)** |
+-------+-----------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`queue_sort<class_Container_queue_sort>` **(** **)** |
+-------+-----------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
@@ -46,16 +46,16 @@ A Control can inherit this to create custom container classes.
Member Function Description
---------------------------
.. _class_Container_queue_sort:
- void **queue_sort** **(** **)**
Queue resort of the contained children. This is called automatically anyway, but can be called upon request.
.. _class_Container_fit_child_in_rect:
- void **fit_child_in_rect** **(** :ref:`Control<class_control>` child, :ref:`Rect2<class_rect2>` rect **)**
Fit a child control in a given rect. This is mainly a helper for creating custom container classes.
.. _class_Container_queue_sort:
- void **queue_sort** **(** **)**
Queue resort of the contained children. This is called automatically anyway, but can be called upon request.

906
classes/class_control.rst
View File

File diff suppressed because it is too large Load Diff

12
classes/class_convexpolygonshape.rst
View File

@@ -18,11 +18,11 @@ Convex Polygon Shape.
Member Functions
----------------
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_points<class_ConvexPolygonShape_set_points>` **(** :ref:`Vector3Array<class_vector3array>` points **)** |
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3Array<class_vector3array>` | :ref:`get_points<class_ConvexPolygonShape_get_points>` **(** **)** const |
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_points<class_ConvexPolygonShape_set_points>` **(** :ref:`Vector3Array<class_vector3array>` points **)** |
+------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
Description
-----------
@@ -32,12 +32,12 @@ Convex polygon shape resource, which can be set into a :ref:`PhysicsBody<class_p
Member Function Description
---------------------------
.. _class_ConvexPolygonShape_set_points:
- void **set_points** **(** :ref:`Vector3Array<class_vector3array>` points **)**
.. _class_ConvexPolygonShape_get_points:
- :ref:`Vector3Array<class_vector3array>` **get_points** **(** **)** const
.. _class_ConvexPolygonShape_set_points:
- void **set_points** **(** :ref:`Vector3Array<class_vector3array>` points **)**

16
classes/class_convexpolygonshape2d.rst
View File

@@ -18,13 +18,13 @@ Convex Polygon Shape for 2D physics.
Member Functions
----------------
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2Array<class_vector2array>` | :ref:`get_points<class_ConvexPolygonShape2D_get_points>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_cloud<class_ConvexPolygonShape2D_set_point_cloud>` **(** :ref:`Vector2Array<class_vector2array>` point_cloud **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_points<class_ConvexPolygonShape2D_set_points>` **(** :ref:`Vector2Array<class_vector2array>` points **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2Array<class_vector2array>` | :ref:`get_points<class_ConvexPolygonShape2D_get_points>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
Description
-----------
@@ -36,6 +36,12 @@ The main difference between a :ref:`ConvexPolygonShape2D<class_convexpolygonshap
Member Function Description
---------------------------
.. _class_ConvexPolygonShape2D_get_points:
- :ref:`Vector2Array<class_vector2array>` **get_points** **(** **)** const
Return a list of points in either clockwise or counter clockwise order, forming a convex polygon.
.. _class_ConvexPolygonShape2D_set_point_cloud:
- void **set_point_cloud** **(** :ref:`Vector2Array<class_vector2array>` point_cloud **)**
@@ -48,10 +54,4 @@ Currently, this method does nothing.
Set a list of points in either clockwise or counter clockwise order, forming a convex polygon.
.. _class_ConvexPolygonShape2D_get_points:
- :ref:`Vector2Array<class_vector2array>` **get_points** **(** **)** const
Return a list of points in either clockwise or counter clockwise order, forming a convex polygon.

102
classes/class_cubemap.rst
View File

@@ -19,91 +19,91 @@ Member Functions
----------------
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_width<class_CubeMap_get_width>` **(** **)** const |
| :ref:`int<class_int>` | :ref:`get_flags<class_CubeMap_get_flags>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_height<class_CubeMap_get_height>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_lossy_storage_quality<class_CubeMap_get_lossy_storage_quality>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_rid>` | :ref:`get_rid<class_CubeMap_get_rid>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_flags<class_CubeMap_set_flags>` **(** :ref:`int<class_int>` flags **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_flags<class_CubeMap_get_flags>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_side<class_CubeMap_set_side>` **(** :ref:`int<class_int>` side, :ref:`Image<class_image>` image **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`Image<class_image>` | :ref:`get_side<class_CubeMap_get_side>` **(** :ref:`int<class_int>` side **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_storage<class_CubeMap_set_storage>` **(** :ref:`int<class_int>` mode **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_storage<class_CubeMap_get_storage>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_width<class_CubeMap_get_width>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_flags<class_CubeMap_set_flags>` **(** :ref:`int<class_int>` flags **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_lossy_storage_quality<class_CubeMap_set_lossy_storage_quality>` **(** :ref:`float<class_float>` quality **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_lossy_storage_quality<class_CubeMap_get_lossy_storage_quality>` **(** **)** const |
| void | :ref:`set_side<class_CubeMap_set_side>` **(** :ref:`int<class_int>` side, :ref:`Image<class_image>` image **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_storage<class_CubeMap_set_storage>` **(** :ref:`int<class_int>` mode **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------+
Numeric Constants
-----------------
- **STORAGE_RAW** = **0**
- **STORAGE_COMPRESS_LOSSY** = **1**
- **STORAGE_COMPRESS_LOSSLESS** = **2**
- **FLAG_MIPMAPS** = **1**
- **FLAG_REPEAT** = **2**
- **FLAG_FILTER** = **4**
- **FLAGS_DEFAULT** = **7**
- **SIDE_LEFT** = **0**
- **SIDE_RIGHT** = **1**
- **SIDE_BOTTOM** = **2**
- **SIDE_TOP** = **3**
- **SIDE_FRONT** = **4**
- **SIDE_BACK** = **5**
- **FLAG_MIPMAPS** = **1**
- **FLAG_REPEAT** = **2**
- **FLAG_FILTER** = **4**
- **FLAGS_DEFAULT** = **7**
- **STORAGE_RAW** = **0**
- **STORAGE_COMPRESS_LOSSY** = **1**
- **STORAGE_COMPRESS_LOSSLESS** = **2**
Member Function Description
---------------------------
.. _class_CubeMap_get_width:
- :ref:`int<class_int>` **get_width** **(** **)** const
.. _class_CubeMap_get_height:
- :ref:`int<class_int>` **get_height** **(** **)** const
.. _class_CubeMap_get_rid:
- :ref:`RID<class_rid>` **get_rid** **(** **)** const
.. _class_CubeMap_set_flags:
- void **set_flags** **(** :ref:`int<class_int>` flags **)**
.. _class_CubeMap_get_flags:
- :ref:`int<class_int>` **get_flags** **(** **)** const
.. _class_CubeMap_set_side:
.. _class_CubeMap_get_height:
- void **set_side** **(** :ref:`int<class_int>` side, :ref:`Image<class_image>` image **)**
.. _class_CubeMap_get_side:
- :ref:`Image<class_image>` **get_side** **(** :ref:`int<class_int>` side **)** const
.. _class_CubeMap_set_storage:
- void **set_storage** **(** :ref:`int<class_int>` mode **)**
.. _class_CubeMap_get_storage:
- :ref:`int<class_int>` **get_storage** **(** **)** const
.. _class_CubeMap_set_lossy_storage_quality:
- void **set_lossy_storage_quality** **(** :ref:`float<class_float>` quality **)**
- :ref:`int<class_int>` **get_height** **(** **)** const
.. _class_CubeMap_get_lossy_storage_quality:
- :ref:`float<class_float>` **get_lossy_storage_quality** **(** **)** const
.. _class_CubeMap_get_rid:
- :ref:`RID<class_rid>` **get_rid** **(** **)** const
.. _class_CubeMap_get_side:
- :ref:`Image<class_image>` **get_side** **(** :ref:`int<class_int>` side **)** const
.. _class_CubeMap_get_storage:
- :ref:`int<class_int>` **get_storage** **(** **)** const
.. _class_CubeMap_get_width:
- :ref:`int<class_int>` **get_width** **(** **)** const
.. _class_CubeMap_set_flags:
- void **set_flags** **(** :ref:`int<class_int>` flags **)**
.. _class_CubeMap_set_lossy_storage_quality:
- void **set_lossy_storage_quality** **(** :ref:`float<class_float>` quality **)**
.. _class_CubeMap_set_side:
- void **set_side** **(** :ref:`int<class_int>` side, :ref:`Image<class_image>` image **)**
.. _class_CubeMap_set_storage:
- void **set_storage** **(** :ref:`int<class_int>` mode **)**

188
classes/class_curve2d.rst
View File

@@ -18,38 +18,38 @@ Describes a Bezier curve in 2D space.
Member Functions
----------------
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_point_count<class_Curve2D_get_point_count>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_point<class_Curve2D_add_point>` **(** :ref:`Vector2<class_vector2>` pos, :ref:`Vector2<class_vector2>` in=Vector2(0,0), :ref:`Vector2<class_vector2>` out=Vector2(0,0), :ref:`int<class_int>` atpos=-1 **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_pos<class_Curve2D_set_point_pos>` **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_vector2>` pos **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_point_pos<class_Curve2D_get_point_pos>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_in<class_Curve2D_set_point_in>` **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_vector2>` pos **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_point_in<class_Curve2D_get_point_in>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_out<class_Curve2D_set_point_out>` **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_vector2>` pos **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_point_out<class_Curve2D_get_point_out>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_point<class_Curve2D_remove_point>` **(** :ref:`int<class_int>` idx **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`interpolate<class_Curve2D_interpolate>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` t **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`interpolatef<class_Curve2D_interpolatef>` **(** :ref:`float<class_float>` fofs **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bake_interval<class_Curve2D_set_bake_interval>` **(** :ref:`float<class_float>` distance **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_bake_interval<class_Curve2D_get_bake_interval>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_baked_length<class_Curve2D_get_baked_length>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2Array<class_vector2array>` | :ref:`get_baked_points<class_Curve2D_get_baked_points>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_point_count<class_Curve2D_get_point_count>` **(** **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_point_in<class_Curve2D_get_point_in>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_point_out<class_Curve2D_get_point_out>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_point_pos<class_Curve2D_get_point_pos>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`interpolate<class_Curve2D_interpolate>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` t **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`interpolate_baked<class_Curve2D_interpolate_baked>` **(** :ref:`float<class_float>` offset, :ref:`bool<class_bool>` cubic=false **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2Array<class_vector2array>` | :ref:`get_baked_points<class_Curve2D_get_baked_points>` **(** **)** const |
| :ref:`Vector2<class_vector2>` | :ref:`interpolatef<class_Curve2D_interpolatef>` **(** :ref:`float<class_float>` fofs **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_point<class_Curve2D_remove_point>` **(** :ref:`int<class_int>` idx **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bake_interval<class_Curve2D_set_bake_interval>` **(** :ref:`float<class_float>` distance **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_in<class_Curve2D_set_point_in>` **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_vector2>` pos **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_out<class_Curve2D_set_point_out>` **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_vector2>` pos **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_pos<class_Curve2D_set_point_pos>` **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_vector2>` pos **)** |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2Array<class_vector2array>` | :ref:`tesselate<class_Curve2D_tesselate>` **(** :ref:`int<class_int>` max_stages=5, :ref:`float<class_float>` tolerance_degrees=4 **)** const |
+------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -64,12 +64,6 @@ It keeps a cache of precalculated points along the curve, to speed further calcu
Member Function Description
---------------------------
.. _class_Curve2D_get_point_count:
- :ref:`int<class_int>` **get_point_count** **(** **)** const
Returns the number of points describing the curve.
.. _class_Curve2D_add_point:
- void **add_point** **(** :ref:`Vector2<class_vector2>` pos, :ref:`Vector2<class_vector2>` in=Vector2(0,0), :ref:`Vector2<class_vector2>` out=Vector2(0,0), :ref:`int<class_int>` atpos=-1 **)**
@@ -78,68 +72,6 @@ Adds a point to a curve, at position "pos", with control points "in" and "out".
If "atpos" is given, the point is inserted before the point number "atpos", moving that point (and every point after) after the inserted point. If "atpos" is not given, or is an illegal value (atpos <0 or atpos >= :ref:`get_point_count<class_Curve2D_get_point_count>`), the point will be appended at the end of the point list.
.. _class_Curve2D_set_point_pos:
- void **set_point_pos** **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_vector2>` pos **)**
Sets the position for the vertex "idx". If the index is out of bounds, the function sends an error to the console.
.. _class_Curve2D_get_point_pos:
- :ref:`Vector2<class_vector2>` **get_point_pos** **(** :ref:`int<class_int>` idx **)** const
Returns the position of the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0).
.. _class_Curve2D_set_point_in:
- void **set_point_in** **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_vector2>` pos **)**
Sets the position of the control point leading to the vertex "idx". If the index is out of bounds, the function sends an error to the console.
.. _class_Curve2D_get_point_in:
- :ref:`Vector2<class_vector2>` **get_point_in** **(** :ref:`int<class_int>` idx **)** const
Returns the position of the control point leading to the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0).
.. _class_Curve2D_set_point_out:
- void **set_point_out** **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_vector2>` pos **)**
Sets the position of the control point leading out of the vertex "idx". If the index is out of bounds, the function sends an error to the console.
.. _class_Curve2D_get_point_out:
- :ref:`Vector2<class_vector2>` **get_point_out** **(** :ref:`int<class_int>` idx **)** const
Returns the position of the control point leading out of the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0).
.. _class_Curve2D_remove_point:
- void **remove_point** **(** :ref:`int<class_int>` idx **)**
Deletes the point "idx" from the curve. Sends an error to the console if "idx" is out of bounds.
.. _class_Curve2D_interpolate:
- :ref:`Vector2<class_vector2>` **interpolate** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` t **)** const
Returns the position between the vertex "idx" and the vertex "idx"+1, where "t" controls if the point is the first vertex (t = 0.0), the last vertex (t = 1.0), or in between. Values of "t" outside the range (0.0 >= t <=1) give strange, but predictable results.
If "idx" is out of bounds it is truncated to the first or last vertex, and "t" is ignored. If the curve has no points, the function sends an error to the console, and returns (0, 0).
.. _class_Curve2D_interpolatef:
- :ref:`Vector2<class_vector2>` **interpolatef** **(** :ref:`float<class_float>` fofs **)** const
Returns the position at the vertex "fofs". It calls :ref:`interpolate<class_Curve2D_interpolate>` using the integer part of fofs as "idx", and its fractional part as "t".
.. _class_Curve2D_set_bake_interval:
- void **set_bake_interval** **(** :ref:`float<class_float>` distance **)**
Sets the distance in pixels between two adjacent cached points. Changing it forces the cache to be recomputed the next time a xxx_baked_xxx function is called. The less distance, the more points the cache will have, and the more memory it will consume, so use with care.
.. _class_Curve2D_get_bake_interval:
- :ref:`float<class_float>` **get_bake_interval** **(** **)** const
@@ -152,6 +84,44 @@ Returns the distance between two adjacent cached points.
Returns the total length of the curve, based on the cached points. Given enough density (see :ref:`set_bake_interval<class_Curve2D_set_bake_interval>`), it should be approximate enough.
.. _class_Curve2D_get_baked_points:
- :ref:`Vector2Array<class_vector2array>` **get_baked_points** **(** **)** const
Returns the cache of points as a :ref:`Vector2Array<class_vector2array>`.
.. _class_Curve2D_get_point_count:
- :ref:`int<class_int>` **get_point_count** **(** **)** const
Returns the number of points describing the curve.
.. _class_Curve2D_get_point_in:
- :ref:`Vector2<class_vector2>` **get_point_in** **(** :ref:`int<class_int>` idx **)** const
Returns the position of the control point leading to the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0).
.. _class_Curve2D_get_point_out:
- :ref:`Vector2<class_vector2>` **get_point_out** **(** :ref:`int<class_int>` idx **)** const
Returns the position of the control point leading out of the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0).
.. _class_Curve2D_get_point_pos:
- :ref:`Vector2<class_vector2>` **get_point_pos** **(** :ref:`int<class_int>` idx **)** const
Returns the position of the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0).
.. _class_Curve2D_interpolate:
- :ref:`Vector2<class_vector2>` **interpolate** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` t **)** const
Returns the position between the vertex "idx" and the vertex "idx"+1, where "t" controls if the point is the first vertex (t = 0.0), the last vertex (t = 1.0), or in between. Values of "t" outside the range (0.0 >= t <=1) give strange, but predictable results.
If "idx" is out of bounds it is truncated to the first or last vertex, and "t" is ignored. If the curve has no points, the function sends an error to the console, and returns (0, 0).
.. _class_Curve2D_interpolate_baked:
- :ref:`Vector2<class_vector2>` **interpolate_baked** **(** :ref:`float<class_float>` offset, :ref:`bool<class_bool>` cubic=false **)** const
@@ -162,11 +132,41 @@ To do that, it finds the two cached points where the "offset" lies between, then
Cubic interpolation tends to follow the curves better, but linear is faster (and often, precise enough).
.. _class_Curve2D_get_baked_points:
.. _class_Curve2D_interpolatef:
- :ref:`Vector2Array<class_vector2array>` **get_baked_points** **(** **)** const
- :ref:`Vector2<class_vector2>` **interpolatef** **(** :ref:`float<class_float>` fofs **)** const
Returns the cache of points as a :ref:`Vector2Array<class_vector2array>`.
Returns the position at the vertex "fofs". It calls :ref:`interpolate<class_Curve2D_interpolate>` using the integer part of fofs as "idx", and its fractional part as "t".
.. _class_Curve2D_remove_point:
- void **remove_point** **(** :ref:`int<class_int>` idx **)**
Deletes the point "idx" from the curve. Sends an error to the console if "idx" is out of bounds.
.. _class_Curve2D_set_bake_interval:
- void **set_bake_interval** **(** :ref:`float<class_float>` distance **)**
Sets the distance in pixels between two adjacent cached points. Changing it forces the cache to be recomputed the next time a xxx_baked_xxx function is called. The less distance, the more points the cache will have, and the more memory it will consume, so use with care.
.. _class_Curve2D_set_point_in:
- void **set_point_in** **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_vector2>` pos **)**
Sets the position of the control point leading to the vertex "idx". If the index is out of bounds, the function sends an error to the console.
.. _class_Curve2D_set_point_out:
- void **set_point_out** **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_vector2>` pos **)**
Sets the position of the control point leading out of the vertex "idx". If the index is out of bounds, the function sends an error to the console.
.. _class_Curve2D_set_point_pos:
- void **set_point_pos** **(** :ref:`int<class_int>` idx, :ref:`Vector2<class_vector2>` pos **)**
Sets the position for the vertex "idx". If the index is out of bounds, the function sends an error to the console.
.. _class_Curve2D_tesselate:

240
classes/class_curve3d.rst
View File

@@ -18,45 +18,45 @@ Describes a Bezier curve in 3D space.
Member Functions
----------------
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_point_count<class_Curve3D_get_point_count>` **(** **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_point<class_Curve3D_add_point>` **(** :ref:`Vector3<class_vector3>` pos, :ref:`Vector3<class_vector3>` in=Vector3(0, 0, 0), :ref:`Vector3<class_vector3>` out=Vector3(0, 0, 0), :ref:`int<class_int>` atpos=-1 **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_pos<class_Curve3D_set_point_pos>` **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_vector3>` pos **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_point_pos<class_Curve3D_get_point_pos>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_tilt<class_Curve3D_set_point_tilt>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` tilt **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_point_tilt<class_Curve3D_get_point_tilt>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_in<class_Curve3D_set_point_in>` **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_vector3>` pos **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_point_in<class_Curve3D_get_point_in>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_out<class_Curve3D_set_point_out>` **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_vector3>` pos **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_point_out<class_Curve3D_get_point_out>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_point<class_Curve3D_remove_point>` **(** :ref:`int<class_int>` idx **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`interpolate<class_Curve3D_interpolate>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` t **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`interpolatef<class_Curve3D_interpolatef>` **(** :ref:`float<class_float>` fofs **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bake_interval<class_Curve3D_set_bake_interval>` **(** :ref:`float<class_float>` distance **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_bake_interval<class_Curve3D_get_bake_interval>` **(** **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_baked_length<class_Curve3D_get_baked_length>` **(** **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`interpolate_baked<class_Curve3D_interpolate_baked>` **(** :ref:`float<class_float>` offset, :ref:`bool<class_bool>` cubic=false **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3Array<class_vector3array>` | :ref:`get_baked_points<class_Curve3D_get_baked_points>` **(** **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RealArray<class_realarray>` | :ref:`get_baked_tilts<class_Curve3D_get_baked_tilts>` **(** **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_point_count<class_Curve3D_get_point_count>` **(** **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_point_in<class_Curve3D_get_point_in>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_point_out<class_Curve3D_get_point_out>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_point_pos<class_Curve3D_get_point_pos>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_point_tilt<class_Curve3D_get_point_tilt>` **(** :ref:`int<class_int>` idx **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`interpolate<class_Curve3D_interpolate>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` t **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`interpolate_baked<class_Curve3D_interpolate_baked>` **(** :ref:`float<class_float>` offset, :ref:`bool<class_bool>` cubic=false **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`interpolatef<class_Curve3D_interpolatef>` **(** :ref:`float<class_float>` fofs **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_point<class_Curve3D_remove_point>` **(** :ref:`int<class_int>` idx **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bake_interval<class_Curve3D_set_bake_interval>` **(** :ref:`float<class_float>` distance **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_in<class_Curve3D_set_point_in>` **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_vector3>` pos **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_out<class_Curve3D_set_point_out>` **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_vector3>` pos **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_pos<class_Curve3D_set_point_pos>` **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_vector3>` pos **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_tilt<class_Curve3D_set_point_tilt>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` tilt **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3Array<class_vector3array>` | :ref:`tesselate<class_Curve3D_tesselate>` **(** :ref:`int<class_int>` max_stages=5, :ref:`float<class_float>` tolerance_degrees=4 **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -70,12 +70,6 @@ It keeps a cache of precalculated points along the curve, to speed further calcu
Member Function Description
---------------------------
.. _class_Curve3D_get_point_count:
- :ref:`int<class_int>` **get_point_count** **(** **)** const
Returns the number of points describing the curve.
.. _class_Curve3D_add_point:
- void **add_point** **(** :ref:`Vector3<class_vector3>` pos, :ref:`Vector3<class_vector3>` in=Vector3(0, 0, 0), :ref:`Vector3<class_vector3>` out=Vector3(0, 0, 0), :ref:`int<class_int>` atpos=-1 **)**
@@ -84,82 +78,6 @@ Adds a point to a curve, at position "pos", with control points "in" and "out".
If "atpos" is given, the point is inserted before the point number "atpos", moving that point (and every point after) after the inserted point. If "atpos" is not given, or is an illegal value (atpos <0 or atpos >= :ref:`get_point_count<class_Curve3D_get_point_count>`), the point will be appended at the end of the point list.
.. _class_Curve3D_set_point_pos:
- void **set_point_pos** **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_vector3>` pos **)**
Sets the position for the vertex "idx". If the index is out of bounds, the function sends an error to the console.
.. _class_Curve3D_get_point_pos:
- :ref:`Vector3<class_vector3>` **get_point_pos** **(** :ref:`int<class_int>` idx **)** const
Returns the position of the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0, 0).
.. _class_Curve3D_set_point_tilt:
- void **set_point_tilt** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` tilt **)**
Sets the tilt angle in radians for the point "idx". If the index is out of bounds, the function sends an error to the console.
The tilt controls the rotation along the look-at axis an object traveling the path would have. In the case of a curve controlling a :ref:`PathFollow<class_pathfollow>`, this tilt is an offset over the natural tilt the PathFollow calculates.
.. _class_Curve3D_get_point_tilt:
- :ref:`float<class_float>` **get_point_tilt** **(** :ref:`int<class_int>` idx **)** const
Returns the tilt angle in radians for the point "idx". If the index is out of bounds, the function sends an error to the console, and returns 0.
.. _class_Curve3D_set_point_in:
- void **set_point_in** **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_vector3>` pos **)**
Sets the position of the control point leading to the vertex "idx". If the index is out of bounds, the function sends an error to the console.
.. _class_Curve3D_get_point_in:
- :ref:`Vector3<class_vector3>` **get_point_in** **(** :ref:`int<class_int>` idx **)** const
Returns the position of the control point leading to the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0, 0).
.. _class_Curve3D_set_point_out:
- void **set_point_out** **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_vector3>` pos **)**
Sets the position of the control point leading out of the vertex "idx". If the index is out of bounds, the function sends an error to the console.
.. _class_Curve3D_get_point_out:
- :ref:`Vector3<class_vector3>` **get_point_out** **(** :ref:`int<class_int>` idx **)** const
Returns the position of the control point leading out of the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0, 0).
.. _class_Curve3D_remove_point:
- void **remove_point** **(** :ref:`int<class_int>` idx **)**
Deletes the point "idx" from the curve. Sends an error to the console if "idx" is out of bounds.
.. _class_Curve3D_interpolate:
- :ref:`Vector3<class_vector3>` **interpolate** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` t **)** const
Returns the position between the vertex "idx" and the vertex "idx"+1, where "t" controls if the point is the first vertex (t = 0.0), the last vertex (t = 1.0), or in between. Values of "t" outside the range (0.0 >= t <=1) give strange, but predictable results.
If "idx" is out of bounds it is truncated to the first or last vertex, and "t" is ignored. If the curve has no points, the function sends an error to the console, and returns (0, 0, 0).
.. _class_Curve3D_interpolatef:
- :ref:`Vector3<class_vector3>` **interpolatef** **(** :ref:`float<class_float>` fofs **)** const
Returns the position at the vertex "fofs". It calls :ref:`interpolate<class_Curve3D_interpolate>` using the integer part of fofs as "idx", and its fractional part as "t".
.. _class_Curve3D_set_bake_interval:
- void **set_bake_interval** **(** :ref:`float<class_float>` distance **)**
Sets the distance in 3D units between two adjacent cached points. Changing it forces the cache to be recomputed the next time a xxx_baked_xxx function is called. The less distance, the more points the cache will have, and the more memory it will consume, so use with care.
.. _class_Curve3D_get_bake_interval:
- :ref:`float<class_float>` **get_bake_interval** **(** **)** const
@@ -172,16 +90,6 @@ Returns the distance between two adjacent cached points.
Returns the total length of the curve, based on the cached points. Given enough density (see :ref:`set_bake_interval<class_Curve3D_set_bake_interval>`), it should be approximate enough.
.. _class_Curve3D_interpolate_baked:
- :ref:`Vector3<class_vector3>` **interpolate_baked** **(** :ref:`float<class_float>` offset, :ref:`bool<class_bool>` cubic=false **)** const
Returns a point within the curve at position "offset", where "offset" is measured as a distance in 3D units along the curve.
To do that, it finds the two cached points where the "offset" lies between, then interpolates the values. This interpolation is cubic if "cubic" is set to true, or linear if set to false.
Cubic interpolation tends to follow the curves better, but linear is faster (and often, precise enough).
.. _class_Curve3D_get_baked_points:
- :ref:`Vector3Array<class_vector3array>` **get_baked_points** **(** **)** const
@@ -194,6 +102,98 @@ Returns the cache of points as a :ref:`Vector3Array<class_vector3array>`.
Returns the cache of tilts as a :ref:`RealArray<class_realarray>`.
.. _class_Curve3D_get_point_count:
- :ref:`int<class_int>` **get_point_count** **(** **)** const
Returns the number of points describing the curve.
.. _class_Curve3D_get_point_in:
- :ref:`Vector3<class_vector3>` **get_point_in** **(** :ref:`int<class_int>` idx **)** const
Returns the position of the control point leading to the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0, 0).
.. _class_Curve3D_get_point_out:
- :ref:`Vector3<class_vector3>` **get_point_out** **(** :ref:`int<class_int>` idx **)** const
Returns the position of the control point leading out of the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0, 0).
.. _class_Curve3D_get_point_pos:
- :ref:`Vector3<class_vector3>` **get_point_pos** **(** :ref:`int<class_int>` idx **)** const
Returns the position of the vertex "idx". If the index is out of bounds, the function sends an error to the console, and returns (0, 0, 0).
.. _class_Curve3D_get_point_tilt:
- :ref:`float<class_float>` **get_point_tilt** **(** :ref:`int<class_int>` idx **)** const
Returns the tilt angle in radians for the point "idx". If the index is out of bounds, the function sends an error to the console, and returns 0.
.. _class_Curve3D_interpolate:
- :ref:`Vector3<class_vector3>` **interpolate** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` t **)** const
Returns the position between the vertex "idx" and the vertex "idx"+1, where "t" controls if the point is the first vertex (t = 0.0), the last vertex (t = 1.0), or in between. Values of "t" outside the range (0.0 >= t <=1) give strange, but predictable results.
If "idx" is out of bounds it is truncated to the first or last vertex, and "t" is ignored. If the curve has no points, the function sends an error to the console, and returns (0, 0, 0).
.. _class_Curve3D_interpolate_baked:
- :ref:`Vector3<class_vector3>` **interpolate_baked** **(** :ref:`float<class_float>` offset, :ref:`bool<class_bool>` cubic=false **)** const
Returns a point within the curve at position "offset", where "offset" is measured as a distance in 3D units along the curve.
To do that, it finds the two cached points where the "offset" lies between, then interpolates the values. This interpolation is cubic if "cubic" is set to true, or linear if set to false.
Cubic interpolation tends to follow the curves better, but linear is faster (and often, precise enough).
.. _class_Curve3D_interpolatef:
- :ref:`Vector3<class_vector3>` **interpolatef** **(** :ref:`float<class_float>` fofs **)** const
Returns the position at the vertex "fofs". It calls :ref:`interpolate<class_Curve3D_interpolate>` using the integer part of fofs as "idx", and its fractional part as "t".
.. _class_Curve3D_remove_point:
- void **remove_point** **(** :ref:`int<class_int>` idx **)**
Deletes the point "idx" from the curve. Sends an error to the console if "idx" is out of bounds.
.. _class_Curve3D_set_bake_interval:
- void **set_bake_interval** **(** :ref:`float<class_float>` distance **)**
Sets the distance in 3D units between two adjacent cached points. Changing it forces the cache to be recomputed the next time a xxx_baked_xxx function is called. The less distance, the more points the cache will have, and the more memory it will consume, so use with care.
.. _class_Curve3D_set_point_in:
- void **set_point_in** **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_vector3>` pos **)**
Sets the position of the control point leading to the vertex "idx". If the index is out of bounds, the function sends an error to the console.
.. _class_Curve3D_set_point_out:
- void **set_point_out** **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_vector3>` pos **)**
Sets the position of the control point leading out of the vertex "idx". If the index is out of bounds, the function sends an error to the console.
.. _class_Curve3D_set_point_pos:
- void **set_point_pos** **(** :ref:`int<class_int>` idx, :ref:`Vector3<class_vector3>` pos **)**
Sets the position for the vertex "idx". If the index is out of bounds, the function sends an error to the console.
.. _class_Curve3D_set_point_tilt:
- void **set_point_tilt** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` tilt **)**
Sets the tilt angle in radians for the point "idx". If the index is out of bounds, the function sends an error to the console.
The tilt controls the rotation along the look-at axis an object traveling the path would have. In the case of a curve controlling a :ref:`PathFollow<class_pathfollow>`, this tilt is an offset over the natural tilt the PathFollow calculates.
.. _class_Curve3D_tesselate:
- :ref:`Vector3Array<class_vector3array>` **tesselate** **(** :ref:`int<class_int>` max_stages=5, :ref:`float<class_float>` tolerance_degrees=4 **)** const

48
classes/class_dampedspringjoint2d.rst
View File

@@ -19,21 +19,21 @@ Member Functions
----------------
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_length<class_DampedSpringJoint2D_set_length>` **(** :ref:`float<class_float>` length **)** |
| :ref:`float<class_float>` | :ref:`get_damping<class_DampedSpringJoint2D_get_damping>` **(** **)** const |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_length<class_DampedSpringJoint2D_get_length>` **(** **)** const |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_rest_length<class_DampedSpringJoint2D_set_rest_length>` **(** :ref:`float<class_float>` rest_length **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_rest_length<class_DampedSpringJoint2D_get_rest_length>` **(** **)** const |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_stiffness<class_DampedSpringJoint2D_set_stiffness>` **(** :ref:`float<class_float>` stiffness **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_stiffness<class_DampedSpringJoint2D_get_stiffness>` **(** **)** const |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_damping<class_DampedSpringJoint2D_set_damping>` **(** :ref:`float<class_float>` damping **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_damping<class_DampedSpringJoint2D_get_damping>` **(** **)** const |
| void | :ref:`set_length<class_DampedSpringJoint2D_set_length>` **(** :ref:`float<class_float>` length **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_rest_length<class_DampedSpringJoint2D_set_rest_length>` **(** :ref:`float<class_float>` rest_length **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_stiffness<class_DampedSpringJoint2D_set_stiffness>` **(** :ref:`float<class_float>` stiffness **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------+
Description
@@ -44,11 +44,11 @@ Damped spring constraint for 2D physics. This resembles a spring joint that alwa
Member Function Description
---------------------------
.. _class_DampedSpringJoint2D_set_length:
.. _class_DampedSpringJoint2D_get_damping:
- void **set_length** **(** :ref:`float<class_float>` length **)**
- :ref:`float<class_float>` **get_damping** **(** **)** const
Set the maximum length of the spring joint.
Return the damping ratio of the spring joint. A value of 0 indicates an undamped spring, while 1 causes the system to reach equilibrium as fast as possible (critical damping).
.. _class_DampedSpringJoint2D_get_length:
@@ -56,24 +56,12 @@ Set the maximum length of the spring joint.
Return the maximum length of the spring joint.
.. _class_DampedSpringJoint2D_set_rest_length:
- void **set_rest_length** **(** :ref:`float<class_float>` rest_length **)**
Set the resting length of the spring joint. The joint will always try to go to back this length when pulled apart.
.. _class_DampedSpringJoint2D_get_rest_length:
- :ref:`float<class_float>` **get_rest_length** **(** **)** const
Return the resting length of the spring joint. The joint will always try to go to back this length when pulled apart.
.. _class_DampedSpringJoint2D_set_stiffness:
- void **set_stiffness** **(** :ref:`float<class_float>` stiffness **)**
Set the stiffness of the spring joint. The joint applies a force equal to the stiffness times the distance from its resting length.
.. _class_DampedSpringJoint2D_get_stiffness:
- :ref:`float<class_float>` **get_stiffness** **(** **)** const
@@ -86,10 +74,22 @@ Return the stiffness of the spring joint. The joint applies a force equal to the
Set the damping ratio of the spring joint. A value of 0 indicates an undamped spring, while 1 causes the system to reach equilibrium as fast as possible (critical damping).
.. _class_DampedSpringJoint2D_get_damping:
.. _class_DampedSpringJoint2D_set_length:
- :ref:`float<class_float>` **get_damping** **(** **)** const
- void **set_length** **(** :ref:`float<class_float>` length **)**
Return the damping ratio of the spring joint. A value of 0 indicates an undamped spring, while 1 causes the system to reach equilibrium as fast as possible (critical damping).
Set the maximum length of the spring joint.
.. _class_DampedSpringJoint2D_set_rest_length:
- void **set_rest_length** **(** :ref:`float<class_float>` rest_length **)**
Set the resting length of the spring joint. The joint will always try to go to back this length when pulled apart.
.. _class_DampedSpringJoint2D_set_stiffness:
- void **set_stiffness** **(** :ref:`float<class_float>` stiffness **)**
Set the stiffness of the spring joint. The joint applies a force equal to the stiffness times the distance from its resting length.

12
classes/class_dictionary.rst
View File

@@ -21,11 +21,11 @@ Member Functions
+------------------------------+-----------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`empty<class_Dictionary_empty>` **(** **)** |
+------------------------------+-----------------------------------------------------------------------------------------------+
| void | :ref:`erase<class_Dictionary_erase>` **(** var value **)** |
| void | :ref:`erase<class_Dictionary_erase>` **(** var key **)** |
+------------------------------+-----------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has<class_Dictionary_has>` **(** var value **)** |
| :ref:`bool<class_bool>` | :ref:`has<class_Dictionary_has>` **(** var key **)** |
+------------------------------+-----------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_all<class_Dictionary_has_all>` **(** :ref:`Array<class_array>` values **)** |
| :ref:`bool<class_bool>` | :ref:`has_all<class_Dictionary_has_all>` **(** :ref:`Array<class_array>` keys **)** |
+------------------------------+-----------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`hash<class_Dictionary_hash>` **(** **)** |
+------------------------------+-----------------------------------------------------------------------------------------------+
@@ -60,19 +60,19 @@ Return true if the dictionary is empty.
.. _class_Dictionary_erase:
- void **erase** **(** var value **)**
- void **erase** **(** var key **)**
Erase a dictionary key/value pair by key.
.. _class_Dictionary_has:
- :ref:`bool<class_bool>` **has** **(** var value **)**
- :ref:`bool<class_bool>` **has** **(** var key **)**
Return true if the dictionary has a given key.
.. _class_Dictionary_has_all:
- :ref:`bool<class_bool>` **has_all** **(** :ref:`Array<class_array>` values **)**
- :ref:`bool<class_bool>` **has_all** **(** :ref:`Array<class_array>` keys **)**
.. _class_Dictionary_hash:

30
classes/class_directionallight.rst
View File

@@ -18,26 +18,26 @@ Directional Light, such as the Sun or the Moon.
Member Functions
----------------
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_shadow_mode<class_DirectionalLight_set_shadow_mode>` **(** :ref:`int<class_int>` mode **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_shadow_mode<class_DirectionalLight_get_shadow_mode>` **(** **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_shadow_param<class_DirectionalLight_set_shadow_param>` **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_shadow_param<class_DirectionalLight_get_shadow_param>` **(** :ref:`int<class_int>` param **)** const |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_shadow_mode<class_DirectionalLight_set_shadow_mode>` **(** :ref:`int<class_int>` mode **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_shadow_param<class_DirectionalLight_set_shadow_param>` **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)** |
+----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
Numeric Constants
-----------------
- **SHADOW_ORTHOGONAL** = **0**
- **SHADOW_PERSPECTIVE** = **1**
- **SHADOW_PARALLEL_2_SPLITS** = **2**
- **SHADOW_PARALLEL_4_SPLITS** = **3**
- **SHADOW_PARAM_MAX_DISTANCE** = **0**
- **SHADOW_PARAM_PSSM_SPLIT_WEIGHT** = **1**
- **SHADOW_PERSPECTIVE** = **1**
- **SHADOW_PARALLEL_2_SPLITS** = **2**
- **SHADOW_PARAM_PSSM_ZOFFSET_SCALE** = **2**
- **SHADOW_PARALLEL_4_SPLITS** = **3**
Description
-----------
@@ -47,20 +47,20 @@ A DirectionalLight is a type of :ref:`Light<class_light>` node that emits light
Member Function Description
---------------------------
.. _class_DirectionalLight_set_shadow_mode:
- void **set_shadow_mode** **(** :ref:`int<class_int>` mode **)**
.. _class_DirectionalLight_get_shadow_mode:
- :ref:`int<class_int>` **get_shadow_mode** **(** **)** const
.. _class_DirectionalLight_set_shadow_param:
- void **set_shadow_param** **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)**
.. _class_DirectionalLight_get_shadow_param:
- :ref:`float<class_float>` **get_shadow_param** **(** :ref:`int<class_int>` param **)** const
.. _class_DirectionalLight_set_shadow_mode:
- void **set_shadow_mode** **(** :ref:`int<class_int>` mode **)**
.. _class_DirectionalLight_set_shadow_param:
- void **set_shadow_param** **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)**

176
classes/class_directory.rst
View File

@@ -19,40 +19,40 @@ Member Functions
----------------
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
| Error | :ref:`open<class_Directory_open>` **(** :ref:`String<class_string>` path **)** |
| Error | :ref:`change_dir<class_Directory_change_dir>` **(** :ref:`String<class_string>` todir **)** |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`list_dir_begin<class_Directory_list_dir_begin>` **(** **)** |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_next<class_Directory_get_next>` **(** **)** |
| Error | :ref:`copy<class_Directory_copy>` **(** :ref:`String<class_string>` from, :ref:`String<class_string>` to **)** |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`current_is_dir<class_Directory_current_is_dir>` **(** **)** const |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`list_dir_end<class_Directory_list_dir_end>` **(** **)** |
| :ref:`bool<class_bool>` | :ref:`dir_exists<class_Directory_dir_exists>` **(** :ref:`String<class_string>` path **)** |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_drive_count<class_Directory_get_drive_count>` **(** **)** |
| :ref:`bool<class_bool>` | :ref:`file_exists<class_Directory_file_exists>` **(** :ref:`String<class_string>` path **)** |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_current_dir<class_Directory_get_current_dir>` **(** **)** |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_drive<class_Directory_get_drive>` **(** :ref:`int<class_int>` idx **)** |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
| Error | :ref:`change_dir<class_Directory_change_dir>` **(** :ref:`String<class_string>` todir **)** |
| :ref:`int<class_int>` | :ref:`get_drive_count<class_Directory_get_drive_count>` **(** **)** |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_current_dir<class_Directory_get_current_dir>` **(** **)** |
| :ref:`String<class_string>` | :ref:`get_next<class_Directory_get_next>` **(** **)** |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_space_left<class_Directory_get_space_left>` **(** **)** |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`list_dir_begin<class_Directory_list_dir_begin>` **(** **)** |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`list_dir_end<class_Directory_list_dir_end>` **(** **)** |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
| Error | :ref:`make_dir<class_Directory_make_dir>` **(** :ref:`String<class_string>` path **)** |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
| Error | :ref:`make_dir_recursive<class_Directory_make_dir_recursive>` **(** :ref:`String<class_string>` path **)** |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`file_exists<class_Directory_file_exists>` **(** :ref:`String<class_string>` path **)** |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`dir_exists<class_Directory_dir_exists>` **(** :ref:`String<class_string>` path **)** |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_space_left<class_Directory_get_space_left>` **(** **)** |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
| Error | :ref:`copy<class_Directory_copy>` **(** :ref:`String<class_string>` from, :ref:`String<class_string>` to **)** |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
| Error | :ref:`rename<class_Directory_rename>` **(** :ref:`String<class_string>` from, :ref:`String<class_string>` to **)** |
| Error | :ref:`open<class_Directory_open>` **(** :ref:`String<class_string>` path **)** |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
| Error | :ref:`remove<class_Directory_remove>` **(** :ref:`String<class_string>` path **)** |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
| Error | :ref:`rename<class_Directory_rename>` **(** :ref:`String<class_string>` from, :ref:`String<class_string>` to **)** |
+------------------------------+----------------------------------------------------------------------------------------------------------------------+
Description
-----------
@@ -80,14 +80,70 @@ Here is an example on how to iterate through the files of a directory:
Member Function Description
---------------------------
.. _class_Directory_open:
.. _class_Directory_change_dir:
- Error **open** **(** :ref:`String<class_string>` path **)**
- Error **change_dir** **(** :ref:`String<class_string>` todir **)**
Open an existing directory of the filesystem. The *path* argument can be within the project tree (``res://folder``), the user directory (``user://folder``) or an absolute path of the user filesystem (e.g. ``/tmp/folder`` or ``C:\tmp\folder``).
Change the currently opened directory to the one passed as an argument. The argument can be relative to the current directory (e.g. ``newdir`` or ``../newdir``), or an absolute path (e.g. ``/tmp/newdir`` or ``res://somedir/newdir``).
The method returns one of the error code constants defined in :ref:`@Global Scope<class_@global scope>` (OK or ERR\_\*).
.. _class_Directory_copy:
- Error **copy** **(** :ref:`String<class_string>` from, :ref:`String<class_string>` to **)**
Copy the *from* file to the *to* destination. Both arguments should be paths to files, either relative or absolute. If the destination file exists and is not access-protected, it will be overwritten.
Returns one of the error code constants defined in :ref:`@Global Scope<class_@global scope>` (OK, FAILED or ERR\_\*).
.. _class_Directory_current_is_dir:
- :ref:`bool<class_bool>` **current_is_dir** **(** **)** const
Return whether the current item processed with the last :ref:`get_next<class_Directory_get_next>` call is a directory (``.`` and ``..`` are considered directories).
.. _class_Directory_dir_exists:
- :ref:`bool<class_bool>` **dir_exists** **(** :ref:`String<class_string>` path **)**
Return whether the target directory exists. The argument can be relative to the current directory, or an absolute path.
.. _class_Directory_file_exists:
- :ref:`bool<class_bool>` **file_exists** **(** :ref:`String<class_string>` path **)**
Return whether the target file exists. The argument can be relative to the current directory, or an absolute path.
.. _class_Directory_get_current_dir:
- :ref:`String<class_string>` **get_current_dir** **(** **)**
Return the absolute path to the currently opened directory (e.g. ``res://folder`` or ``C:\tmp\folder``).
.. _class_Directory_get_drive:
- :ref:`String<class_string>` **get_drive** **(** :ref:`int<class_int>` idx **)**
On Windows, return the name of the drive (partition) passed as an argument (e.g. ``C:``). On other platforms, or if the requested drive does not existed, the method returns an empty String.
.. _class_Directory_get_drive_count:
- :ref:`int<class_int>` **get_drive_count** **(** **)**
On Windows, return the number of drives (partitions) mounted on the current filesystem. On other platforms, the method returns 0.
.. _class_Directory_get_next:
- :ref:`String<class_string>` **get_next** **(** **)**
Return the next element (file or directory) in the current directory (including ``.`` and ``..``). The name of the file or directory is returned (and not its full path). Once the stream has been fully processed, the method returns an empty String and closes the stream automatically (i.e. :ref:`list_dir_end<class_Directory_list_dir_end>` would not be mandatory in such a case).
.. _class_Directory_get_space_left:
- :ref:`int<class_int>` **get_space_left** **(** **)**
On Unix desktop systems, return the available space on the current directory's disk. On other platforms, this information is not available and the method returns 0 or -1.
.. _class_Directory_list_dir_begin:
- :ref:`bool<class_bool>` **list_dir_begin** **(** **)**
@@ -96,50 +152,12 @@ Initialise the stream used to list all files and directories using the :ref:`get
Return false if the stream could not be initialised.
.. _class_Directory_get_next:
- :ref:`String<class_string>` **get_next** **(** **)**
Return the next element (file or directory) in the current directory (including ``.`` and ``..``). The name of the file or directory is returned (and not its full path). Once the stream has been fully processed, the method returns an empty String and closes the stream automatically (i.e. :ref:`list_dir_end<class_Directory_list_dir_end>` would not be mandatory in such a case).
.. _class_Directory_current_is_dir:
- :ref:`bool<class_bool>` **current_is_dir** **(** **)** const
Return whether the current item processed with the last :ref:`get_next<class_Directory_get_next>` call is a directory (``.`` and ``..`` are considered directories).
.. _class_Directory_list_dir_end:
- void **list_dir_end** **(** **)**
Close the current stream opened with :ref:`list_dir_begin<class_Directory_list_dir_begin>` (whether it has been fully processed with :ref:`get_next<class_Directory_get_next>` or not does not matter).
.. _class_Directory_get_drive_count:
- :ref:`int<class_int>` **get_drive_count** **(** **)**
On Windows, return the number of drives (partitions) mounted on the current filesystem. On other platforms, the method returns 0.
.. _class_Directory_get_drive:
- :ref:`String<class_string>` **get_drive** **(** :ref:`int<class_int>` idx **)**
On Windows, return the name of the drive (partition) passed as an argument (e.g. ``C:``). On other platforms, or if the requested drive does not existed, the method returns an empty String.
.. _class_Directory_change_dir:
- Error **change_dir** **(** :ref:`String<class_string>` todir **)**
Change the currently opened directory to the one passed as an argument. The argument can be relative to the current directory (e.g. ``newdir`` or ``../newdir``), or an absolute path (e.g. ``/tmp/newdir`` or ``res://somedir/newdir``).
The method returns one of the error code constants defined in :ref:`@Global Scope<class_@global scope>` (OK or ERR\_\*).
.. _class_Directory_get_current_dir:
- :ref:`String<class_string>` **get_current_dir** **(** **)**
Return the absolute path to the currently opened directory (e.g. ``res://folder`` or ``C:\tmp\folder``).
.. _class_Directory_make_dir:
- Error **make_dir** **(** :ref:`String<class_string>` path **)**
@@ -156,39 +174,13 @@ Create a target directory and all necessary intermediate directories in its path
Returns one of the error code constants defined in :ref:`@Global Scope<class_@global scope>` (OK, FAILED or ERR\_\*).
.. _class_Directory_file_exists:
.. _class_Directory_open:
- :ref:`bool<class_bool>` **file_exists** **(** :ref:`String<class_string>` path **)**
- Error **open** **(** :ref:`String<class_string>` path **)**
Return whether the target file exists. The argument can be relative to the current directory, or an absolute path.
Open an existing directory of the filesystem. The *path* argument can be within the project tree (``res://folder``), the user directory (``user://folder``) or an absolute path of the user filesystem (e.g. ``/tmp/folder`` or ``C:\tmp\folder``).
.. _class_Directory_dir_exists:
- :ref:`bool<class_bool>` **dir_exists** **(** :ref:`String<class_string>` path **)**
Return whether the target directory exists. The argument can be relative to the current directory, or an absolute path.
.. _class_Directory_get_space_left:
- :ref:`int<class_int>` **get_space_left** **(** **)**
On Unix desktop systems, return the available space on the current directory's disk. On other platforms, this information is not available and the method returns 0 or -1.
.. _class_Directory_copy:
- Error **copy** **(** :ref:`String<class_string>` from, :ref:`String<class_string>` to **)**
Copy the *from* file to the *to* destination. Both arguments should be paths to files, either relative or absolute. If the destination file exists and is not access-protected, it will be overwritten.
Returns one of the error code constants defined in :ref:`@Global Scope<class_@global scope>` (OK, FAILED or ERR\_\*).
.. _class_Directory_rename:
- Error **rename** **(** :ref:`String<class_string>` from, :ref:`String<class_string>` to **)**
Rename (move) the *from* file to the *to* destination. Both arguments should be paths to files, either relative or absolute. If the destination file exists and is not access-protected, it will be overwritten.
Returns one of the error code constants defined in :ref:`@Global Scope<class_@global scope>` (OK or FAILED).
The method returns one of the error code constants defined in :ref:`@Global Scope<class_@global scope>` (OK or ERR\_\*).
.. _class_Directory_remove:
@@ -198,4 +190,12 @@ Delete the target file or an empty directory. The argument can be relative to th
Returns one of the error code constants defined in :ref:`@Global Scope<class_@global scope>` (OK or FAILED).
.. _class_Directory_rename:
- Error **rename** **(** :ref:`String<class_string>` from, :ref:`String<class_string>` to **)**
Rename (move) the *from* file to the *to* destination. Both arguments should be paths to files, either relative or absolute. If the destination file exists and is not access-protected, it will be overwritten.
Returns one of the error code constants defined in :ref:`@Global Scope<class_@global scope>` (OK or FAILED).

110
classes/class_editorfiledialog.rst
View File

@@ -18,10 +18,12 @@ Brief Description
Member Functions
----------------
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_filter<class_EditorFileDialog_add_filter>` **(** :ref:`String<class_string>` filter **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_filters<class_EditorFileDialog_clear_filters>` **(** **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_filter<class_EditorFileDialog_add_filter>` **(** :ref:`String<class_string>` filter **)** |
| :ref:`int<class_int>` | :ref:`get_access<class_EditorFileDialog_get_access>` **(** **)** const |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_current_dir<class_EditorFileDialog_get_current_dir>` **(** **)** const |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
@@ -29,61 +31,63 @@ Member Functions
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_current_path<class_EditorFileDialog_get_current_path>` **(** **)** const |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_display_mode<class_EditorFileDialog_get_display_mode>` **(** **)** const |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_mode<class_EditorFileDialog_get_mode>` **(** **)** const |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :ref:`VBoxContainer<class_vboxcontainer>` | :ref:`get_vbox<class_EditorFileDialog_get_vbox>` **(** **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`invalidate<class_EditorFileDialog_invalidate>` **(** **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_showing_hidden_files<class_EditorFileDialog_is_showing_hidden_files>` **(** **)** const |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_access<class_EditorFileDialog_set_access>` **(** :ref:`int<class_int>` access **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_current_dir<class_EditorFileDialog_set_current_dir>` **(** :ref:`String<class_string>` dir **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_current_file<class_EditorFileDialog_set_current_file>` **(** :ref:`String<class_string>` file **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_current_path<class_EditorFileDialog_set_current_path>` **(** :ref:`String<class_string>` path **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_mode<class_EditorFileDialog_set_mode>` **(** :ref:`int<class_int>` mode **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_mode<class_EditorFileDialog_get_mode>` **(** **)** const |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :ref:`VBoxContainer<class_vboxcontainer>` | :ref:`get_vbox<class_EditorFileDialog_get_vbox>` **(** **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_access<class_EditorFileDialog_set_access>` **(** :ref:`int<class_int>` access **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_access<class_EditorFileDialog_get_access>` **(** **)** const |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_show_hidden_files<class_EditorFileDialog_set_show_hidden_files>` **(** :ref:`bool<class_bool>` show **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_showing_hidden_files<class_EditorFileDialog_is_showing_hidden_files>` **(** **)** const |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_display_mode<class_EditorFileDialog_set_display_mode>` **(** :ref:`int<class_int>` mode **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_display_mode<class_EditorFileDialog_get_display_mode>` **(** **)** const |
| void | :ref:`set_mode<class_EditorFileDialog_set_mode>` **(** :ref:`int<class_int>` mode **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| void | :ref:`invalidate<class_EditorFileDialog_invalidate>` **(** **)** |
| void | :ref:`set_show_hidden_files<class_EditorFileDialog_set_show_hidden_files>` **(** :ref:`bool<class_bool>` show **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
Signals
-------
- **files_selected** **(** :ref:`StringArray<class_stringarray>` paths **)**
- **dir_selected** **(** :ref:`String<class_string>` dir **)**
- **file_selected** **(** :ref:`String<class_string>` path **)**
- **files_selected** **(** :ref:`StringArray<class_stringarray>` paths **)**
Numeric Constants
-----------------
- **ACCESS_RESOURCES** = **0**
- **ACCESS_USERDATA** = **1**
- **ACCESS_FILESYSTEM** = **2**
- **MODE_OPEN_FILE** = **0**
- **MODE_OPEN_FILES** = **1**
- **MODE_OPEN_DIR** = **2**
- **MODE_SAVE_FILE** = **3**
- **ACCESS_RESOURCES** = **0**
- **ACCESS_USERDATA** = **1**
- **ACCESS_FILESYSTEM** = **2**
Member Function Description
---------------------------
.. _class_EditorFileDialog_add_filter:
- void **add_filter** **(** :ref:`String<class_string>` filter **)**
.. _class_EditorFileDialog_clear_filters:
- void **clear_filters** **(** **)**
.. _class_EditorFileDialog_add_filter:
.. _class_EditorFileDialog_get_access:
- void **add_filter** **(** :ref:`String<class_string>` filter **)**
- :ref:`int<class_int>` **get_access** **(** **)** const
.. _class_EditorFileDialog_get_current_dir:
@@ -97,6 +101,30 @@ Member Function Description
- :ref:`String<class_string>` **get_current_path** **(** **)** const
.. _class_EditorFileDialog_get_display_mode:
- :ref:`int<class_int>` **get_display_mode** **(** **)** const
.. _class_EditorFileDialog_get_mode:
- :ref:`int<class_int>` **get_mode** **(** **)** const
.. _class_EditorFileDialog_get_vbox:
- :ref:`VBoxContainer<class_vboxcontainer>` **get_vbox** **(** **)**
.. _class_EditorFileDialog_invalidate:
- void **invalidate** **(** **)**
.. _class_EditorFileDialog_is_showing_hidden_files:
- :ref:`bool<class_bool>` **is_showing_hidden_files** **(** **)** const
.. _class_EditorFileDialog_set_access:
- void **set_access** **(** :ref:`int<class_int>` access **)**
.. _class_EditorFileDialog_set_current_dir:
- void **set_current_dir** **(** :ref:`String<class_string>` dir **)**
@@ -109,44 +137,16 @@ Member Function Description
- void **set_current_path** **(** :ref:`String<class_string>` path **)**
.. _class_EditorFileDialog_set_display_mode:
- void **set_display_mode** **(** :ref:`int<class_int>` mode **)**
.. _class_EditorFileDialog_set_mode:
- void **set_mode** **(** :ref:`int<class_int>` mode **)**
.. _class_EditorFileDialog_get_mode:
- :ref:`int<class_int>` **get_mode** **(** **)** const
.. _class_EditorFileDialog_get_vbox:
- :ref:`VBoxContainer<class_vboxcontainer>` **get_vbox** **(** **)**
.. _class_EditorFileDialog_set_access:
- void **set_access** **(** :ref:`int<class_int>` access **)**
.. _class_EditorFileDialog_get_access:
- :ref:`int<class_int>` **get_access** **(** **)** const
.. _class_EditorFileDialog_set_show_hidden_files:
- void **set_show_hidden_files** **(** :ref:`bool<class_bool>` show **)**
.. _class_EditorFileDialog_is_showing_hidden_files:
- :ref:`bool<class_bool>` **is_showing_hidden_files** **(** **)** const
.. _class_EditorFileDialog_set_display_mode:
- void **set_display_mode** **(** :ref:`int<class_int>` mode **)**
.. _class_EditorFileDialog_get_display_mode:
- :ref:`int<class_int>` **get_display_mode** **(** **)** const
.. _class_EditorFileDialog_invalidate:
- void **invalidate** **(** **)**

48
classes/class_editorplugin.rst
View File

@@ -18,6 +18,10 @@ Brief Description
Member Functions
----------------
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_custom_control<class_EditorPlugin_add_custom_control>` **(** :ref:`int<class_int>` container, :ref:`Object<class_object>` control **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_custom_type<class_EditorPlugin_add_custom_type>` **(** :ref:`String<class_string>` type, :ref:`String<class_string>` base, :ref:`Script<class_script>` script, :ref:`Texture<class_texture>` icon **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`apply_changes<class_EditorPlugin_apply_changes>` **(** **)** virtual |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -35,22 +39,18 @@ Member Functions
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_dictionary>` | :ref:`get_state<class_EditorPlugin_get_state>` **(** **)** virtual |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>` | :ref:`get_undo_redo<class_EditorPlugin_get_undo_redo>` **(** **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`handles<class_EditorPlugin_handles>` **(** :ref:`Object<class_object>` object **)** virtual |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_main_screen<class_EditorPlugin_has_main_screen>` **(** **)** virtual |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`make_visible<class_EditorPlugin_make_visible>` **(** :ref:`bool<class_bool>` visible **)** virtual |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_state<class_EditorPlugin_set_state>` **(** :ref:`Dictionary<class_dictionary>` state **)** virtual |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>` | :ref:`get_undo_redo<class_EditorPlugin_get_undo_redo>` **(** **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_custom_control<class_EditorPlugin_add_custom_control>` **(** :ref:`int<class_int>` container, :ref:`Object<class_object>` control **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_custom_type<class_EditorPlugin_add_custom_type>` **(** :ref:`String<class_string>` type, :ref:`String<class_string>` base, :ref:`Script<class_script>` script, :ref:`Texture<class_texture>` icon **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_custom_type<class_EditorPlugin_remove_custom_type>` **(** :ref:`String<class_string>` type **)** |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_state<class_EditorPlugin_set_state>` **(** :ref:`Dictionary<class_dictionary>` state **)** virtual |
+----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Numeric Constants
-----------------
@@ -65,6 +65,14 @@ Numeric Constants
Member Function Description
---------------------------
.. _class_EditorPlugin_add_custom_control:
- void **add_custom_control** **(** :ref:`int<class_int>` container, :ref:`Object<class_object>` control **)**
.. _class_EditorPlugin_add_custom_type:
- void **add_custom_type** **(** :ref:`String<class_string>` type, :ref:`String<class_string>` base, :ref:`Script<class_script>` script, :ref:`Texture<class_texture>` icon **)**
.. _class_EditorPlugin_apply_changes:
- void **apply_changes** **(** **)** virtual
@@ -97,6 +105,10 @@ Member Function Description
- :ref:`Dictionary<class_dictionary>` **get_state** **(** **)** virtual
.. _class_EditorPlugin_get_undo_redo:
- :ref:`Object<class_object>` **get_undo_redo** **(** **)**
.. _class_EditorPlugin_handles:
- :ref:`bool<class_bool>` **handles** **(** :ref:`Object<class_object>` object **)** virtual
@@ -109,24 +121,12 @@ Member Function Description
- void **make_visible** **(** :ref:`bool<class_bool>` visible **)** virtual
.. _class_EditorPlugin_set_state:
- void **set_state** **(** :ref:`Dictionary<class_dictionary>` state **)** virtual
.. _class_EditorPlugin_get_undo_redo:
- :ref:`Object<class_object>` **get_undo_redo** **(** **)**
.. _class_EditorPlugin_add_custom_control:
- void **add_custom_control** **(** :ref:`int<class_int>` container, :ref:`Object<class_object>` control **)**
.. _class_EditorPlugin_add_custom_type:
- void **add_custom_type** **(** :ref:`String<class_string>` type, :ref:`String<class_string>` base, :ref:`Script<class_script>` script, :ref:`Texture<class_texture>` icon **)**
.. _class_EditorPlugin_remove_custom_type:
- void **remove_custom_type** **(** :ref:`String<class_string>` type **)**
.. _class_EditorPlugin_set_state:
- void **set_state** **(** :ref:`Dictionary<class_dictionary>` state **)** virtual

136
classes/class_environment.rst
View File

@@ -19,66 +19,48 @@ Member Functions
----------------
+--------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_background<class_Environment_set_background>` **(** :ref:`int<class_int>` bgmode **)** |
+--------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_background<class_Environment_get_background>` **(** **)** const |
+--------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_background_param<class_Environment_set_background_param>` **(** :ref:`int<class_int>` param, var value **)** |
+--------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`get_background_param<class_Environment_get_background_param>` **(** :ref:`int<class_int>` param **)** const |
+--------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_enable_fx<class_Environment_set_enable_fx>` **(** :ref:`int<class_int>` effect, :ref:`bool<class_bool>` enabled **)** |
+--------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_fx_enabled<class_Environment_is_fx_enabled>` **(** :ref:`int<class_int>` effect **)** const |
| void | :ref:`fx_get_param<class_Environment_fx_get_param>` **(** :ref:`int<class_int>` param **)** const |
+--------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`fx_set_param<class_Environment_fx_set_param>` **(** :ref:`int<class_int>` param, var value **)** |
+--------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`fx_get_param<class_Environment_fx_get_param>` **(** :ref:`int<class_int>` param **)** const |
| :ref:`int<class_int>` | :ref:`get_background<class_Environment_get_background>` **(** **)** const |
+--------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`get_background_param<class_Environment_get_background_param>` **(** :ref:`int<class_int>` param **)** const |
+--------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_fx_enabled<class_Environment_is_fx_enabled>` **(** :ref:`int<class_int>` effect **)** const |
+--------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_background<class_Environment_set_background>` **(** :ref:`int<class_int>` bgmode **)** |
+--------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_background_param<class_Environment_set_background_param>` **(** :ref:`int<class_int>` param, var value **)** |
+--------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_enable_fx<class_Environment_set_enable_fx>` **(** :ref:`int<class_int>` effect, :ref:`bool<class_bool>` enabled **)** |
+--------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
Numeric Constants
-----------------
- **BG_KEEP** = **0**
- **BG_DEFAULT_COLOR** = **1**
- **BG_COLOR** = **2**
- **BG_TEXTURE** = **3**
- **BG_CUBEMAP** = **4**
- **BG_CANVAS** = **5**
- **BG_MAX** = **6**
- **BG_PARAM_CANVAS_MAX_LAYER** = **0**
- **BG_DEFAULT_COLOR** = **1**
- **BG_PARAM_COLOR** = **1**
- **BG_COLOR** = **2**
- **BG_PARAM_TEXTURE** = **2**
- **BG_PARAM_CUBEMAP** = **3**
- **BG_TEXTURE** = **3**
- **BG_CUBEMAP** = **4**
- **BG_PARAM_ENERGY** = **4**
- **BG_CANVAS** = **5**
- **BG_MAX** = **6**
- **BG_PARAM_GLOW** = **6**
- **BG_PARAM_MAX** = **7**
- **FX_AMBIENT_LIGHT** = **0**
- **FX_FXAA** = **1**
- **FX_GLOW** = **2**
- **FX_DOF_BLUR** = **3**
- **FX_HDR** = **4**
- **FX_FOG** = **5**
- **FX_BCS** = **6**
- **FX_SRGB** = **7**
- **FX_MAX** = **8**
- **FX_BLUR_BLEND_MODE_ADDITIVE** = **0**
- **FX_BLUR_BLEND_MODE_SCREEN** = **1**
- **FX_BLUR_BLEND_MODE_SOFTLIGHT** = **2**
- **FX_HDR_TONE_MAPPER_LINEAR** = **0**
- **FX_HDR_TONE_MAPPER_LOG** = **1**
- **FX_HDR_TONE_MAPPER_REINHARDT** = **2**
- **FX_HDR_TONE_MAPPER_REINHARDT_AUTOWHITE** = **3**
- **FX_PARAM_AMBIENT_LIGHT_COLOR** = **0**
- **FX_BLUR_BLEND_MODE_SCREEN** = **1**
- **FX_FXAA** = **1**
- **FX_HDR_TONE_MAPPER_LOG** = **1**
- **FX_PARAM_AMBIENT_LIGHT_ENERGY** = **1**
- **FX_PARAM_GLOW_BLUR_PASSES** = **2**
- **FX_PARAM_GLOW_BLUR_SCALE** = **3**
- **FX_PARAM_GLOW_BLUR_STRENGTH** = **4**
- **FX_PARAM_GLOW_BLUR_BLEND_MODE** = **5**
- **FX_PARAM_GLOW_BLOOM** = **6**
- **FX_PARAM_GLOW_BLOOM_TRESHOLD** = **7**
- **FX_PARAM_DOF_BLUR_PASSES** = **8**
- **FX_PARAM_DOF_BLUR_BEGIN** = **9**
- **FX_PARAM_DOF_BLUR_RANGE** = **10**
- **FX_PARAM_HDR_TONEMAPPER** = **11**
- **FX_PARAM_HDR_EXPOSURE** = **12**
@@ -89,48 +71,66 @@ Numeric Constants
- **FX_PARAM_HDR_MAX_LUMINANCE** = **17**
- **FX_PARAM_HDR_EXPOSURE_ADJUST_SPEED** = **18**
- **FX_PARAM_FOG_BEGIN** = **19**
- **FX_PARAM_FOG_ATTENUATION** = **22**
- **FX_BLUR_BLEND_MODE_SOFTLIGHT** = **2**
- **FX_GLOW** = **2**
- **FX_HDR_TONE_MAPPER_REINHARDT** = **2**
- **FX_PARAM_GLOW_BLUR_PASSES** = **2**
- **FX_PARAM_FOG_BEGIN_COLOR** = **20**
- **FX_PARAM_FOG_END_COLOR** = **21**
- **FX_PARAM_FOG_ATTENUATION** = **22**
- **FX_PARAM_FOG_BG** = **23**
- **FX_PARAM_BCS_BRIGHTNESS** = **24**
- **FX_PARAM_BCS_CONTRAST** = **25**
- **FX_PARAM_BCS_SATURATION** = **26**
- **FX_PARAM_MAX** = **27**
- **FX_DOF_BLUR** = **3**
- **FX_HDR_TONE_MAPPER_REINHARDT_AUTOWHITE** = **3**
- **FX_PARAM_GLOW_BLUR_SCALE** = **3**
- **FX_HDR** = **4**
- **FX_PARAM_GLOW_BLUR_STRENGTH** = **4**
- **FX_FOG** = **5**
- **FX_PARAM_GLOW_BLUR_BLEND_MODE** = **5**
- **FX_BCS** = **6**
- **FX_PARAM_GLOW_BLOOM** = **6**
- **FX_PARAM_GLOW_BLOOM_TRESHOLD** = **7**
- **FX_SRGB** = **7**
- **FX_MAX** = **8**
- **FX_PARAM_DOF_BLUR_PASSES** = **8**
- **FX_PARAM_DOF_BLUR_BEGIN** = **9**
Member Function Description
---------------------------
.. _class_Environment_set_background:
- void **set_background** **(** :ref:`int<class_int>` bgmode **)**
.. _class_Environment_get_background:
- :ref:`int<class_int>` **get_background** **(** **)** const
.. _class_Environment_set_background_param:
- void **set_background_param** **(** :ref:`int<class_int>` param, var value **)**
.. _class_Environment_get_background_param:
- void **get_background_param** **(** :ref:`int<class_int>` param **)** const
.. _class_Environment_set_enable_fx:
- void **set_enable_fx** **(** :ref:`int<class_int>` effect, :ref:`bool<class_bool>` enabled **)**
.. _class_Environment_is_fx_enabled:
- :ref:`bool<class_bool>` **is_fx_enabled** **(** :ref:`int<class_int>` effect **)** const
.. _class_Environment_fx_set_param:
- void **fx_set_param** **(** :ref:`int<class_int>` param, var value **)**
.. _class_Environment_fx_get_param:
- void **fx_get_param** **(** :ref:`int<class_int>` param **)** const
.. _class_Environment_fx_set_param:
- void **fx_set_param** **(** :ref:`int<class_int>` param, var value **)**
.. _class_Environment_get_background:
- :ref:`int<class_int>` **get_background** **(** **)** const
.. _class_Environment_get_background_param:
- void **get_background_param** **(** :ref:`int<class_int>` param **)** const
.. _class_Environment_is_fx_enabled:
- :ref:`bool<class_bool>` **is_fx_enabled** **(** :ref:`int<class_int>` effect **)** const
.. _class_Environment_set_background:
- void **set_background** **(** :ref:`int<class_int>` bgmode **)**
.. _class_Environment_set_background_param:
- void **set_background_param** **(** :ref:`int<class_int>` param, var value **)**
.. _class_Environment_set_enable_fx:
- void **set_enable_fx** **(** :ref:`int<class_int>` effect, :ref:`bool<class_bool>` enabled **)**

362
classes/class_eventplayer.rst
View File

@@ -19,59 +19,59 @@ Member Functions
----------------
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_stream<class_EventPlayer_set_stream>` **(** :ref:`EventStream<class_eventstream>` stream **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`EventStream<class_eventstream>` | :ref:`get_stream<class_EventPlayer_get_stream>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`play<class_EventPlayer_play>` **(** **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`stop<class_EventPlayer_stop>` **(** **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_playing<class_EventPlayer_is_playing>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_paused<class_EventPlayer_set_paused>` **(** :ref:`bool<class_bool>` paused **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_paused<class_EventPlayer_is_paused>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_loop<class_EventPlayer_set_loop>` **(** :ref:`bool<class_bool>` enabled **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_loop<class_EventPlayer_has_loop>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_volume<class_EventPlayer_set_volume>` **(** :ref:`float<class_float>` volume **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_volume<class_EventPlayer_get_volume>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_pitch_scale<class_EventPlayer_set_pitch_scale>` **(** :ref:`float<class_float>` pitch_scale **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_pitch_scale<class_EventPlayer_get_pitch_scale>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tempo_scale<class_EventPlayer_set_tempo_scale>` **(** :ref:`float<class_float>` tempo_scale **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_tempo_scale<class_EventPlayer_get_tempo_scale>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_volume_db<class_EventPlayer_set_volume_db>` **(** :ref:`float<class_float>` db **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_volume_db<class_EventPlayer_get_volume_db>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_stream_name<class_EventPlayer_get_stream_name>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_loop_count<class_EventPlayer_get_loop_count>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_pos<class_EventPlayer_get_pos>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`seek_pos<class_EventPlayer_seek_pos>` **(** :ref:`float<class_float>` time **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_length<class_EventPlayer_get_length>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_autoplay<class_EventPlayer_set_autoplay>` **(** :ref:`bool<class_bool>` enabled **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_autoplay<class_EventPlayer_has_autoplay>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_channel_volume<class_EventPlayer_set_channel_volume>` **(** :ref:`int<class_int>` channel, :ref:`float<class_float>` channel_volume **)** |
| :ref:`float<class_float>` | :ref:`get_channel_last_note_time<class_EventPlayer_get_channel_last_note_time>` **(** :ref:`int<class_int>` channel **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_channel_volume<class_EventPlayer_get_channel_volume>` **(** :ref:`int<class_int>` channel **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_channel_last_note_time<class_EventPlayer_get_channel_last_note_time>` **(** :ref:`int<class_int>` channel **)** const |
| :ref:`float<class_float>` | :ref:`get_length<class_EventPlayer_get_length>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_loop_count<class_EventPlayer_get_loop_count>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_pitch_scale<class_EventPlayer_get_pitch_scale>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_pos<class_EventPlayer_get_pos>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`EventStream<class_eventstream>` | :ref:`get_stream<class_EventPlayer_get_stream>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_stream_name<class_EventPlayer_get_stream_name>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_tempo_scale<class_EventPlayer_get_tempo_scale>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_volume<class_EventPlayer_get_volume>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_volume_db<class_EventPlayer_get_volume_db>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_autoplay<class_EventPlayer_has_autoplay>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_loop<class_EventPlayer_has_loop>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_paused<class_EventPlayer_is_paused>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_playing<class_EventPlayer_is_playing>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`play<class_EventPlayer_play>` **(** **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`seek_pos<class_EventPlayer_seek_pos>` **(** :ref:`float<class_float>` time **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_autoplay<class_EventPlayer_set_autoplay>` **(** :ref:`bool<class_bool>` enabled **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_channel_volume<class_EventPlayer_set_channel_volume>` **(** :ref:`int<class_int>` channel, :ref:`float<class_float>` channel_volume **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_loop<class_EventPlayer_set_loop>` **(** :ref:`bool<class_bool>` enabled **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_paused<class_EventPlayer_set_paused>` **(** :ref:`bool<class_bool>` paused **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_pitch_scale<class_EventPlayer_set_pitch_scale>` **(** :ref:`float<class_float>` pitch_scale **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_stream<class_EventPlayer_set_stream>` **(** :ref:`EventStream<class_eventstream>` stream **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tempo_scale<class_EventPlayer_set_tempo_scale>` **(** :ref:`float<class_float>` tempo_scale **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_volume<class_EventPlayer_set_volume>` **(** :ref:`float<class_float>` volume **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_volume_db<class_EventPlayer_set_volume_db>` **(** :ref:`float<class_float>` db **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`stop<class_EventPlayer_stop>` **(** **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
Description
@@ -84,133 +84,17 @@ Currently, only MOD, S3M, IT, and XM music is supported.
Member Function Description
---------------------------
.. _class_EventPlayer_set_stream:
.. _class_EventPlayer_get_channel_last_note_time:
- void **set_stream** **(** :ref:`EventStream<class_eventstream>` stream **)**
- :ref:`float<class_float>` **get_channel_last_note_time** **(** :ref:`int<class_int>` channel **)** const
Set the :ref:`EventStream<class_eventstream>` this player will play.
Return the time at which the last note of a given channel in the stream plays.
.. _class_EventPlayer_get_stream:
.. _class_EventPlayer_get_channel_volume:
- :ref:`EventStream<class_eventstream>` **get_stream** **(** **)** const
- :ref:`float<class_float>` **get_channel_volume** **(** :ref:`int<class_int>` channel **)** const
Return the currently assigned stream.
.. _class_EventPlayer_play:
- void **play** **(** **)**
Play the currently assigned stream.
.. _class_EventPlayer_stop:
- void **stop** **(** **)**
Stop playing.
.. _class_EventPlayer_is_playing:
- :ref:`bool<class_bool>` **is_playing** **(** **)** const
Return whether this player is playing.
.. _class_EventPlayer_set_paused:
- void **set_paused** **(** :ref:`bool<class_bool>` paused **)**
Pause stream playback.
.. _class_EventPlayer_is_paused:
- :ref:`bool<class_bool>` **is_paused** **(** **)** const
Return whether the playback is currently paused.
.. _class_EventPlayer_set_loop:
- void **set_loop** **(** :ref:`bool<class_bool>` enabled **)**
Set whether the stream will be restarted at the end.
.. _class_EventPlayer_has_loop:
- :ref:`bool<class_bool>` **has_loop** **(** **)** const
Return whether this player will be restart the playback at the end.
.. _class_EventPlayer_set_volume:
- void **set_volume** **(** :ref:`float<class_float>` volume **)**
Set the playback volume for this player. This is a float between 0.0 (silent) and 1.0 (full volume). Values over 1.0 may amplify sound even more, but may introduce distortion. Negative values may just invert the output waveform, which produces no audible difference.
The effect of these special values ultimately depends on the low-level implementation of the file format being played.
.. _class_EventPlayer_get_volume:
- :ref:`float<class_float>` **get_volume** **(** **)** const
Return the playback volume for this player.
.. _class_EventPlayer_set_pitch_scale:
- void **set_pitch_scale** **(** :ref:`float<class_float>` pitch_scale **)**
Set the pitch multiplier for all sounds coming from this stream. A value of 2.0 shifts all pitches one octave up, and a value of 0.5 shifts pitches one octave down.
.. _class_EventPlayer_get_pitch_scale:
- :ref:`float<class_float>` **get_pitch_scale** **(** **)** const
Return the pitch scale factor for this player.
.. _class_EventPlayer_set_tempo_scale:
- void **set_tempo_scale** **(** :ref:`float<class_float>` tempo_scale **)**
Set the tempo multiplier. This allows to slow down or speed up the music, without affecting its pitch.
.. _class_EventPlayer_get_tempo_scale:
- :ref:`float<class_float>` **get_tempo_scale** **(** **)** const
Return the tempo multiplier.
.. _class_EventPlayer_set_volume_db:
- void **set_volume_db** **(** :ref:`float<class_float>` db **)**
Set the playback volume for this player, in decibels. This is a float between -80.0 (silent) and 0.0 (full volume). Values under -79.0 get truncated to -80, but values over 0.0 do not, so the warnings for over amplifying (see :ref:`set_volume<class_EventPlayer_set_volume>`) still apply.
.. _class_EventPlayer_get_volume_db:
- :ref:`float<class_float>` **get_volume_db** **(** **)** const
Return the playback volume for this player, in decibels.
.. _class_EventPlayer_get_stream_name:
- :ref:`String<class_string>` **get_stream_name** **(** **)** const
Return the name of the currently assigned stream. This is not the file name, but a field inside the file. If no stream is assigned, if returns "<No Stream>".
.. _class_EventPlayer_get_loop_count:
- :ref:`int<class_int>` **get_loop_count** **(** **)** const
Return the number of times the playback has looped.
.. _class_EventPlayer_get_pos:
- :ref:`float<class_float>` **get_pos** **(** **)** const
Return the playback position. May be in seconds, but depends on the stream type.
.. _class_EventPlayer_seek_pos:
- void **seek_pos** **(** :ref:`float<class_float>` time **)**
Set the playback position. May be in seconds, but depends on the stream type.
Return the volume scale for an individual channel of the stream.
.. _class_EventPlayer_get_length:
@@ -218,11 +102,53 @@ Set the playback position. May be in seconds, but depends on the stream type.
Return the song length. May be in seconds, but depends on the stream type.
.. _class_EventPlayer_set_autoplay:
.. _class_EventPlayer_get_loop_count:
- void **set_autoplay** **(** :ref:`bool<class_bool>` enabled **)**
- :ref:`int<class_int>` **get_loop_count** **(** **)** const
Set whether this player will start playing as soon as it enters the scene tree.
Return the number of times the playback has looped.
.. _class_EventPlayer_get_pitch_scale:
- :ref:`float<class_float>` **get_pitch_scale** **(** **)** const
Return the pitch scale factor for this player.
.. _class_EventPlayer_get_pos:
- :ref:`float<class_float>` **get_pos** **(** **)** const
Return the playback position. May be in seconds, but depends on the stream type.
.. _class_EventPlayer_get_stream:
- :ref:`EventStream<class_eventstream>` **get_stream** **(** **)** const
Return the currently assigned stream.
.. _class_EventPlayer_get_stream_name:
- :ref:`String<class_string>` **get_stream_name** **(** **)** const
Return the name of the currently assigned stream. This is not the file name, but a field inside the file. If no stream is assigned, if returns "<No Stream>".
.. _class_EventPlayer_get_tempo_scale:
- :ref:`float<class_float>` **get_tempo_scale** **(** **)** const
Return the tempo multiplier.
.. _class_EventPlayer_get_volume:
- :ref:`float<class_float>` **get_volume** **(** **)** const
Return the playback volume for this player.
.. _class_EventPlayer_get_volume_db:
- :ref:`float<class_float>` **get_volume_db** **(** **)** const
Return the playback volume for this player, in decibels.
.. _class_EventPlayer_has_autoplay:
@@ -230,6 +156,42 @@ Set whether this player will start playing as soon as it enters the scene tree.
Return whether this player will start playing as soon as it enters the scene tree.
.. _class_EventPlayer_has_loop:
- :ref:`bool<class_bool>` **has_loop** **(** **)** const
Return whether this player will be restart the playback at the end.
.. _class_EventPlayer_is_paused:
- :ref:`bool<class_bool>` **is_paused** **(** **)** const
Return whether the playback is currently paused.
.. _class_EventPlayer_is_playing:
- :ref:`bool<class_bool>` **is_playing** **(** **)** const
Return whether this player is playing.
.. _class_EventPlayer_play:
- void **play** **(** **)**
Play the currently assigned stream.
.. _class_EventPlayer_seek_pos:
- void **seek_pos** **(** :ref:`float<class_float>` time **)**
Set the playback position. May be in seconds, but depends on the stream type.
.. _class_EventPlayer_set_autoplay:
- void **set_autoplay** **(** :ref:`bool<class_bool>` enabled **)**
Set whether this player will start playing as soon as it enters the scene tree.
.. _class_EventPlayer_set_channel_volume:
- void **set_channel_volume** **(** :ref:`int<class_int>` channel, :ref:`float<class_float>` channel_volume **)**
@@ -238,16 +200,54 @@ Set the volume scale for an individual channel of the stream, with the same valu
Many stream formats are multichannel, so this allows to affect only a part of the music.
.. _class_EventPlayer_get_channel_volume:
.. _class_EventPlayer_set_loop:
- :ref:`float<class_float>` **get_channel_volume** **(** :ref:`int<class_int>` channel **)** const
- void **set_loop** **(** :ref:`bool<class_bool>` enabled **)**
Return the volume scale for an individual channel of the stream.
Set whether the stream will be restarted at the end.
.. _class_EventPlayer_get_channel_last_note_time:
.. _class_EventPlayer_set_paused:
- :ref:`float<class_float>` **get_channel_last_note_time** **(** :ref:`int<class_int>` channel **)** const
- void **set_paused** **(** :ref:`bool<class_bool>` paused **)**
Return the time at which the last note of a given channel in the stream plays.
Pause stream playback.
.. _class_EventPlayer_set_pitch_scale:
- void **set_pitch_scale** **(** :ref:`float<class_float>` pitch_scale **)**
Set the pitch multiplier for all sounds coming from this stream. A value of 2.0 shifts all pitches one octave up, and a value of 0.5 shifts pitches one octave down.
.. _class_EventPlayer_set_stream:
- void **set_stream** **(** :ref:`EventStream<class_eventstream>` stream **)**
Set the :ref:`EventStream<class_eventstream>` this player will play.
.. _class_EventPlayer_set_tempo_scale:
- void **set_tempo_scale** **(** :ref:`float<class_float>` tempo_scale **)**
Set the tempo multiplier. This allows to slow down or speed up the music, without affecting its pitch.
.. _class_EventPlayer_set_volume:
- void **set_volume** **(** :ref:`float<class_float>` volume **)**
Set the playback volume for this player. This is a float between 0.0 (silent) and 1.0 (full volume). Values over 1.0 may amplify sound even more, but may introduce distortion. Negative values may just invert the output waveform, which produces no audible difference.
The effect of these special values ultimately depends on the low-level implementation of the file format being played.
.. _class_EventPlayer_set_volume_db:
- void **set_volume_db** **(** :ref:`float<class_float>` db **)**
Set the playback volume for this player, in decibels. This is a float between -80.0 (silent) and 0.0 (full volume). Values under -79.0 get truncated to -80, but values over 0.0 do not, so the warnings for over amplifying (see :ref:`set_volume<class_EventPlayer_set_volume>`) still apply.
.. _class_EventPlayer_stop:
- void **stop** **(** **)**
Stop playing.

492
classes/class_file.rst
View File

@@ -13,33 +13,17 @@ File
Brief Description
-----------------
Type to handle file reading and writing operations.
Member Functions
----------------
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`open_encrypted<class_File_open_encrypted>` **(** :ref:`String<class_string>` path, :ref:`int<class_int>` mode_flags, :ref:`RawArray<class_rawarray>` key **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`open_encrypted_with_pass<class_File_open_encrypted_with_pass>` **(** :ref:`String<class_string>` path, :ref:`int<class_int>` mode_flags, :ref:`String<class_string>` pass **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`open<class_File_open>` **(** :ref:`String<class_string>` path, :ref:`int<class_int>` flags **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`close<class_File_close>` **(** **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_open<class_File_is_open>` **(** **)** const |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`seek<class_File_seek>` **(** :ref:`int<class_int>` pos **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`seek_end<class_File_seek_end>` **(** :ref:`int<class_int>` pos=0 **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_pos<class_File_get_pos>` **(** **)** const |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_len<class_File_get_len>` **(** **)** const |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`eof_reached<class_File_eof_reached>` **(** **)** const |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_8<class_File_get_8>` **(** **)** const |
| :ref:`bool<class_bool>` | :ref:`file_exists<class_File_file_exists>` **(** :ref:`String<class_string>` path **)** const |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_16<class_File_get_16>` **(** **)** const |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -47,29 +31,47 @@ Member Functions
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_64<class_File_get_64>` **(** **)** const |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_float<class_File_get_float>` **(** **)** const |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_double<class_File_get_double>` **(** **)** const |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_real<class_File_get_real>` **(** **)** const |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RawArray<class_rawarray>` | :ref:`get_buffer<class_File_get_buffer>` **(** :ref:`int<class_int>` len **)** const |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_line<class_File_get_line>` **(** **)** const |
| :ref:`int<class_int>` | :ref:`get_8<class_File_get_8>` **(** **)** const |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_as_text<class_File_get_as_text>` **(** **)** const |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_endian_swap<class_File_get_endian_swap>` **(** **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_endian_swap<class_File_set_endian_swap>` **(** :ref:`bool<class_bool>` enable **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Error | :ref:`get_error<class_File_get_error>` **(** **)** const |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`get_var<class_File_get_var>` **(** **)** const |
| :ref:`RawArray<class_rawarray>` | :ref:`get_buffer<class_File_get_buffer>` **(** :ref:`int<class_int>` len **)** const |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`StringArray<class_stringarray>` | :ref:`get_csv_line<class_File_get_csv_line>` **(** :ref:`String<class_string>` delim="," **)** const |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`store_8<class_File_store_8>` **(** :ref:`int<class_int>` value **)** |
| :ref:`float<class_float>` | :ref:`get_double<class_File_get_double>` **(** **)** const |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_endian_swap<class_File_get_endian_swap>` **(** **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Error | :ref:`get_error<class_File_get_error>` **(** **)** const |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_float<class_File_get_float>` **(** **)** const |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_len<class_File_get_len>` **(** **)** const |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_line<class_File_get_line>` **(** **)** const |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_pascal_string<class_File_get_pascal_string>` **(** **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_pos<class_File_get_pos>` **(** **)** const |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_real<class_File_get_real>` **(** **)** const |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`get_var<class_File_get_var>` **(** **)** const |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_open<class_File_is_open>` **(** **)** const |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`open<class_File_open>` **(** :ref:`String<class_string>` path, :ref:`int<class_int>` flags **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`open_encrypted<class_File_open_encrypted>` **(** :ref:`String<class_string>` path, :ref:`int<class_int>` mode_flags, :ref:`RawArray<class_rawarray>` key **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`open_encrypted_with_pass<class_File_open_encrypted_with_pass>` **(** :ref:`String<class_string>` path, :ref:`int<class_int>` mode_flags, :ref:`String<class_string>` pass **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`seek<class_File_seek>` **(** :ref:`int<class_int>` pos **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`seek_end<class_File_seek_end>` **(** :ref:`int<class_int>` pos=0 **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_endian_swap<class_File_set_endian_swap>` **(** :ref:`bool<class_bool>` enable **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`store_16<class_File_store_16>` **(** :ref:`int<class_int>` value **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -77,192 +79,298 @@ Member Functions
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`store_64<class_File_store_64>` **(** :ref:`int<class_int>` value **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`store_float<class_File_store_float>` **(** :ref:`float<class_float>` value **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`store_double<class_File_store_double>` **(** :ref:`float<class_float>` value **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`store_real<class_File_store_real>` **(** :ref:`float<class_float>` value **)** |
| void | :ref:`store_8<class_File_store_8>` **(** :ref:`int<class_int>` value **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`store_buffer<class_File_store_buffer>` **(** :ref:`RawArray<class_rawarray>` buffer **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`store_double<class_File_store_double>` **(** :ref:`float<class_float>` value **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`store_float<class_File_store_float>` **(** :ref:`float<class_float>` value **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`store_line<class_File_store_line>` **(** :ref:`String<class_string>` line **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`store_pascal_string<class_File_store_pascal_string>` **(** :ref:`String<class_string>` string **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`store_real<class_File_store_real>` **(** :ref:`float<class_float>` value **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`store_string<class_File_store_string>` **(** :ref:`String<class_string>` string **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`store_var<class_File_store_var>` **(** var value **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`store_pascal_string<class_File_store_pascal_string>` **(** :ref:`String<class_string>` string **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_pascal_string<class_File_get_pascal_string>` **(** **)** |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`file_exists<class_File_file_exists>` **(** :ref:`String<class_string>` path **)** const |
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Numeric Constants
-----------------
- **READ** = **1**
- **WRITE** = **2**
- **READ_WRITE** = **3**
- **WRITE_READ** = **7**
- **READ** = **1** --- Open the file for reading.
- **READ_WRITE** = **3** --- Open the file for reading and writing, without truncating the file.
- **WRITE** = **2** --- Open the file for writing. Create it if the file not exists and truncate if it exists.
- **WRITE_READ** = **7** --- Open the file for reading and writing. Create it if the file not exists and truncate if it exists.
Description
-----------
File type. This is used to permanently store data into the user device's file system and to read from it. This can be used to store game save data or player configuration files, for example.
Here's a sample on how to write and read from a file:
::
func save(content):
var file = File.new()
file.open("user://save_game.dat", file.WRITE)
file.store_string(content)
file.close()
func load():
var file = File.new()
file.open("user://save_game.dat", file.READ)
var content = file.get_as_text()
file.close()
return content
Member Function Description
---------------------------
.. _class_File_open_encrypted:
- :ref:`int<class_int>` **open_encrypted** **(** :ref:`String<class_string>` path, :ref:`int<class_int>` mode_flags, :ref:`RawArray<class_rawarray>` key **)**
.. _class_File_open_encrypted_with_pass:
- :ref:`int<class_int>` **open_encrypted_with_pass** **(** :ref:`String<class_string>` path, :ref:`int<class_int>` mode_flags, :ref:`String<class_string>` pass **)**
.. _class_File_open:
- :ref:`int<class_int>` **open** **(** :ref:`String<class_string>` path, :ref:`int<class_int>` flags **)**
.. _class_File_close:
- void **close** **(** **)**
.. _class_File_is_open:
- :ref:`bool<class_bool>` **is_open** **(** **)** const
.. _class_File_seek:
- void **seek** **(** :ref:`int<class_int>` pos **)**
.. _class_File_seek_end:
- void **seek_end** **(** :ref:`int<class_int>` pos=0 **)**
.. _class_File_get_pos:
- :ref:`int<class_int>` **get_pos** **(** **)** const
.. _class_File_get_len:
- :ref:`int<class_int>` **get_len** **(** **)** const
Close the currently opened file.
.. _class_File_eof_reached:
- :ref:`bool<class_bool>` **eof_reached** **(** **)** const
.. _class_File_get_8:
- :ref:`int<class_int>` **get_8** **(** **)** const
.. _class_File_get_16:
- :ref:`int<class_int>` **get_16** **(** **)** const
.. _class_File_get_32:
- :ref:`int<class_int>` **get_32** **(** **)** const
.. _class_File_get_64:
- :ref:`int<class_int>` **get_64** **(** **)** const
.. _class_File_get_float:
- :ref:`float<class_float>` **get_float** **(** **)** const
.. _class_File_get_double:
- :ref:`float<class_float>` **get_double** **(** **)** const
.. _class_File_get_real:
- :ref:`float<class_float>` **get_real** **(** **)** const
.. _class_File_get_buffer:
- :ref:`RawArray<class_rawarray>` **get_buffer** **(** :ref:`int<class_int>` len **)** const
.. _class_File_get_line:
- :ref:`String<class_string>` **get_line** **(** **)** const
.. _class_File_get_as_text:
- :ref:`String<class_string>` **get_as_text** **(** **)** const
.. _class_File_get_endian_swap:
- :ref:`bool<class_bool>` **get_endian_swap** **(** **)**
.. _class_File_set_endian_swap:
- void **set_endian_swap** **(** :ref:`bool<class_bool>` enable **)**
.. _class_File_get_error:
- Error **get_error** **(** **)** const
.. _class_File_get_var:
- void **get_var** **(** **)** const
.. _class_File_get_csv_line:
- :ref:`StringArray<class_stringarray>` **get_csv_line** **(** :ref:`String<class_string>` delim="," **)** const
.. _class_File_store_8:
- void **store_8** **(** :ref:`int<class_int>` value **)**
.. _class_File_store_16:
- void **store_16** **(** :ref:`int<class_int>` value **)**
.. _class_File_store_32:
- void **store_32** **(** :ref:`int<class_int>` value **)**
.. _class_File_store_64:
- void **store_64** **(** :ref:`int<class_int>` value **)**
.. _class_File_store_float:
- void **store_float** **(** :ref:`float<class_float>` value **)**
.. _class_File_store_double:
- void **store_double** **(** :ref:`float<class_float>` value **)**
.. _class_File_store_real:
- void **store_real** **(** :ref:`float<class_float>` value **)**
.. _class_File_store_buffer:
- void **store_buffer** **(** :ref:`RawArray<class_rawarray>` buffer **)**
.. _class_File_store_line:
- void **store_line** **(** :ref:`String<class_string>` line **)**
.. _class_File_store_string:
- void **store_string** **(** :ref:`String<class_string>` string **)**
.. _class_File_store_var:
- void **store_var** **(** var value **)**
.. _class_File_store_pascal_string:
- void **store_pascal_string** **(** :ref:`String<class_string>` string **)**
.. _class_File_get_pascal_string:
- :ref:`String<class_string>` **get_pascal_string** **(** **)**
Return whether the file cursor reached the end of the file.
.. _class_File_file_exists:
- :ref:`bool<class_bool>` **file_exists** **(** :ref:`String<class_string>` path **)** const
Get whether or not the file in the specified path exists.
.. _class_File_get_16:
- :ref:`int<class_int>` **get_16** **(** **)** const
Get the next 16 bits from the file as an integer.
.. _class_File_get_32:
- :ref:`int<class_int>` **get_32** **(** **)** const
Get the next 32 bits from the file as an integer.
.. _class_File_get_64:
- :ref:`int<class_int>` **get_64** **(** **)** const
Get the next 64 bits from the file as an integer.
.. _class_File_get_8:
- :ref:`int<class_int>` **get_8** **(** **)** const
Get the next 8 bits from the file as an integer.
.. _class_File_get_as_text:
- :ref:`String<class_string>` **get_as_text** **(** **)** const
Get the whole file as a :ref:`String<class_string>`.
.. _class_File_get_buffer:
- :ref:`RawArray<class_rawarray>` **get_buffer** **(** :ref:`int<class_int>` len **)** const
Get next len bytes of the file as a :ref:`RawArray<class_rawarray>`.
.. _class_File_get_csv_line:
- :ref:`StringArray<class_stringarray>` **get_csv_line** **(** :ref:`String<class_string>` delim="," **)** const
Get the next value of the file in CSV (Comma Separated Values) format. You can pass a different delimiter to use other than the default "," (comma).
.. _class_File_get_double:
- :ref:`float<class_float>` **get_double** **(** **)** const
Get the next 64 bits from the file as a floating point number.
.. _class_File_get_endian_swap:
- :ref:`bool<class_bool>` **get_endian_swap** **(** **)**
Get whether endian swap is enabled for this file.
.. _class_File_get_error:
- Error **get_error** **(** **)** const
Get the last error that happened when trying to perform operations. Compare with the ``ERR_FILE\_\*`` constants from :ref:`@Global Scope<class_@global scope>`.
.. _class_File_get_float:
- :ref:`float<class_float>` **get_float** **(** **)** const
Get the next 32 bits from the file as a floating point number.
.. _class_File_get_len:
- :ref:`int<class_int>` **get_len** **(** **)** const
Return the size of the file in bytes.
.. _class_File_get_line:
- :ref:`String<class_string>` **get_line** **(** **)** const
Get the next line of the file as a :ref:`String<class_string>`.
.. _class_File_get_pascal_string:
- :ref:`String<class_string>` **get_pascal_string** **(** **)**
Get a :ref:`String<class_string>` saved in Pascal format from the file.
.. _class_File_get_pos:
- :ref:`int<class_int>` **get_pos** **(** **)** const
Return the file cursor position.
.. _class_File_get_real:
- :ref:`float<class_float>` **get_real** **(** **)** const
Get the next bits from the file as a floating point number.
.. _class_File_get_var:
- void **get_var** **(** **)** const
Get the next Variant value from the file.
.. _class_File_is_open:
- :ref:`bool<class_bool>` **is_open** **(** **)** const
Return whether the file is currently opened.
.. _class_File_open:
- :ref:`int<class_int>` **open** **(** :ref:`String<class_string>` path, :ref:`int<class_int>` flags **)**
Open the file for writing or reading, depending on the flags.
.. _class_File_open_encrypted:
- :ref:`int<class_int>` **open_encrypted** **(** :ref:`String<class_string>` path, :ref:`int<class_int>` mode_flags, :ref:`RawArray<class_rawarray>` key **)**
Open an encrypted file in write or read mode. You need to pass a binary key to encrypt/decrypt it.
.. _class_File_open_encrypted_with_pass:
- :ref:`int<class_int>` **open_encrypted_with_pass** **(** :ref:`String<class_string>` path, :ref:`int<class_int>` mode_flags, :ref:`String<class_string>` pass **)**
Open an encrypted file in write or read mode. You need to pass a password to encrypt/decrypt it.
.. _class_File_seek:
- void **seek** **(** :ref:`int<class_int>` pos **)**
Change the file reading/writing cursor to the specified position (in bytes from the beginning of the file).
.. _class_File_seek_end:
- void **seek_end** **(** :ref:`int<class_int>` pos=0 **)**
Change the file reading/writing cursor to the specified position (in bytes from the end of the file). Note that this is an offset, so you should use negative numbers or the cursor will be at the end of the file.
.. _class_File_set_endian_swap:
- void **set_endian_swap** **(** :ref:`bool<class_bool>` enable **)**
Set whether to swap the endianess of the file. Enable this if you're dealing with files written in big endian machines.
Note that this is about the file format, not CPU type. This is always reseted to ``false`` whenever you open the file.
.. _class_File_store_16:
- void **store_16** **(** :ref:`int<class_int>` value **)**
Store an integer as 16 bits in the file.
.. _class_File_store_32:
- void **store_32** **(** :ref:`int<class_int>` value **)**
Store an integer as 32 bits in the file.
.. _class_File_store_64:
- void **store_64** **(** :ref:`int<class_int>` value **)**
Store an integer as 64 bits in the file.
.. _class_File_store_8:
- void **store_8** **(** :ref:`int<class_int>` value **)**
Store an integer as 8 bits in the file.
.. _class_File_store_buffer:
- void **store_buffer** **(** :ref:`RawArray<class_rawarray>` buffer **)**
Store the given array of bytes in the file.
.. _class_File_store_double:
- void **store_double** **(** :ref:`float<class_float>` value **)**
Store a floating point number as 64 bits in the file.
.. _class_File_store_float:
- void **store_float** **(** :ref:`float<class_float>` value **)**
Store a floating point number as 32 bits in the file.
.. _class_File_store_line:
- void **store_line** **(** :ref:`String<class_string>` line **)**
Store the given :ref:`String<class_string>` as a line in the file.
.. _class_File_store_pascal_string:
- void **store_pascal_string** **(** :ref:`String<class_string>` string **)**
Store the given :ref:`String<class_string>` as a line in the file in Pascal format (i.e. also store the length of the string).
.. _class_File_store_real:
- void **store_real** **(** :ref:`float<class_float>` value **)**
Store a floating point number in the file.
.. _class_File_store_string:
- void **store_string** **(** :ref:`String<class_string>` string **)**
Store the given :ref:`String<class_string>` in the file.
.. _class_File_store_var:
- void **store_var** **(** var value **)**
Store any Variant value in the file.

112
classes/class_filedialog.rst
View File

@@ -18,10 +18,12 @@ Dialog for selecting files or directories in the filesystem.
Member Functions
----------------
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_filter<class_FileDialog_add_filter>` **(** :ref:`String<class_string>` filter **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_filters<class_FileDialog_clear_filters>` **(** **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_filter<class_FileDialog_add_filter>` **(** :ref:`String<class_string>` filter **)** |
| :ref:`int<class_int>` | :ref:`get_access<class_FileDialog_get_access>` **(** **)** const |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_current_dir<class_FileDialog_get_current_dir>` **(** **)** const |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
@@ -29,6 +31,16 @@ Member Functions
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_current_path<class_FileDialog_get_current_path>` **(** **)** const |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_mode<class_FileDialog_get_mode>` **(** **)** const |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`VBoxContainer<class_vboxcontainer>` | :ref:`get_vbox<class_FileDialog_get_vbox>` **(** **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`invalidate<class_FileDialog_invalidate>` **(** **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_showing_hidden_files<class_FileDialog_is_showing_hidden_files>` **(** **)** const |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_access<class_FileDialog_set_access>` **(** :ref:`int<class_int>` access **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_current_dir<class_FileDialog_set_current_dir>` **(** :ref:`String<class_string>` dir **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_current_file<class_FileDialog_set_current_file>` **(** :ref:`String<class_string>` file **)** |
@@ -37,38 +49,26 @@ Member Functions
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_mode<class_FileDialog_set_mode>` **(** :ref:`int<class_int>` mode **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_mode<class_FileDialog_get_mode>` **(** **)** const |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`VBoxContainer<class_vboxcontainer>` | :ref:`get_vbox<class_FileDialog_get_vbox>` **(** **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_access<class_FileDialog_set_access>` **(** :ref:`int<class_int>` access **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_access<class_FileDialog_get_access>` **(** **)** const |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_show_hidden_files<class_FileDialog_set_show_hidden_files>` **(** :ref:`bool<class_bool>` show **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_showing_hidden_files<class_FileDialog_is_showing_hidden_files>` **(** **)** const |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
| void | :ref:`invalidate<class_FileDialog_invalidate>` **(** **)** |
+--------------------------------------------+-----------------------------------------------------------------------------------------------------------------+
Signals
-------
- **files_selected** **(** :ref:`StringArray<class_stringarray>` paths **)**
- **dir_selected** **(** :ref:`String<class_string>` dir **)**
- **file_selected** **(** :ref:`String<class_string>` path **)**
- **files_selected** **(** :ref:`StringArray<class_stringarray>` paths **)**
Numeric Constants
-----------------
- **ACCESS_RESOURCES** = **0** --- The dialog allows the selection of file and directory.
- **ACCESS_USERDATA** = **1** --- The dialog allows ascess files under :ref:`Resource<class_resource>` path(res://) .
- **ACCESS_FILESYSTEM** = **2** --- The dialog allows ascess files in whole file system.
- **MODE_OPEN_FILE** = **0** --- The dialog allows the selection of one, and only one file.
- **MODE_OPEN_FILES** = **1** --- The dialog allows the selection of multiple files.
- **MODE_OPEN_DIR** = **2** --- The dialog functions as a folder selector, disallowing the selection of any file.
- **MODE_SAVE_FILE** = **3** --- The dialog will warn when a file exists.
- **ACCESS_RESOURCES** = **0** --- The dialog allows the selection of file and directory.
- **ACCESS_USERDATA** = **1** --- The dialog allows ascess files under :ref:`Resource<class_resource>` path(res://) .
- **ACCESS_FILESYSTEM** = **2** --- The dialog allows ascess files in whole file system.
Description
-----------
@@ -78,17 +78,23 @@ FileDialog is a preset dialog used to choose files and directories in the filesy
Member Function Description
---------------------------
.. _class_FileDialog_add_filter:
- void **add_filter** **(** :ref:`String<class_string>` filter **)**
Add a custom filter. Filter format is: "mask ; description", example (C++): dialog->add_filter("\*.png ; PNG Images");
.. _class_FileDialog_clear_filters:
- void **clear_filters** **(** **)**
Clear all the added filters in the dialog.
.. _class_FileDialog_add_filter:
.. _class_FileDialog_get_access:
- void **add_filter** **(** :ref:`String<class_string>` filter **)**
- :ref:`int<class_int>` **get_access** **(** **)** const
Add a custom filter. Filter format is: "mask ; description", example (C++): dialog->add_filter("\*.png ; PNG Images");
Return the file access permission of the dialog.
.. _class_FileDialog_get_current_dir:
@@ -108,6 +114,36 @@ Get the current selected file of the file dialog (empty if none).
Get the current selected path (directory and file) of the file dialog (empty if none).
.. _class_FileDialog_get_mode:
- :ref:`int<class_int>` **get_mode** **(** **)** const
Get the file dialog mode from the MODE\_\* enum.
.. _class_FileDialog_get_vbox:
- :ref:`VBoxContainer<class_vboxcontainer>` **get_vbox** **(** **)**
Return the vertical box container of the dialog, custom controls can be added to it.
.. _class_FileDialog_invalidate:
- void **invalidate** **(** **)**
Invalidate and update the current dialog content list.
.. _class_FileDialog_is_showing_hidden_files:
- :ref:`bool<class_bool>` **is_showing_hidden_files** **(** **)** const
Return true if the diaog allows show hidden files.
.. _class_FileDialog_set_access:
- void **set_access** **(** :ref:`int<class_int>` access **)**
Set the file access permission of the dialog(Must be one of :ref:`ACCESS_RESOURCES<class_access_resources>`, :ref:`ACCESS_USERDATA<class_access_userdata>` or :ref:`ACCESS_FILESYSTEM<class_access_filesystem>`).
.. _class_FileDialog_set_current_dir:
- void **set_current_dir** **(** :ref:`String<class_string>` dir **)**
@@ -132,46 +168,10 @@ Set the current selected file path of the file dialog.
Set the file dialog mode from the MODE\_\* enum.
.. _class_FileDialog_get_mode:
- :ref:`int<class_int>` **get_mode** **(** **)** const
Get the file dialog mode from the MODE\_\* enum.
.. _class_FileDialog_get_vbox:
- :ref:`VBoxContainer<class_vboxcontainer>` **get_vbox** **(** **)**
Return the vertical box container of the dialog, custom controls can be added to it.
.. _class_FileDialog_set_access:
- void **set_access** **(** :ref:`int<class_int>` access **)**
Set the file access permission of the dialog(Must be one of :ref:`ACCESS_RESOURCES<class_access_resources>`, :ref:`ACCESS_USERDATA<class_access_userdata>` or :ref:`ACCESS_FILESYSTEM<class_access_filesystem>`).
.. _class_FileDialog_get_access:
- :ref:`int<class_int>` **get_access** **(** **)** const
Return the file access permission of the dialog.
.. _class_FileDialog_set_show_hidden_files:
- void **set_show_hidden_files** **(** :ref:`bool<class_bool>` show **)**
Set the dialog should show hidden files.
.. _class_FileDialog_is_showing_hidden_files:
- :ref:`bool<class_bool>` **is_showing_hidden_files** **(** **)** const
Return true if the diaog allows show hidden files.
.. _class_FileDialog_invalidate:
- void **invalidate** **(** **)**
Invalidate and update the current dialog content list.

128
classes/class_fixedmaterial.rst
View File

@@ -18,39 +18,47 @@ Simple Material with a fixed parameter set.
Member Functions
----------------
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_parameter<class_FixedMaterial_set_parameter>` **(** :ref:`int<class_int>` param, var value **)** |
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`get_parameter<class_FixedMaterial_get_parameter>` **(** :ref:`int<class_int>` param **)** const |
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_texture<class_FixedMaterial_set_texture>` **(** :ref:`int<class_int>` param, :ref:`Texture<class_texture>` texture **)** |
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>` | :ref:`get_texture<class_FixedMaterial_get_texture>` **(** :ref:`int<class_int>` param **)** const |
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_texcoord_mode<class_FixedMaterial_set_texcoord_mode>` **(** :ref:`int<class_int>` param, :ref:`int<class_int>` mode **)** |
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_texcoord_mode<class_FixedMaterial_get_texcoord_mode>` **(** :ref:`int<class_int>` param **)** const |
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_fixed_flag<class_FixedMaterial_set_fixed_flag>` **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` value **)** |
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_fixed_flag<class_FixedMaterial_get_fixed_flag>` **(** :ref:`int<class_int>` flag **)** const |
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_uv_transform<class_FixedMaterial_set_uv_transform>` **(** :ref:`Transform<class_transform>` transform **)** |
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform<class_transform>` | :ref:`get_uv_transform<class_FixedMaterial_get_uv_transform>` **(** **)** const |
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_light_shader<class_FixedMaterial_set_light_shader>` **(** :ref:`int<class_int>` shader **)** |
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_light_shader<class_FixedMaterial_get_light_shader>` **(** **)** const |
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_size<class_FixedMaterial_set_point_size>` **(** :ref:`float<class_float>` size **)** |
| void | :ref:`get_parameter<class_FixedMaterial_get_parameter>` **(** :ref:`int<class_int>` param **)** const |
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_point_size<class_FixedMaterial_get_point_size>` **(** **)** const |
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_texcoord_mode<class_FixedMaterial_get_texcoord_mode>` **(** :ref:`int<class_int>` param **)** const |
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>` | :ref:`get_texture<class_FixedMaterial_get_texture>` **(** :ref:`int<class_int>` param **)** const |
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Transform<class_transform>` | :ref:`get_uv_transform<class_FixedMaterial_get_uv_transform>` **(** **)** const |
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_fixed_flag<class_FixedMaterial_set_fixed_flag>` **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` value **)** |
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_light_shader<class_FixedMaterial_set_light_shader>` **(** :ref:`int<class_int>` shader **)** |
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_parameter<class_FixedMaterial_set_parameter>` **(** :ref:`int<class_int>` param, var value **)** |
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_point_size<class_FixedMaterial_set_point_size>` **(** :ref:`float<class_float>` size **)** |
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_texcoord_mode<class_FixedMaterial_set_texcoord_mode>` **(** :ref:`int<class_int>` param, :ref:`int<class_int>` mode **)** |
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_texture<class_FixedMaterial_set_texture>` **(** :ref:`int<class_int>` param, :ref:`Texture<class_texture>` texture **)** |
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_uv_transform<class_FixedMaterial_set_uv_transform>` **(** :ref:`Transform<class_transform>` transform **)** |
+------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
Numeric Constants
-----------------
- **FLAG_USE_ALPHA** = **0**
- **FLAG_USE_COLOR_ARRAY** = **1**
- **FLAG_USE_POINT_SIZE** = **2**
- **FLAG_DISCARD_ALPHA** = **3**
- **LIGHT_SHADER_LAMBERT** = **0**
- **LIGHT_SHADER_WRAP** = **1**
- **LIGHT_SHADER_VELVET** = **2**
- **LIGHT_SHADER_TOON** = **3**
- **PARAM_DIFFUSE** = **0** --- Diffuse Lighting (light scattered from surface).
- **PARAM_DETAIL** = **1** --- Detail Layer for diffuse lighting.
- **PARAM_SPECULAR** = **2** --- Specular Lighting (light reflected from the surface).
@@ -60,18 +68,10 @@ Numeric Constants
- **PARAM_NORMAL** = **6** --- Normal Map (irregularity map).
- **PARAM_SHADE_PARAM** = **7**
- **PARAM_MAX** = **8** --- Maximum amount of parameters.
- **TEXCOORD_SPHERE** = **3**
- **TEXCOORD_UV** = **0** --- Read texture coordinates from the UV array.
- **TEXCOORD_UV_TRANSFORM** = **1** --- Read texture coordinates from the UV array and transform them by uv_xform.
- **TEXCOORD_UV2** = **2** --- Read texture coordinates from the UV2 array.
- **FLAG_USE_ALPHA** = **0**
- **FLAG_USE_COLOR_ARRAY** = **1**
- **FLAG_USE_POINT_SIZE** = **2**
- **FLAG_DISCARD_ALPHA** = **3**
- **LIGHT_SHADER_LAMBERT** = **0**
- **LIGHT_SHADER_WRAP** = **1**
- **LIGHT_SHADER_VELVET** = **2**
- **LIGHT_SHADER_TOON** = **3**
- **TEXCOORD_SPHERE** = **3**
Description
-----------
@@ -81,11 +81,13 @@ FixedMaterial is a simple type of material :ref:`Resource<class_resource>`, whic
Member Function Description
---------------------------
.. _class_FixedMaterial_set_parameter:
.. _class_FixedMaterial_get_fixed_flag:
- void **set_parameter** **(** :ref:`int<class_int>` param, var value **)**
- :ref:`bool<class_bool>` **get_fixed_flag** **(** :ref:`int<class_int>` flag **)** const
Set a parameter, parameters are defined in the PARAM\_\* enum. The type of each parameter may change, so it's best to check the enum.
.. _class_FixedMaterial_get_light_shader:
- :ref:`int<class_int>` **get_light_shader** **(** **)** const
.. _class_FixedMaterial_get_parameter:
@@ -93,23 +95,9 @@ Set a parameter, parameters are defined in the PARAM\_\* enum. The type of each
Return a parameter, parameters are defined in the PARAM\_\* enum. The type of each parameter may change, so it's best to check the enum.
.. _class_FixedMaterial_set_texture:
.. _class_FixedMaterial_get_point_size:
- void **set_texture** **(** :ref:`int<class_int>` param, :ref:`Texture<class_texture>` texture **)**
Set a texture. Textures change parameters per texel and are mapped to the model depending on the texcoord mode (see :ref:`set_texcoord_mode<class_FixedMaterial_set_texcoord_mode>`).
.. _class_FixedMaterial_get_texture:
- :ref:`Texture<class_texture>` **get_texture** **(** :ref:`int<class_int>` param **)** const
Return a texture. Textures change parameters per texel and are mapped to the model depending on the texcoord mode (see :ref:`set_texcoord_mode<class_FixedMaterial_set_texcoord_mode>`).
.. _class_FixedMaterial_set_texcoord_mode:
- void **set_texcoord_mode** **(** :ref:`int<class_int>` param, :ref:`int<class_int>` mode **)**
Set the texture coordinate mode. Each texture param (from the PARAM\_\* enum) has one. It defines how the textures are mapped to the object.
- :ref:`float<class_float>` **get_point_size** **(** **)** const
.. _class_FixedMaterial_get_texcoord_mode:
@@ -117,19 +105,11 @@ Set the texture coordinate mode. Each texture param (from the PARAM\_\* enum) ha
Return the texture coordinate mode. Each texture param (from the PARAM\_\* enum) has one. It defines how the textures are mapped to the object.
.. _class_FixedMaterial_set_fixed_flag:
.. _class_FixedMaterial_get_texture:
- void **set_fixed_flag** **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` value **)**
- :ref:`Texture<class_texture>` **get_texture** **(** :ref:`int<class_int>` param **)** const
.. _class_FixedMaterial_get_fixed_flag:
- :ref:`bool<class_bool>` **get_fixed_flag** **(** :ref:`int<class_int>` flag **)** const
.. _class_FixedMaterial_set_uv_transform:
- void **set_uv_transform** **(** :ref:`Transform<class_transform>` transform **)**
Sets a special transform used to post-transform UV coordinates of the uv_xform texcoord mode: TEXCOORD_UV_TRANSFORM.
Return a texture. Textures change parameters per texel and are mapped to the model depending on the texcoord mode (see :ref:`set_texcoord_mode<class_FixedMaterial_set_texcoord_mode>`).
.. _class_FixedMaterial_get_uv_transform:
@@ -137,20 +117,40 @@ Sets a special transform used to post-transform UV coordinates of the uv_xform t
Returns the special transform used to post-transform UV coordinates of the uv_xform texcoord mode: TEXCOORD_UV_TRANSFORM.
.. _class_FixedMaterial_set_fixed_flag:
- void **set_fixed_flag** **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` value **)**
.. _class_FixedMaterial_set_light_shader:
- void **set_light_shader** **(** :ref:`int<class_int>` shader **)**
.. _class_FixedMaterial_get_light_shader:
.. _class_FixedMaterial_set_parameter:
- :ref:`int<class_int>` **get_light_shader** **(** **)** const
- void **set_parameter** **(** :ref:`int<class_int>` param, var value **)**
Set a parameter, parameters are defined in the PARAM\_\* enum. The type of each parameter may change, so it's best to check the enum.
.. _class_FixedMaterial_set_point_size:
- void **set_point_size** **(** :ref:`float<class_float>` size **)**
.. _class_FixedMaterial_get_point_size:
.. _class_FixedMaterial_set_texcoord_mode:
- :ref:`float<class_float>` **get_point_size** **(** **)** const
- void **set_texcoord_mode** **(** :ref:`int<class_int>` param, :ref:`int<class_int>` mode **)**
Set the texture coordinate mode. Each texture param (from the PARAM\_\* enum) has one. It defines how the textures are mapped to the object.
.. _class_FixedMaterial_set_texture:
- void **set_texture** **(** :ref:`int<class_int>` param, :ref:`Texture<class_texture>` texture **)**
Set a texture. Textures change parameters per texel and are mapped to the model depending on the texcoord mode (see :ref:`set_texcoord_mode<class_FixedMaterial_set_texcoord_mode>`).
.. _class_FixedMaterial_set_uv_transform:
- void **set_uv_transform** **(** :ref:`Transform<class_transform>` transform **)**
Sets a special transform used to post-transform UV coordinates of the uv_xform texcoord mode: TEXCOORD_UV_TRANSFORM.

202
classes/class_font.rst
View File

@@ -19,48 +19,48 @@ Member Functions
----------------
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`create_from_fnt<class_Font_create_from_fnt>` **(** :ref:`String<class_string>` path **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_height<class_Font_set_height>` **(** :ref:`float<class_float>` px **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_height<class_Font_get_height>` **(** **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_ascent<class_Font_set_ascent>` **(** :ref:`float<class_float>` px **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_ascent<class_Font_get_ascent>` **(** **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_descent<class_Font_get_descent>` **(** **)** const |
| void | :ref:`add_char<class_Font_add_char>` **(** :ref:`int<class_int>` character, :ref:`int<class_int>` texture, :ref:`Rect2<class_rect2>` rect, :ref:`Vector2<class_vector2>` align=Vector2(0,0), :ref:`float<class_float>` advance=-1 **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_kerning_pair<class_Font_add_kerning_pair>` **(** :ref:`int<class_int>` char_a, :ref:`int<class_int>` char_b, :ref:`int<class_int>` kerning **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_kerning_pair<class_Font_get_kerning_pair>` **(** :ref:`int<class_int>` char_a, :ref:`int<class_int>` char_b **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_texture<class_Font_add_texture>` **(** :ref:`Texture<class_texture>` texture **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_char<class_Font_add_char>` **(** :ref:`int<class_int>` character, :ref:`int<class_int>` texture, :ref:`Rect2<class_rect2>` rect, :ref:`Vector2<class_vector2>` align=Vector2(0,0), :ref:`float<class_float>` advance=-1 **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_texture_count<class_Font_get_texture_count>` **(** **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>` | :ref:`get_texture<class_Font_get_texture>` **(** :ref:`int<class_int>` idx **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_char_size<class_Font_get_char_size>` **(** :ref:`int<class_int>` char, :ref:`int<class_int>` next=0 **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_string_size<class_Font_get_string_size>` **(** :ref:`String<class_string>` string **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_distance_field_hint<class_Font_set_distance_field_hint>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_distance_field_hint<class_Font_is_distance_field_hint>` **(** **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_Font_clear>` **(** **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`create_from_fnt<class_Font_create_from_fnt>` **(** :ref:`String<class_string>` path **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`draw<class_Font_draw>` **(** :ref:`RID<class_rid>` canvas_item, :ref:`Vector2<class_vector2>` pos, :ref:`String<class_string>` string, :ref:`Color<class_color>` modulate=Color(1,1,1,1), :ref:`int<class_int>` clip_w=-1 **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`draw_char<class_Font_draw_char>` **(** :ref:`RID<class_rid>` canvas_item, :ref:`Vector2<class_vector2>` pos, :ref:`int<class_int>` char, :ref:`int<class_int>` next=-1, :ref:`Color<class_color>` modulate=Color(1,1,1,1) **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_fallback<class_Font_set_fallback>` **(** :ref:`Object<class_object>` fallback **)** |
| :ref:`float<class_float>` | :ref:`get_ascent<class_Font_get_ascent>` **(** **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_char_size<class_Font_get_char_size>` **(** :ref:`int<class_int>` char, :ref:`int<class_int>` next=0 **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_descent<class_Font_get_descent>` **(** **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>` | :ref:`get_fallback<class_Font_get_fallback>` **(** **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_height<class_Font_get_height>` **(** **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_kerning_pair<class_Font_get_kerning_pair>` **(** :ref:`int<class_int>` char_a, :ref:`int<class_int>` char_b **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_string_size<class_Font_get_string_size>` **(** :ref:`String<class_string>` string **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>` | :ref:`get_texture<class_Font_get_texture>` **(** :ref:`int<class_int>` idx **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_texture_count<class_Font_get_texture_count>` **(** **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_distance_field_hint<class_Font_is_distance_field_hint>` **(** **)** const |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_ascent<class_Font_set_ascent>` **(** :ref:`float<class_float>` px **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_distance_field_hint<class_Font_set_distance_field_hint>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_fallback<class_Font_set_fallback>` **(** :ref:`Object<class_object>` fallback **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_height<class_Font_set_height>` **(** :ref:`float<class_float>` px **)** |
+--------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Description
-----------
@@ -70,39 +70,11 @@ Font contains an unicode compatible character set, as well as the ability to dra
Member Function Description
---------------------------
.. _class_Font_create_from_fnt:
.. _class_Font_add_char:
- :ref:`int<class_int>` **create_from_fnt** **(** :ref:`String<class_string>` path **)**
- void **add_char** **(** :ref:`int<class_int>` character, :ref:`int<class_int>` texture, :ref:`Rect2<class_rect2>` rect, :ref:`Vector2<class_vector2>` align=Vector2(0,0), :ref:`float<class_float>` advance=-1 **)**
.. _class_Font_set_height:
- void **set_height** **(** :ref:`float<class_float>` px **)**
Set the total font height (ascent plus descent) in pixels.
.. _class_Font_get_height:
- :ref:`float<class_float>` **get_height** **(** **)** const
Return the total font height (ascent plus descent) in pixels.
.. _class_Font_set_ascent:
- void **set_ascent** **(** :ref:`float<class_float>` px **)**
Set the font ascent (number of pixels above the baseline).
.. _class_Font_get_ascent:
- :ref:`float<class_float>` **get_ascent** **(** **)** const
Return the font ascent (number of pixels above the baseline).
.. _class_Font_get_descent:
- :ref:`float<class_float>` **get_descent** **(** **)** const
Return the font descent (number of pixels below the baseline).
Add a character to the font, where "character" is the unicode value, "texture" is the texture index, "rect" is the region in the texture (in pixels!), "align" is the (optional) alignment for the character and "advance" is the (optional) advance.
.. _class_Font_add_kerning_pair:
@@ -110,58 +82,22 @@ Return the font descent (number of pixels below the baseline).
Add a kerning pair to the :ref:`Font<class_font>` as a difference. Kerning pairs are special cases where a typeface advance is determined by the next character.
.. _class_Font_get_kerning_pair:
- :ref:`int<class_int>` **get_kerning_pair** **(** :ref:`int<class_int>` char_a, :ref:`int<class_int>` char_b **)** const
Return a kerning pair as a difference. Kerning pairs are special cases where a typeface advance is determined by the next character.
.. _class_Font_add_texture:
- void **add_texture** **(** :ref:`Texture<class_texture>` texture **)**
Add a texture to the :ref:`Font<class_font>`.
.. _class_Font_add_char:
- void **add_char** **(** :ref:`int<class_int>` character, :ref:`int<class_int>` texture, :ref:`Rect2<class_rect2>` rect, :ref:`Vector2<class_vector2>` align=Vector2(0,0), :ref:`float<class_float>` advance=-1 **)**
Add a character to the font, where "character" is the unicode value, "texture" is the texture index, "rect" is the region in the texture (in pixels!), "align" is the (optional) alignment for the character and "advance" is the (optional) advance.
.. _class_Font_get_texture_count:
- :ref:`int<class_int>` **get_texture_count** **(** **)** const
.. _class_Font_get_texture:
- :ref:`Texture<class_texture>` **get_texture** **(** :ref:`int<class_int>` idx **)** const
.. _class_Font_get_char_size:
- :ref:`Vector2<class_vector2>` **get_char_size** **(** :ref:`int<class_int>` char, :ref:`int<class_int>` next=0 **)** const
Return the size of a character, optionally taking kerning into account if the next character is provided.
.. _class_Font_get_string_size:
- :ref:`Vector2<class_vector2>` **get_string_size** **(** :ref:`String<class_string>` string **)** const
Return the size of a string, taking kerning and advance into account.
.. _class_Font_set_distance_field_hint:
- void **set_distance_field_hint** **(** :ref:`bool<class_bool>` enable **)**
.. _class_Font_is_distance_field_hint:
- :ref:`bool<class_bool>` **is_distance_field_hint** **(** **)** const
.. _class_Font_clear:
- void **clear** **(** **)**
Clear all the font data.
.. _class_Font_create_from_fnt:
- :ref:`int<class_int>` **create_from_fnt** **(** :ref:`String<class_string>` path **)**
.. _class_Font_draw:
- void **draw** **(** :ref:`RID<class_rid>` canvas_item, :ref:`Vector2<class_vector2>` pos, :ref:`String<class_string>` string, :ref:`Color<class_color>` modulate=Color(1,1,1,1), :ref:`int<class_int>` clip_w=-1 **)** const
@@ -174,12 +110,76 @@ Draw "string" into a canvas item using the font at a given "pos" position, with
Draw character "char" into a canvas item using the font at a given "pos" position, with "modulate" color, and optionally kerning if "next" is passed. clipping the width. "pos" specifies the baseline, not the top. To draw from the top, *ascent* must be added to the Y axis. The width used by the character is returned, making this function useful for drawing strings character by character.
.. _class_Font_set_fallback:
.. _class_Font_get_ascent:
- void **set_fallback** **(** :ref:`Object<class_object>` fallback **)**
- :ref:`float<class_float>` **get_ascent** **(** **)** const
Return the font ascent (number of pixels above the baseline).
.. _class_Font_get_char_size:
- :ref:`Vector2<class_vector2>` **get_char_size** **(** :ref:`int<class_int>` char, :ref:`int<class_int>` next=0 **)** const
Return the size of a character, optionally taking kerning into account if the next character is provided.
.. _class_Font_get_descent:
- :ref:`float<class_float>` **get_descent** **(** **)** const
Return the font descent (number of pixels below the baseline).
.. _class_Font_get_fallback:
- :ref:`Object<class_object>` **get_fallback** **(** **)** const
.. _class_Font_get_height:
- :ref:`float<class_float>` **get_height** **(** **)** const
Return the total font height (ascent plus descent) in pixels.
.. _class_Font_get_kerning_pair:
- :ref:`int<class_int>` **get_kerning_pair** **(** :ref:`int<class_int>` char_a, :ref:`int<class_int>` char_b **)** const
Return a kerning pair as a difference. Kerning pairs are special cases where a typeface advance is determined by the next character.
.. _class_Font_get_string_size:
- :ref:`Vector2<class_vector2>` **get_string_size** **(** :ref:`String<class_string>` string **)** const
Return the size of a string, taking kerning and advance into account.
.. _class_Font_get_texture:
- :ref:`Texture<class_texture>` **get_texture** **(** :ref:`int<class_int>` idx **)** const
.. _class_Font_get_texture_count:
- :ref:`int<class_int>` **get_texture_count** **(** **)** const
.. _class_Font_is_distance_field_hint:
- :ref:`bool<class_bool>` **is_distance_field_hint** **(** **)** const
.. _class_Font_set_ascent:
- void **set_ascent** **(** :ref:`float<class_float>` px **)**
Set the font ascent (number of pixels above the baseline).
.. _class_Font_set_distance_field_hint:
- void **set_distance_field_hint** **(** :ref:`bool<class_bool>` enable **)**
.. _class_Font_set_fallback:
- void **set_fallback** **(** :ref:`Object<class_object>` fallback **)**
.. _class_Font_set_height:
- void **set_height** **(** :ref:`float<class_float>` px **)**
Set the total font height (ascent plus descent) in pixels.

12
classes/class_funcref.rst
View File

@@ -21,10 +21,10 @@ Member Functions
+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`call_func<class_FuncRef_call_func>` **(** var arg0=NULL, var arg1=NULL, var arg2=NULL, var arg3=NULL, var arg4=NULL, var arg5=NULL, var arg6=NULL, var arg7=NULL, var arg8=NULL, var arg9=NULL **)** |
+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_instance<class_FuncRef_set_instance>` **(** :ref:`Object<class_object>` instance **)** |
+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_function<class_FuncRef_set_function>` **(** :ref:`String<class_string>` name **)** |
+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_instance<class_FuncRef_set_instance>` **(** :ref:`Object<class_object>` instance **)** |
+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Member Function Description
---------------------------
@@ -33,12 +33,12 @@ Member Function Description
- void **call_func** **(** var arg0=NULL, var arg1=NULL, var arg2=NULL, var arg3=NULL, var arg4=NULL, var arg5=NULL, var arg6=NULL, var arg7=NULL, var arg8=NULL, var arg9=NULL **)**
.. _class_FuncRef_set_instance:
- void **set_instance** **(** :ref:`Object<class_object>` instance **)**
.. _class_FuncRef_set_function:
- void **set_function** **(** :ref:`String<class_string>` name **)**
.. _class_FuncRef_set_instance:
- void **set_instance** **(** :ref:`Object<class_object>` instance **)**

12
classes/class_gdfunctionstate.rst
View File

@@ -18,23 +18,23 @@ Brief Description
Member Functions
----------------
+--------------------------+------------------------------------------------------------------------+
| Variant | :ref:`resume<class_GDFunctionState_resume>` **(** var arg=NULL **)** |
+--------------------------+------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_valid<class_GDFunctionState_is_valid>` **(** **)** const |
+--------------------------+------------------------------------------------------------------------+
| Variant | :ref:`resume<class_GDFunctionState_resume>` **(** var arg=NULL **)** |
+--------------------------+------------------------------------------------------------------------+
Member Function Description
---------------------------
.. _class_GDFunctionState_resume:
- Variant **resume** **(** var arg=NULL **)**
.. _class_GDFunctionState_is_valid:
- :ref:`bool<class_bool>` **is_valid** **(** **)** const
Should put children to the top left corner instead of center of the container.
.. _class_GDFunctionState_resume:
- Variant **resume** **(** var arg=NULL **)**

12
classes/class_gdscript.rst
View File

@@ -18,21 +18,21 @@ Brief Description
Member Functions
----------------
+----------------------------------+-----------------------------------------------------------------------------+
| void | :ref:`new<class_GDScript_new>` **(** **)** |
+----------------------------------+-----------------------------------------------------------------------------+
| :ref:`RawArray<class_rawarray>` | :ref:`get_as_byte_code<class_GDScript_get_as_byte_code>` **(** **)** const |
+----------------------------------+-----------------------------------------------------------------------------+
| void | :ref:`new<class_GDScript_new>` **(** **)** |
+----------------------------------+-----------------------------------------------------------------------------+
Member Function Description
---------------------------
.. _class_GDScript_new:
- void **new** **(** **)**
.. _class_GDScript_get_as_byte_code:
- :ref:`RawArray<class_rawarray>` **get_as_byte_code** **(** **)** const
.. _class_GDScript_new:
- void **new** **(** **)**

78
classes/class_generic6dofjoint.rst
View File

@@ -19,36 +19,45 @@ Member Functions
----------------
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_param_x<class_Generic6DOFJoint_set_param_x>` **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)** |
| :ref:`bool<class_bool>` | :ref:`get_flag_x<class_Generic6DOFJoint_get_flag_x>` **(** :ref:`int<class_int>` flag **)** const |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_flag_y<class_Generic6DOFJoint_get_flag_y>` **(** :ref:`int<class_int>` flag **)** const |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_flag_z<class_Generic6DOFJoint_get_flag_z>` **(** :ref:`int<class_int>` flag **)** const |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_param_x<class_Generic6DOFJoint_get_param_x>` **(** :ref:`int<class_int>` param **)** const |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_param_y<class_Generic6DOFJoint_set_param_y>` **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_param_y<class_Generic6DOFJoint_get_param_y>` **(** :ref:`int<class_int>` param **)** const |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_param_z<class_Generic6DOFJoint_set_param_z>` **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_param_z<class_Generic6DOFJoint_get_param_z>` **(** :ref:`int<class_int>` param **)** const |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_flag_x<class_Generic6DOFJoint_set_flag_x>` **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` value **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_flag_x<class_Generic6DOFJoint_get_flag_x>` **(** :ref:`int<class_int>` flag **)** const |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_flag_y<class_Generic6DOFJoint_set_flag_y>` **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` value **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_flag_y<class_Generic6DOFJoint_get_flag_y>` **(** :ref:`int<class_int>` flag **)** const |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_flag_z<class_Generic6DOFJoint_set_flag_z>` **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` value **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_flag_z<class_Generic6DOFJoint_get_flag_z>` **(** :ref:`int<class_int>` flag **)** const |
| void | :ref:`set_param_x<class_Generic6DOFJoint_set_param_x>` **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_param_y<class_Generic6DOFJoint_set_param_y>` **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_param_z<class_Generic6DOFJoint_set_param_z>` **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)** |
+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
Numeric Constants
-----------------
- **FLAG_ENABLE_LINEAR_LIMIT** = **0**
- **FLAG_ENABLE_ANGULAR_LIMIT** = **1**
- **FLAG_ENABLE_MOTOR** = **2**
- **FLAG_MAX** = **3**
- **PARAM_LINEAR_LOWER_LIMIT** = **0**
- **PARAM_LINEAR_UPPER_LIMIT** = **1**
- **PARAM_ANGULAR_FORCE_LIMIT** = **10**
- **PARAM_ANGULAR_ERP** = **11**
- **PARAM_ANGULAR_MOTOR_TARGET_VELOCITY** = **12**
- **PARAM_ANGULAR_MOTOR_FORCE_LIMIT** = **13**
- **PARAM_MAX** = **14**
- **PARAM_LINEAR_LIMIT_SOFTNESS** = **2**
- **PARAM_LINEAR_RESTITUTION** = **3**
- **PARAM_LINEAR_DAMPING** = **4**
@@ -57,39 +66,30 @@ Numeric Constants
- **PARAM_ANGULAR_LIMIT_SOFTNESS** = **7**
- **PARAM_ANGULAR_DAMPING** = **8**
- **PARAM_ANGULAR_RESTITUTION** = **9**
- **PARAM_ANGULAR_FORCE_LIMIT** = **10**
- **PARAM_ANGULAR_ERP** = **11**
- **PARAM_ANGULAR_MOTOR_TARGET_VELOCITY** = **12**
- **PARAM_ANGULAR_MOTOR_FORCE_LIMIT** = **13**
- **PARAM_MAX** = **14**
- **FLAG_ENABLE_LINEAR_LIMIT** = **0**
- **FLAG_ENABLE_ANGULAR_LIMIT** = **1**
- **FLAG_ENABLE_MOTOR** = **2**
- **FLAG_MAX** = **3**
Member Function Description
---------------------------
.. _class_Generic6DOFJoint_set_param_x:
.. _class_Generic6DOFJoint_get_flag_x:
- void **set_param_x** **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)**
- :ref:`bool<class_bool>` **get_flag_x** **(** :ref:`int<class_int>` flag **)** const
.. _class_Generic6DOFJoint_get_flag_y:
- :ref:`bool<class_bool>` **get_flag_y** **(** :ref:`int<class_int>` flag **)** const
.. _class_Generic6DOFJoint_get_flag_z:
- :ref:`bool<class_bool>` **get_flag_z** **(** :ref:`int<class_int>` flag **)** const
.. _class_Generic6DOFJoint_get_param_x:
- :ref:`float<class_float>` **get_param_x** **(** :ref:`int<class_int>` param **)** const
.. _class_Generic6DOFJoint_set_param_y:
- void **set_param_y** **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)**
.. _class_Generic6DOFJoint_get_param_y:
- :ref:`float<class_float>` **get_param_y** **(** :ref:`int<class_int>` param **)** const
.. _class_Generic6DOFJoint_set_param_z:
- void **set_param_z** **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)**
.. _class_Generic6DOFJoint_get_param_z:
- :ref:`float<class_float>` **get_param_z** **(** :ref:`int<class_int>` param **)** const
@@ -98,24 +98,24 @@ Member Function Description
- void **set_flag_x** **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` value **)**
.. _class_Generic6DOFJoint_get_flag_x:
- :ref:`bool<class_bool>` **get_flag_x** **(** :ref:`int<class_int>` flag **)** const
.. _class_Generic6DOFJoint_set_flag_y:
- void **set_flag_y** **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` value **)**
.. _class_Generic6DOFJoint_get_flag_y:
- :ref:`bool<class_bool>` **get_flag_y** **(** :ref:`int<class_int>` flag **)** const
.. _class_Generic6DOFJoint_set_flag_z:
- void **set_flag_z** **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` value **)**
.. _class_Generic6DOFJoint_get_flag_z:
.. _class_Generic6DOFJoint_set_param_x:
- :ref:`bool<class_bool>` **get_flag_z** **(** :ref:`int<class_int>` flag **)** const
- void **set_param_x** **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)**
.. _class_Generic6DOFJoint_set_param_y:
- void **set_param_y** **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)**
.. _class_Generic6DOFJoint_set_param_z:
- void **set_param_z** **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)**

132
classes/class_geometry.rst
View File

@@ -21,37 +21,37 @@ Member Functions
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`build_box_planes<class_Geometry_build_box_planes>` **(** :ref:`Vector3<class_vector3>` extents **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`build_cylinder_planes<class_Geometry_build_cylinder_planes>` **(** :ref:`float<class_float>` radius, :ref:`float<class_float>` height, :ref:`int<class_int>` sides, :ref:`int<class_int>` axis=2 **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`build_capsule_planes<class_Geometry_build_capsule_planes>` **(** :ref:`float<class_float>` radius, :ref:`float<class_float>` height, :ref:`int<class_int>` sides, :ref:`int<class_int>` lats, :ref:`int<class_int>` axis=2 **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`segment_intersects_circle<class_Geometry_segment_intersects_circle>` **(** :ref:`Vector2<class_vector2>` segment_from, :ref:`Vector2<class_vector2>` segment_to, :ref:`Vector2<class_vector2>` circle_pos, :ref:`float<class_float>` circle_radius **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`segment_intersects_segment_2d<class_Geometry_segment_intersects_segment_2d>` **(** :ref:`Vector2<class_vector2>` from_a, :ref:`Vector2<class_vector2>` to_a, :ref:`Vector2<class_vector2>` from_b, :ref:`Vector2<class_vector2>` to_b **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2Array<class_vector2array>` | :ref:`get_closest_points_between_segments_2d<class_Geometry_get_closest_points_between_segments_2d>` **(** :ref:`Vector2<class_vector2>` p1, :ref:`Vector2<class_vector2>` q1, :ref:`Vector2<class_vector2>` p2, :ref:`Vector2<class_vector2>` q2 **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3Array<class_vector3array>` | :ref:`get_closest_points_between_segments<class_Geometry_get_closest_points_between_segments>` **(** :ref:`Vector3<class_vector3>` p1, :ref:`Vector3<class_vector3>` p2, :ref:`Vector3<class_vector3>` q1, :ref:`Vector3<class_vector3>` q2 **)** |
| :ref:`Array<class_array>` | :ref:`build_cylinder_planes<class_Geometry_build_cylinder_planes>` **(** :ref:`float<class_float>` radius, :ref:`float<class_float>` height, :ref:`int<class_int>` sides, :ref:`int<class_int>` axis=2 **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_closest_point_to_segment<class_Geometry_get_closest_point_to_segment>` **(** :ref:`Vector3<class_vector3>` point, :ref:`Vector3<class_vector3>` s1, :ref:`Vector3<class_vector3>` s2 **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3Array<class_vector3array>` | :ref:`get_closest_points_between_segments<class_Geometry_get_closest_points_between_segments>` **(** :ref:`Vector3<class_vector3>` p1, :ref:`Vector3<class_vector3>` p2, :ref:`Vector3<class_vector3>` q1, :ref:`Vector3<class_vector3>` q2 **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2Array<class_vector2array>` | :ref:`get_closest_points_between_segments_2d<class_Geometry_get_closest_points_between_segments_2d>` **(** :ref:`Vector2<class_vector2>` p1, :ref:`Vector2<class_vector2>` q1, :ref:`Vector2<class_vector2>` p2, :ref:`Vector2<class_vector2>` q2 **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_uv84_normal_bit<class_Geometry_get_uv84_normal_bit>` **(** :ref:`Vector3<class_vector3>` normal **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`ray_intersects_triangle<class_Geometry_ray_intersects_triangle>` **(** :ref:`Vector3<class_vector3>` from, :ref:`Vector3<class_vector3>` dir, :ref:`Vector3<class_vector3>` a, :ref:`Vector3<class_vector3>` b, :ref:`Vector3<class_vector3>` c **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`segment_intersects_triangle<class_Geometry_segment_intersects_triangle>` **(** :ref:`Vector3<class_vector3>` from, :ref:`Vector3<class_vector3>` to, :ref:`Vector3<class_vector3>` a, :ref:`Vector3<class_vector3>` b, :ref:`Vector3<class_vector3>` c **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3Array<class_vector3array>` | :ref:`segment_intersects_sphere<class_Geometry_segment_intersects_sphere>` **(** :ref:`Vector3<class_vector3>` from, :ref:`Vector3<class_vector3>` to, :ref:`Vector3<class_vector3>` spos, :ref:`float<class_float>` sradius **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3Array<class_vector3array>` | :ref:`segment_intersects_cylinder<class_Geometry_segment_intersects_cylinder>` **(** :ref:`Vector3<class_vector3>` from, :ref:`Vector3<class_vector3>` to, :ref:`float<class_float>` height, :ref:`float<class_float>` radius **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3Array<class_vector3array>` | :ref:`segment_intersects_convex<class_Geometry_segment_intersects_convex>` **(** :ref:`Vector3<class_vector3>` from, :ref:`Vector3<class_vector3>` to, :ref:`Array<class_array>` planes **)** |
| :ref:`Dictionary<class_dictionary>` | :ref:`make_atlas<class_Geometry_make_atlas>` **(** :ref:`Vector2Array<class_vector2array>` sizes **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`point_is_inside_triangle<class_Geometry_point_is_inside_triangle>` **(** :ref:`Vector2<class_vector2>` point, :ref:`Vector2<class_vector2>` a, :ref:`Vector2<class_vector2>` b, :ref:`Vector2<class_vector2>` c **)** const |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`IntArray<class_intarray>` | :ref:`triangulate_polygon<class_Geometry_triangulate_polygon>` **(** :ref:`Vector2Array<class_vector2array>` polygon **)** |
| void | :ref:`ray_intersects_triangle<class_Geometry_ray_intersects_triangle>` **(** :ref:`Vector3<class_vector3>` from, :ref:`Vector3<class_vector3>` dir, :ref:`Vector3<class_vector3>` a, :ref:`Vector3<class_vector3>` b, :ref:`Vector3<class_vector3>` c **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_dictionary>` | :ref:`make_atlas<class_Geometry_make_atlas>` **(** :ref:`Vector2Array<class_vector2array>` sizes **)** |
| :ref:`float<class_float>` | :ref:`segment_intersects_circle<class_Geometry_segment_intersects_circle>` **(** :ref:`Vector2<class_vector2>` segment_from, :ref:`Vector2<class_vector2>` segment_to, :ref:`Vector2<class_vector2>` circle_pos, :ref:`float<class_float>` circle_radius **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3Array<class_vector3array>` | :ref:`segment_intersects_convex<class_Geometry_segment_intersects_convex>` **(** :ref:`Vector3<class_vector3>` from, :ref:`Vector3<class_vector3>` to, :ref:`Array<class_array>` planes **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3Array<class_vector3array>` | :ref:`segment_intersects_cylinder<class_Geometry_segment_intersects_cylinder>` **(** :ref:`Vector3<class_vector3>` from, :ref:`Vector3<class_vector3>` to, :ref:`float<class_float>` height, :ref:`float<class_float>` radius **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`segment_intersects_segment_2d<class_Geometry_segment_intersects_segment_2d>` **(** :ref:`Vector2<class_vector2>` from_a, :ref:`Vector2<class_vector2>` to_a, :ref:`Vector2<class_vector2>` from_b, :ref:`Vector2<class_vector2>` to_b **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3Array<class_vector3array>` | :ref:`segment_intersects_sphere<class_Geometry_segment_intersects_sphere>` **(** :ref:`Vector3<class_vector3>` from, :ref:`Vector3<class_vector3>` to, :ref:`Vector3<class_vector3>` spos, :ref:`float<class_float>` sradius **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`segment_intersects_triangle<class_Geometry_segment_intersects_triangle>` **(** :ref:`Vector3<class_vector3>` from, :ref:`Vector3<class_vector3>` to, :ref:`Vector3<class_vector3>` a, :ref:`Vector3<class_vector3>` b, :ref:`Vector3<class_vector3>` c **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`IntArray<class_intarray>` | :ref:`triangulate_polygon<class_Geometry_triangulate_polygon>` **(** :ref:`Vector2Array<class_vector2array>` polygon **)** |
+------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Member Function Description
@@ -61,68 +61,68 @@ Member Function Description
- :ref:`Array<class_array>` **build_box_planes** **(** :ref:`Vector3<class_vector3>` extents **)**
.. _class_Geometry_build_cylinder_planes:
- :ref:`Array<class_array>` **build_cylinder_planes** **(** :ref:`float<class_float>` radius, :ref:`float<class_float>` height, :ref:`int<class_int>` sides, :ref:`int<class_int>` axis=2 **)**
.. _class_Geometry_build_capsule_planes:
- :ref:`Array<class_array>` **build_capsule_planes** **(** :ref:`float<class_float>` radius, :ref:`float<class_float>` height, :ref:`int<class_int>` sides, :ref:`int<class_int>` lats, :ref:`int<class_int>` axis=2 **)**
.. _class_Geometry_segment_intersects_circle:
.. _class_Geometry_build_cylinder_planes:
- :ref:`float<class_float>` **segment_intersects_circle** **(** :ref:`Vector2<class_vector2>` segment_from, :ref:`Vector2<class_vector2>` segment_to, :ref:`Vector2<class_vector2>` circle_pos, :ref:`float<class_float>` circle_radius **)**
.. _class_Geometry_segment_intersects_segment_2d:
- void **segment_intersects_segment_2d** **(** :ref:`Vector2<class_vector2>` from_a, :ref:`Vector2<class_vector2>` to_a, :ref:`Vector2<class_vector2>` from_b, :ref:`Vector2<class_vector2>` to_b **)**
.. _class_Geometry_get_closest_points_between_segments_2d:
- :ref:`Vector2Array<class_vector2array>` **get_closest_points_between_segments_2d** **(** :ref:`Vector2<class_vector2>` p1, :ref:`Vector2<class_vector2>` q1, :ref:`Vector2<class_vector2>` p2, :ref:`Vector2<class_vector2>` q2 **)**
.. _class_Geometry_get_closest_points_between_segments:
- :ref:`Vector3Array<class_vector3array>` **get_closest_points_between_segments** **(** :ref:`Vector3<class_vector3>` p1, :ref:`Vector3<class_vector3>` p2, :ref:`Vector3<class_vector3>` q1, :ref:`Vector3<class_vector3>` q2 **)**
- :ref:`Array<class_array>` **build_cylinder_planes** **(** :ref:`float<class_float>` radius, :ref:`float<class_float>` height, :ref:`int<class_int>` sides, :ref:`int<class_int>` axis=2 **)**
.. _class_Geometry_get_closest_point_to_segment:
- :ref:`Vector3<class_vector3>` **get_closest_point_to_segment** **(** :ref:`Vector3<class_vector3>` point, :ref:`Vector3<class_vector3>` s1, :ref:`Vector3<class_vector3>` s2 **)**
.. _class_Geometry_get_closest_points_between_segments:
- :ref:`Vector3Array<class_vector3array>` **get_closest_points_between_segments** **(** :ref:`Vector3<class_vector3>` p1, :ref:`Vector3<class_vector3>` p2, :ref:`Vector3<class_vector3>` q1, :ref:`Vector3<class_vector3>` q2 **)**
.. _class_Geometry_get_closest_points_between_segments_2d:
- :ref:`Vector2Array<class_vector2array>` **get_closest_points_between_segments_2d** **(** :ref:`Vector2<class_vector2>` p1, :ref:`Vector2<class_vector2>` q1, :ref:`Vector2<class_vector2>` p2, :ref:`Vector2<class_vector2>` q2 **)**
.. _class_Geometry_get_uv84_normal_bit:
- :ref:`int<class_int>` **get_uv84_normal_bit** **(** :ref:`Vector3<class_vector3>` normal **)**
.. _class_Geometry_ray_intersects_triangle:
- void **ray_intersects_triangle** **(** :ref:`Vector3<class_vector3>` from, :ref:`Vector3<class_vector3>` dir, :ref:`Vector3<class_vector3>` a, :ref:`Vector3<class_vector3>` b, :ref:`Vector3<class_vector3>` c **)**
.. _class_Geometry_segment_intersects_triangle:
- void **segment_intersects_triangle** **(** :ref:`Vector3<class_vector3>` from, :ref:`Vector3<class_vector3>` to, :ref:`Vector3<class_vector3>` a, :ref:`Vector3<class_vector3>` b, :ref:`Vector3<class_vector3>` c **)**
.. _class_Geometry_segment_intersects_sphere:
- :ref:`Vector3Array<class_vector3array>` **segment_intersects_sphere** **(** :ref:`Vector3<class_vector3>` from, :ref:`Vector3<class_vector3>` to, :ref:`Vector3<class_vector3>` spos, :ref:`float<class_float>` sradius **)**
.. _class_Geometry_segment_intersects_cylinder:
- :ref:`Vector3Array<class_vector3array>` **segment_intersects_cylinder** **(** :ref:`Vector3<class_vector3>` from, :ref:`Vector3<class_vector3>` to, :ref:`float<class_float>` height, :ref:`float<class_float>` radius **)**
.. _class_Geometry_segment_intersects_convex:
- :ref:`Vector3Array<class_vector3array>` **segment_intersects_convex** **(** :ref:`Vector3<class_vector3>` from, :ref:`Vector3<class_vector3>` to, :ref:`Array<class_array>` planes **)**
.. _class_Geometry_point_is_inside_triangle:
- :ref:`bool<class_bool>` **point_is_inside_triangle** **(** :ref:`Vector2<class_vector2>` point, :ref:`Vector2<class_vector2>` a, :ref:`Vector2<class_vector2>` b, :ref:`Vector2<class_vector2>` c **)** const
.. _class_Geometry_triangulate_polygon:
- :ref:`IntArray<class_intarray>` **triangulate_polygon** **(** :ref:`Vector2Array<class_vector2array>` polygon **)**
.. _class_Geometry_make_atlas:
- :ref:`Dictionary<class_dictionary>` **make_atlas** **(** :ref:`Vector2Array<class_vector2array>` sizes **)**
.. _class_Geometry_point_is_inside_triangle:
- :ref:`bool<class_bool>` **point_is_inside_triangle** **(** :ref:`Vector2<class_vector2>` point, :ref:`Vector2<class_vector2>` a, :ref:`Vector2<class_vector2>` b, :ref:`Vector2<class_vector2>` c **)** const
.. _class_Geometry_ray_intersects_triangle:
- void **ray_intersects_triangle** **(** :ref:`Vector3<class_vector3>` from, :ref:`Vector3<class_vector3>` dir, :ref:`Vector3<class_vector3>` a, :ref:`Vector3<class_vector3>` b, :ref:`Vector3<class_vector3>` c **)**
.. _class_Geometry_segment_intersects_circle:
- :ref:`float<class_float>` **segment_intersects_circle** **(** :ref:`Vector2<class_vector2>` segment_from, :ref:`Vector2<class_vector2>` segment_to, :ref:`Vector2<class_vector2>` circle_pos, :ref:`float<class_float>` circle_radius **)**
.. _class_Geometry_segment_intersects_convex:
- :ref:`Vector3Array<class_vector3array>` **segment_intersects_convex** **(** :ref:`Vector3<class_vector3>` from, :ref:`Vector3<class_vector3>` to, :ref:`Array<class_array>` planes **)**
.. _class_Geometry_segment_intersects_cylinder:
- :ref:`Vector3Array<class_vector3array>` **segment_intersects_cylinder** **(** :ref:`Vector3<class_vector3>` from, :ref:`Vector3<class_vector3>` to, :ref:`float<class_float>` height, :ref:`float<class_float>` radius **)**
.. _class_Geometry_segment_intersects_segment_2d:
- void **segment_intersects_segment_2d** **(** :ref:`Vector2<class_vector2>` from_a, :ref:`Vector2<class_vector2>` to_a, :ref:`Vector2<class_vector2>` from_b, :ref:`Vector2<class_vector2>` to_b **)**
.. _class_Geometry_segment_intersects_sphere:
- :ref:`Vector3Array<class_vector3array>` **segment_intersects_sphere** **(** :ref:`Vector3<class_vector3>` from, :ref:`Vector3<class_vector3>` to, :ref:`Vector3<class_vector3>` spos, :ref:`float<class_float>` sradius **)**
.. _class_Geometry_segment_intersects_triangle:
- void **segment_intersects_triangle** **(** :ref:`Vector3<class_vector3>` from, :ref:`Vector3<class_vector3>` to, :ref:`Vector3<class_vector3>` a, :ref:`Vector3<class_vector3>` b, :ref:`Vector3<class_vector3>` c **)**
.. _class_Geometry_triangulate_polygon:
- :ref:`IntArray<class_intarray>` **triangulate_polygon** **(** :ref:`Vector2Array<class_vector2array>` polygon **)**

84
classes/class_geometryinstance.rst
View File

@@ -21,39 +21,39 @@ Member Functions
----------------
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_material_override<class_GeometryInstance_set_material_override>` **(** :ref:`Object<class_object>` material **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>` | :ref:`get_material_override<class_GeometryInstance_get_material_override>` **(** **)** const |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_flag<class_GeometryInstance_set_flag>` **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` value **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_flag<class_GeometryInstance_get_flag>` **(** :ref:`int<class_int>` flag **)** const |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_draw_range_begin<class_GeometryInstance_set_draw_range_begin>` **(** :ref:`float<class_float>` mode **)** |
| :ref:`int<class_int>` | :ref:`get_baked_light_texture_id<class_GeometryInstance_get_baked_light_texture_id>` **(** **)** const |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_draw_range_begin<class_GeometryInstance_get_draw_range_begin>` **(** **)** const |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_draw_range_end<class_GeometryInstance_set_draw_range_end>` **(** :ref:`float<class_float>` mode **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_draw_range_end<class_GeometryInstance_get_draw_range_end>` **(** **)** const |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_extra_cull_margin<class_GeometryInstance_get_extra_cull_margin>` **(** **)** const |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_flag<class_GeometryInstance_get_flag>` **(** :ref:`int<class_int>` flag **)** const |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>` | :ref:`get_material_override<class_GeometryInstance_get_material_override>` **(** **)** const |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_baked_light_texture_id<class_GeometryInstance_set_baked_light_texture_id>` **(** :ref:`int<class_int>` id **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_baked_light_texture_id<class_GeometryInstance_get_baked_light_texture_id>` **(** **)** const |
| void | :ref:`set_draw_range_begin<class_GeometryInstance_set_draw_range_begin>` **(** :ref:`float<class_float>` mode **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_draw_range_end<class_GeometryInstance_set_draw_range_end>` **(** :ref:`float<class_float>` mode **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_extra_cull_margin<class_GeometryInstance_set_extra_cull_margin>` **(** :ref:`float<class_float>` margin **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_extra_cull_margin<class_GeometryInstance_get_extra_cull_margin>` **(** **)** const |
| void | :ref:`set_flag<class_GeometryInstance_set_flag>` **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` value **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_material_override<class_GeometryInstance_set_material_override>` **(** :ref:`Object<class_object>` material **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------+
Numeric Constants
-----------------
- **FLAG_VISIBLE** = **0**
- **FLAG_CAST_SHADOW** = **3**
- **FLAG_RECEIVE_SHADOWS** = **4**
- **FLAG_BILLBOARD** = **1**
- **FLAG_BILLBOARD_FIX_Y** = **2**
- **FLAG_CAST_SHADOW** = **3**
- **FLAG_RECEIVE_SHADOWS** = **4**
- **FLAG_DEPH_SCALE** = **5**
- **FLAG_VISIBLE_IN_ALL_ROOMS** = **6**
- **FLAG_MAX** = **8**
@@ -66,11 +66,25 @@ Base node for geometry based visual instances. Shares some common functionality
Member Function Description
---------------------------
.. _class_GeometryInstance_set_material_override:
.. _class_GeometryInstance_get_baked_light_texture_id:
- void **set_material_override** **(** :ref:`Object<class_object>` material **)**
- :ref:`int<class_int>` **get_baked_light_texture_id** **(** **)** const
Set the material override for the whole geometry.
.. _class_GeometryInstance_get_draw_range_begin:
- :ref:`float<class_float>` **get_draw_range_begin** **(** **)** const
.. _class_GeometryInstance_get_draw_range_end:
- :ref:`float<class_float>` **get_draw_range_end** **(** **)** const
.. _class_GeometryInstance_get_extra_cull_margin:
- :ref:`float<class_float>` **get_extra_cull_margin** **(** **)** const
.. _class_GeometryInstance_get_flag:
- :ref:`bool<class_bool>` **get_flag** **(** :ref:`int<class_int>` flag **)** const
.. _class_GeometryInstance_get_material_override:
@@ -78,44 +92,30 @@ Set the material override for the whole geometry.
Return the material override for the whole geometry.
.. _class_GeometryInstance_set_flag:
.. _class_GeometryInstance_set_baked_light_texture_id:
- void **set_flag** **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` value **)**
.. _class_GeometryInstance_get_flag:
- :ref:`bool<class_bool>` **get_flag** **(** :ref:`int<class_int>` flag **)** const
- void **set_baked_light_texture_id** **(** :ref:`int<class_int>` id **)**
.. _class_GeometryInstance_set_draw_range_begin:
- void **set_draw_range_begin** **(** :ref:`float<class_float>` mode **)**
.. _class_GeometryInstance_get_draw_range_begin:
- :ref:`float<class_float>` **get_draw_range_begin** **(** **)** const
.. _class_GeometryInstance_set_draw_range_end:
- void **set_draw_range_end** **(** :ref:`float<class_float>` mode **)**
.. _class_GeometryInstance_get_draw_range_end:
- :ref:`float<class_float>` **get_draw_range_end** **(** **)** const
.. _class_GeometryInstance_set_baked_light_texture_id:
- void **set_baked_light_texture_id** **(** :ref:`int<class_int>` id **)**
.. _class_GeometryInstance_get_baked_light_texture_id:
- :ref:`int<class_int>` **get_baked_light_texture_id** **(** **)** const
.. _class_GeometryInstance_set_extra_cull_margin:
- void **set_extra_cull_margin** **(** :ref:`float<class_float>` margin **)**
.. _class_GeometryInstance_get_extra_cull_margin:
.. _class_GeometryInstance_set_flag:
- :ref:`float<class_float>` **get_extra_cull_margin** **(** **)** const
- void **set_flag** **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` value **)**
.. _class_GeometryInstance_set_material_override:
- void **set_material_override** **(** :ref:`Object<class_object>` material **)**
Set the material override for the whole geometry.

94
classes/class_globals.rst
View File

@@ -19,32 +19,32 @@ Member Functions
----------------
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has<class_Globals_has>` **(** :ref:`String<class_string>` name **)** const |
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_order<class_Globals_set_order>` **(** :ref:`String<class_string>` name, :ref:`int<class_int>` pos **)** |
| void | :ref:`clear<class_Globals_clear>` **(** :ref:`String<class_string>` name **)** |
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_order<class_Globals_get_order>` **(** :ref:`String<class_string>` name **)** const |
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_persisting<class_Globals_set_persisting>` **(** :ref:`String<class_string>` name, :ref:`bool<class_bool>` enable **)** |
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_persisting<class_Globals_is_persisting>` **(** :ref:`String<class_string>` name **)** const |
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_Globals_clear>` **(** :ref:`String<class_string>` name **)** |
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`localize_path<class_Globals_localize_path>` **(** :ref:`String<class_string>` path **)** const |
| :ref:`Object<class_object>` | :ref:`get_singleton<class_Globals_get_singleton>` **(** :ref:`String<class_string>` name **)** const |
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`globalize_path<class_Globals_globalize_path>` **(** :ref:`String<class_string>` path **)** const |
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`save<class_Globals_save>` **(** **)** |
| :ref:`bool<class_bool>` | :ref:`has<class_Globals_has>` **(** :ref:`String<class_string>` name **)** const |
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_singleton<class_Globals_has_singleton>` **(** :ref:`String<class_string>` name **)** const |
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>` | :ref:`get_singleton<class_Globals_get_singleton>` **(** :ref:`String<class_string>` name **)** const |
| :ref:`bool<class_bool>` | :ref:`is_persisting<class_Globals_is_persisting>` **(** :ref:`String<class_string>` name **)** const |
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`load_resource_pack<class_Globals_load_resource_pack>` **(** :ref:`String<class_string>` pack **)** |
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`localize_path<class_Globals_localize_path>` **(** :ref:`String<class_string>` path **)** const |
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`save<class_Globals_save>` **(** **)** |
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`save_custom<class_Globals_save_custom>` **(** :ref:`String<class_string>` file **)** |
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_order<class_Globals_set_order>` **(** :ref:`String<class_string>` name, :ref:`int<class_int>` pos **)** |
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_persisting<class_Globals_set_persisting>` **(** :ref:`String<class_string>` name, :ref:`bool<class_bool>` enable **)** |
+------------------------------+------------------------------------------------------------------------------------------------------------------------------------+
Description
-----------
@@ -54,17 +54,11 @@ Contains global variables accessible from everywhere. Use the normal :ref:`Objec
Member Function Description
---------------------------
.. _class_Globals_has:
.. _class_Globals_clear:
- :ref:`bool<class_bool>` **has** **(** :ref:`String<class_string>` name **)** const
- void **clear** **(** :ref:`String<class_string>` name **)**
Return true if a configuration value is present.
.. _class_Globals_set_order:
- void **set_order** **(** :ref:`String<class_string>` name, :ref:`int<class_int>` pos **)**
Set the order of a configuration value (influences when saved to the config file).
Clear the whole configuration (not recommended, may break things).
.. _class_Globals_get_order:
@@ -72,29 +66,9 @@ Set the order of a configuration value (influences when saved to the config file
Return the order of a configuration value (influences when saved to the config file).
.. _class_Globals_set_persisting:
.. _class_Globals_get_singleton:
- void **set_persisting** **(** :ref:`String<class_string>` name, :ref:`bool<class_bool>` enable **)**
If set to true, this value can be saved to the configuration file. This is useful for editors.
.. _class_Globals_is_persisting:
- :ref:`bool<class_bool>` **is_persisting** **(** :ref:`String<class_string>` name **)** const
If returns true, this value can be saved to the configuration file. This is useful for editors.
.. _class_Globals_clear:
- void **clear** **(** :ref:`String<class_string>` name **)**
Clear the whole configuration (not recommended, may break things).
.. _class_Globals_localize_path:
- :ref:`String<class_string>` **localize_path** **(** :ref:`String<class_string>` path **)** const
Convert a path to a localized path (res:// path).
- :ref:`Object<class_object>` **get_singleton** **(** :ref:`String<class_string>` name **)** const
.. _class_Globals_globalize_path:
@@ -102,24 +76,50 @@ Convert a path to a localized path (res:// path).
Convert a localized path (res://) to a full native OS path.
.. _class_Globals_save:
.. _class_Globals_has:
- :ref:`int<class_int>` **save** **(** **)**
- :ref:`bool<class_bool>` **has** **(** :ref:`String<class_string>` name **)** const
Return true if a configuration value is present.
.. _class_Globals_has_singleton:
- :ref:`bool<class_bool>` **has_singleton** **(** :ref:`String<class_string>` name **)** const
.. _class_Globals_get_singleton:
.. _class_Globals_is_persisting:
- :ref:`Object<class_object>` **get_singleton** **(** :ref:`String<class_string>` name **)** const
- :ref:`bool<class_bool>` **is_persisting** **(** :ref:`String<class_string>` name **)** const
If returns true, this value can be saved to the configuration file. This is useful for editors.
.. _class_Globals_load_resource_pack:
- :ref:`bool<class_bool>` **load_resource_pack** **(** :ref:`String<class_string>` pack **)**
.. _class_Globals_localize_path:
- :ref:`String<class_string>` **localize_path** **(** :ref:`String<class_string>` path **)** const
Convert a path to a localized path (res:// path).
.. _class_Globals_save:
- :ref:`int<class_int>` **save** **(** **)**
.. _class_Globals_save_custom:
- :ref:`int<class_int>` **save_custom** **(** :ref:`String<class_string>` file **)**
.. _class_Globals_set_order:
- void **set_order** **(** :ref:`String<class_string>` name, :ref:`int<class_int>` pos **)**
Set the order of a configuration value (influences when saved to the config file).
.. _class_Globals_set_persisting:
- void **set_persisting** **(** :ref:`String<class_string>` name, :ref:`bool<class_bool>` enable **)**
If set to true, this value can be saved to the configuration file. This is useful for editors.

48
classes/class_graphedit.rst
View File

@@ -21,33 +21,33 @@ Member Functions
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Error | :ref:`connect_node<class_GraphEdit_connect_node>` **(** :ref:`String<class_string>` from, :ref:`int<class_int>` from_port, :ref:`String<class_string>` to, :ref:`int<class_int>` to_port **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_node_connected<class_GraphEdit_is_node_connected>` **(** :ref:`String<class_string>` from, :ref:`int<class_int>` from_port, :ref:`String<class_string>` to, :ref:`int<class_int>` to_port **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`disconnect_node<class_GraphEdit_disconnect_node>` **(** :ref:`String<class_string>` from, :ref:`int<class_int>` from_port, :ref:`String<class_string>` to, :ref:`int<class_int>` to_port **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_connection_list<class_GraphEdit_get_connection_list>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_scroll_ofs<class_GraphEdit_get_scroll_ofs>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_zoom<class_GraphEdit_set_zoom>` **(** :ref:`float<class_float>` p_zoom **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_zoom<class_GraphEdit_get_zoom>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_node_connected<class_GraphEdit_is_node_connected>` **(** :ref:`String<class_string>` from, :ref:`int<class_int>` from_port, :ref:`String<class_string>` to, :ref:`int<class_int>` to_port **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_right_disconnects_enabled<class_GraphEdit_is_right_disconnects_enabled>` **(** **)** const |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_right_disconnects<class_GraphEdit_set_right_disconnects>` **(** :ref:`bool<class_bool>` enable **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_right_disconnects_enabled<class_GraphEdit_is_right_disconnects_enabled>` **(** **)** const |
| void | :ref:`set_zoom<class_GraphEdit_set_zoom>` **(** :ref:`float<class_float>` p_zoom **)** |
+--------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
- **_begin_node_move** **(** **)**
- **_end_node_move** **(** **)**
- **connection_request** **(** :ref:`String<class_string>` from, :ref:`int<class_int>` from_slot, :ref:`String<class_string>` to, :ref:`int<class_int>` to_slot **)**
- **delete_nodes_request** **(** **)**
- **disconnection_request** **(** :ref:`String<class_string>` from, :ref:`int<class_int>` from_slot, :ref:`String<class_string>` to, :ref:`int<class_int>` to_slot **)**
- **duplicate_nodes_request** **(** **)**
- **popup_request** **(** :ref:`Vector2<class_vector2>` p_position **)**
- **_begin_node_move** **(** **)**
- **disconnection_request** **(** :ref:`String<class_string>` from, :ref:`int<class_int>` from_slot, :ref:`String<class_string>` to, :ref:`int<class_int>` to_slot **)**
- **connection_request** **(** :ref:`String<class_string>` from, :ref:`int<class_int>` from_slot, :ref:`String<class_string>` to, :ref:`int<class_int>` to_slot **)**
- **_end_node_move** **(** **)**
Description
-----------
@@ -65,12 +65,6 @@ Member Function Description
Create a connection between 'from_port' slot of 'from' GraphNode and 'to_port' slot of 'to' GraphNode. If the connection already exists, no connection is created.
.. _class_GraphEdit_is_node_connected:
- :ref:`bool<class_bool>` **is_node_connected** **(** :ref:`String<class_string>` from, :ref:`int<class_int>` from_port, :ref:`String<class_string>` to, :ref:`int<class_int>` to_port **)**
Return true if the 'from_port' slot of 'from' GraphNode is connected to the 'to_port' slot of 'to' GraphNode.
.. _class_GraphEdit_disconnect_node:
- void **disconnect_node** **(** :ref:`String<class_string>` from, :ref:`int<class_int>` from_port, :ref:`String<class_string>` to, :ref:`int<class_int>` to_port **)**
@@ -89,23 +83,17 @@ Return an Array containing the list of connections. A connection consists in a s
Return the scroll offset.
.. _class_GraphEdit_set_zoom:
- void **set_zoom** **(** :ref:`float<class_float>` p_zoom **)**
Set the zoom value of the GraphEdit. Zoom value is between :ref:`0.01; 1.728<class_0.01; 1.728>`.
.. _class_GraphEdit_get_zoom:
- :ref:`float<class_float>` **get_zoom** **(** **)** const
Return the current zoom value.
.. _class_GraphEdit_set_right_disconnects:
.. _class_GraphEdit_is_node_connected:
- void **set_right_disconnects** **(** :ref:`bool<class_bool>` enable **)**
- :ref:`bool<class_bool>` **is_node_connected** **(** :ref:`String<class_string>` from, :ref:`int<class_int>` from_port, :ref:`String<class_string>` to, :ref:`int<class_int>` to_port **)**
Enable the disconnection of existing connections in the visual GraphEdit by left-clicking a connection and releasing into the void.
Return true if the 'from_port' slot of 'from' GraphNode is connected to the 'to_port' slot of 'to' GraphNode.
.. _class_GraphEdit_is_right_disconnects_enabled:
@@ -113,4 +101,16 @@ Enable the disconnection of existing connections in the visual GraphEdit by left
Return true is the disconnection of connections is enable in the visual GraphEdit. False otherwise.
.. _class_GraphEdit_set_right_disconnects:
- void **set_right_disconnects** **(** :ref:`bool<class_bool>` enable **)**
Enable the disconnection of existing connections in the visual GraphEdit by left-clicking a connection and releasing into the void.
.. _class_GraphEdit_set_zoom:
- void **set_zoom** **(** :ref:`float<class_float>` p_zoom **)**
Set the zoom value of the GraphEdit. Zoom value is between :ref:`0.01; 1.728<class_0.01; 1.728>`.

258
classes/class_graphnode.rst
View File

@@ -19,60 +19,60 @@ Member Functions
----------------
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_title<class_GraphNode_set_title>` **(** :ref:`String<class_string>` title **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_title<class_GraphNode_get_title>` **(** **)** const |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_slot<class_GraphNode_set_slot>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enable_left, :ref:`int<class_int>` type_left, :ref:`Color<class_color>` color_left, :ref:`bool<class_bool>` enable_right, :ref:`int<class_int>` type_right, :ref:`Color<class_color>` color_right **)** |
| void | :ref:`clear_all_slots<class_GraphNode_clear_all_slots>` **(** **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_slot<class_GraphNode_clear_slot>` **(** :ref:`int<class_int>` idx **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_all_slots<class_GraphNode_clear_all_slots>` **(** **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_slot_enabled_left<class_GraphNode_is_slot_enabled_left>` **(** :ref:`int<class_int>` idx **)** const |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_slot_type_left<class_GraphNode_get_slot_type_left>` **(** :ref:`int<class_int>` idx **)** const |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_slot_color_left<class_GraphNode_get_slot_color_left>` **(** :ref:`int<class_int>` idx **)** const |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_slot_enabled_right<class_GraphNode_is_slot_enabled_right>` **(** :ref:`int<class_int>` idx **)** const |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_slot_type_right<class_GraphNode_get_slot_type_right>` **(** :ref:`int<class_int>` idx **)** const |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_slot_color_right<class_GraphNode_get_slot_color_right>` **(** :ref:`int<class_int>` idx **)** const |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_offset<class_GraphNode_set_offset>` **(** :ref:`Vector2<class_vector2>` offset **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_offset<class_GraphNode_get_offset>` **(** **)** const |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_connection_output_count<class_GraphNode_get_connection_output_count>` **(** **)** |
| :ref:`Color<class_color>` | :ref:`get_connection_input_color<class_GraphNode_get_connection_input_color>` **(** :ref:`int<class_int>` idx **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_connection_input_count<class_GraphNode_get_connection_input_count>` **(** **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_connection_output_pos<class_GraphNode_get_connection_output_pos>` **(** :ref:`int<class_int>` idx **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_connection_output_type<class_GraphNode_get_connection_output_type>` **(** :ref:`int<class_int>` idx **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_connection_output_color<class_GraphNode_get_connection_output_color>` **(** :ref:`int<class_int>` idx **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_connection_input_pos<class_GraphNode_get_connection_input_pos>` **(** :ref:`int<class_int>` idx **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_connection_input_type<class_GraphNode_get_connection_input_type>` **(** :ref:`int<class_int>` idx **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_connection_input_color<class_GraphNode_get_connection_input_color>` **(** :ref:`int<class_int>` idx **)** |
| :ref:`Color<class_color>` | :ref:`get_connection_output_color<class_GraphNode_get_connection_output_color>` **(** :ref:`int<class_int>` idx **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_connection_output_count<class_GraphNode_get_connection_output_count>` **(** **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_connection_output_pos<class_GraphNode_get_connection_output_pos>` **(** :ref:`int<class_int>` idx **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_connection_output_type<class_GraphNode_get_connection_output_type>` **(** :ref:`int<class_int>` idx **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_offset<class_GraphNode_get_offset>` **(** **)** const |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_slot_color_left<class_GraphNode_get_slot_color_left>` **(** :ref:`int<class_int>` idx **)** const |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_slot_color_right<class_GraphNode_get_slot_color_right>` **(** :ref:`int<class_int>` idx **)** const |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_slot_type_left<class_GraphNode_get_slot_type_left>` **(** :ref:`int<class_int>` idx **)** const |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_slot_type_right<class_GraphNode_get_slot_type_right>` **(** :ref:`int<class_int>` idx **)** const |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_title<class_GraphNode_get_title>` **(** **)** const |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_close_button_visible<class_GraphNode_is_close_button_visible>` **(** **)** const |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_slot_enabled_left<class_GraphNode_is_slot_enabled_left>` **(** :ref:`int<class_int>` idx **)** const |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_slot_enabled_right<class_GraphNode_is_slot_enabled_right>` **(** :ref:`int<class_int>` idx **)** const |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_offset<class_GraphNode_set_offset>` **(** :ref:`Vector2<class_vector2>` offset **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_show_close_button<class_GraphNode_set_show_close_button>` **(** :ref:`bool<class_bool>` show **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_close_button_visible<class_GraphNode_is_close_button_visible>` **(** **)** const |
| void | :ref:`set_slot<class_GraphNode_set_slot>` **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enable_left, :ref:`int<class_int>` type_left, :ref:`Color<class_color>` color_left, :ref:`bool<class_bool>` enable_right, :ref:`int<class_int>` type_right, :ref:`Color<class_color>` color_right **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_title<class_GraphNode_set_title>` **(** :ref:`String<class_string>` title **)** |
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
- **raise_request** **(** **)**
- **close_request** **(** **)**
- **dragged** **(** :ref:`Vector2<class_vector2>` from, :ref:`Vector2<class_vector2>` to **)**
- **offset_changed** **(** **)**
- **raise_request** **(** **)**
Description
-----------
@@ -82,23 +82,11 @@ A GraphNode is a container defined by a title. It can have 1 or more input and o
Member Function Description
---------------------------
.. _class_GraphNode_set_title:
.. _class_GraphNode_clear_all_slots:
- void **set_title** **(** :ref:`String<class_string>` title **)**
- void **clear_all_slots** **(** **)**
Set the title of the GraphNode.
.. _class_GraphNode_get_title:
- :ref:`String<class_string>` **get_title** **(** **)** const
Return the title of the GraphNode.
.. _class_GraphNode_set_slot:
- void **set_slot** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enable_left, :ref:`int<class_int>` type_left, :ref:`Color<class_color>` color_left, :ref:`bool<class_bool>` enable_right, :ref:`int<class_int>` type_right, :ref:`Color<class_color>` color_right **)**
Set the tuple of input/output slots defined by 'idx' ID. 'left' slots are input, 'right' are output. 'type' is an integer defining the type of the slot. Refer to description for the compatibility between slot types.
Disable all input and output slots of the GraphNode.
.. _class_GraphNode_clear_slot:
@@ -106,65 +94,11 @@ Set the tuple of input/output slots defined by 'idx' ID. 'left' slots are input,
Disable input and output slot whose index is 'idx'.
.. _class_GraphNode_clear_all_slots:
.. _class_GraphNode_get_connection_input_color:
- void **clear_all_slots** **(** **)**
- :ref:`Color<class_color>` **get_connection_input_color** **(** :ref:`int<class_int>` idx **)**
Disable all input and output slots of the GraphNode.
.. _class_GraphNode_is_slot_enabled_left:
- :ref:`bool<class_bool>` **is_slot_enabled_left** **(** :ref:`int<class_int>` idx **)** const
Return true if left (input) slot 'idx' is enabled. False otherwise.
.. _class_GraphNode_get_slot_type_left:
- :ref:`int<class_int>` **get_slot_type_left** **(** :ref:`int<class_int>` idx **)** const
Return the (integer) type of left (input) 'idx' slot.
.. _class_GraphNode_get_slot_color_left:
- :ref:`Color<class_color>` **get_slot_color_left** **(** :ref:`int<class_int>` idx **)** const
Return the color set to 'idx' left (input) slot.
.. _class_GraphNode_is_slot_enabled_right:
- :ref:`bool<class_bool>` **is_slot_enabled_right** **(** :ref:`int<class_int>` idx **)** const
Return true if right (output) slot 'idx' is enabled. False otherwise.
.. _class_GraphNode_get_slot_type_right:
- :ref:`int<class_int>` **get_slot_type_right** **(** :ref:`int<class_int>` idx **)** const
Return the (integer) type of right (output) 'idx' slot.
.. _class_GraphNode_get_slot_color_right:
- :ref:`Color<class_color>` **get_slot_color_right** **(** :ref:`int<class_int>` idx **)** const
Return the color set to 'idx' right (output) slot.
.. _class_GraphNode_set_offset:
- void **set_offset** **(** :ref:`Vector2<class_vector2>` offset **)**
Set the offset of the GraphNode.
.. _class_GraphNode_get_offset:
- :ref:`Vector2<class_vector2>` **get_offset** **(** **)** const
Return the offset of the GraphNode.
.. _class_GraphNode_get_connection_output_count:
- :ref:`int<class_int>` **get_connection_output_count** **(** **)**
Return the number of enabled output slots (connections) of the GraphNode.
Return the color of the input connection 'idx'.
.. _class_GraphNode_get_connection_input_count:
@@ -172,24 +106,6 @@ Return the number of enabled output slots (connections) of the GraphNode.
Return the number of enabled input slots (connections) to the GraphNode.
.. _class_GraphNode_get_connection_output_pos:
- :ref:`Vector2<class_vector2>` **get_connection_output_pos** **(** :ref:`int<class_int>` idx **)**
Return the position of the output connection 'idx'.
.. _class_GraphNode_get_connection_output_type:
- :ref:`int<class_int>` **get_connection_output_type** **(** :ref:`int<class_int>` idx **)**
Return the type of the output connection 'idx'.
.. _class_GraphNode_get_connection_output_color:
- :ref:`Color<class_color>` **get_connection_output_color** **(** :ref:`int<class_int>` idx **)**
Return the color of the output connection 'idx'.
.. _class_GraphNode_get_connection_input_pos:
- :ref:`Vector2<class_vector2>` **get_connection_input_pos** **(** :ref:`int<class_int>` idx **)**
@@ -202,17 +118,65 @@ Return the position of the input connection 'idx'.
Return the type of the input connection 'idx'.
.. _class_GraphNode_get_connection_input_color:
.. _class_GraphNode_get_connection_output_color:
- :ref:`Color<class_color>` **get_connection_input_color** **(** :ref:`int<class_int>` idx **)**
- :ref:`Color<class_color>` **get_connection_output_color** **(** :ref:`int<class_int>` idx **)**
Return the color of the input connection 'idx'.
Return the color of the output connection 'idx'.
.. _class_GraphNode_set_show_close_button:
.. _class_GraphNode_get_connection_output_count:
- void **set_show_close_button** **(** :ref:`bool<class_bool>` show **)**
- :ref:`int<class_int>` **get_connection_output_count** **(** **)**
Show the close button on the GraphNode if 'show' is true (disabled by default). If enabled, a connection on the signal close_request is needed for the close button to work.
Return the number of enabled output slots (connections) of the GraphNode.
.. _class_GraphNode_get_connection_output_pos:
- :ref:`Vector2<class_vector2>` **get_connection_output_pos** **(** :ref:`int<class_int>` idx **)**
Return the position of the output connection 'idx'.
.. _class_GraphNode_get_connection_output_type:
- :ref:`int<class_int>` **get_connection_output_type** **(** :ref:`int<class_int>` idx **)**
Return the type of the output connection 'idx'.
.. _class_GraphNode_get_offset:
- :ref:`Vector2<class_vector2>` **get_offset** **(** **)** const
Return the offset of the GraphNode.
.. _class_GraphNode_get_slot_color_left:
- :ref:`Color<class_color>` **get_slot_color_left** **(** :ref:`int<class_int>` idx **)** const
Return the color set to 'idx' left (input) slot.
.. _class_GraphNode_get_slot_color_right:
- :ref:`Color<class_color>` **get_slot_color_right** **(** :ref:`int<class_int>` idx **)** const
Return the color set to 'idx' right (output) slot.
.. _class_GraphNode_get_slot_type_left:
- :ref:`int<class_int>` **get_slot_type_left** **(** :ref:`int<class_int>` idx **)** const
Return the (integer) type of left (input) 'idx' slot.
.. _class_GraphNode_get_slot_type_right:
- :ref:`int<class_int>` **get_slot_type_right** **(** :ref:`int<class_int>` idx **)** const
Return the (integer) type of right (output) 'idx' slot.
.. _class_GraphNode_get_title:
- :ref:`String<class_string>` **get_title** **(** **)** const
Return the title of the GraphNode.
.. _class_GraphNode_is_close_button_visible:
@@ -220,4 +184,40 @@ Show the close button on the GraphNode if 'show' is true (disabled by default).
Returns true if the close button is shown. False otherwise.
.. _class_GraphNode_is_slot_enabled_left:
- :ref:`bool<class_bool>` **is_slot_enabled_left** **(** :ref:`int<class_int>` idx **)** const
Return true if left (input) slot 'idx' is enabled. False otherwise.
.. _class_GraphNode_is_slot_enabled_right:
- :ref:`bool<class_bool>` **is_slot_enabled_right** **(** :ref:`int<class_int>` idx **)** const
Return true if right (output) slot 'idx' is enabled. False otherwise.
.. _class_GraphNode_set_offset:
- void **set_offset** **(** :ref:`Vector2<class_vector2>` offset **)**
Set the offset of the GraphNode.
.. _class_GraphNode_set_show_close_button:
- void **set_show_close_button** **(** :ref:`bool<class_bool>` show **)**
Show the close button on the GraphNode if 'show' is true (disabled by default). If enabled, a connection on the signal close_request is needed for the close button to work.
.. _class_GraphNode_set_slot:
- void **set_slot** **(** :ref:`int<class_int>` idx, :ref:`bool<class_bool>` enable_left, :ref:`int<class_int>` type_left, :ref:`Color<class_color>` color_left, :ref:`bool<class_bool>` enable_right, :ref:`int<class_int>` type_right, :ref:`Color<class_color>` color_right **)**
Set the tuple of input/output slots defined by 'idx' ID. 'left' slots are input, 'right' are output. 'type' is an integer defining the type of the slot. Refer to description for the compatibility between slot types.
.. _class_GraphNode_set_title:
- void **set_title** **(** :ref:`String<class_string>` title **)**
Set the title of the GraphNode.

16
classes/class_gridcontainer.rst
View File

@@ -18,11 +18,11 @@ Grid container used to arrange elements in a grid like layout
Member Functions
----------------
+------------------------+-------------------------------------------------------------------------------------------------+
| void | :ref:`set_columns<class_GridContainer_set_columns>` **(** :ref:`int<class_int>` columns **)** |
+------------------------+-------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_columns<class_GridContainer_get_columns>` **(** **)** const |
+------------------------+-------------------------------------------------------------------------------------------------+
| void | :ref:`set_columns<class_GridContainer_set_columns>` **(** :ref:`int<class_int>` columns **)** |
+------------------------+-------------------------------------------------------------------------------------------------+
Description
-----------
@@ -32,16 +32,16 @@ Grid container will arrange its children in a grid like structure, the grid colu
Member Function Description
---------------------------
.. _class_GridContainer_set_columns:
- void **set_columns** **(** :ref:`int<class_int>` columns **)**
Sets the numbers of columns in the container, then reorder its children to accommodate the new layout
.. _class_GridContainer_get_columns:
- :ref:`int<class_int>` **get_columns** **(** **)** const
Returns the number of columns in this container
.. _class_GridContainer_set_columns:
- void **set_columns** **(** :ref:`int<class_int>` columns **)**
Sets the numbers of columns in the container, then reorder its children to accommodate the new layout

328
classes/class_gridmap.rst
View File

@@ -18,76 +18,76 @@ Brief Description
Member Functions
----------------
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_theme<class_GridMap_set_theme>` **(** :ref:`MeshLibrary<class_meshlibrary>` theme **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`MeshLibrary<class_meshlibrary>` | :ref:`get_theme<class_GridMap_get_theme>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bake<class_GridMap_set_bake>` **(** :ref:`bool<class_bool>` enable **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_baking_enabled<class_GridMap_is_baking_enabled>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_cell_size<class_GridMap_set_cell_size>` **(** :ref:`float<class_float>` size **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_cell_size<class_GridMap_get_cell_size>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_octant_size<class_GridMap_set_octant_size>` **(** :ref:`int<class_int>` size **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_octant_size<class_GridMap_get_octant_size>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_cell_item<class_GridMap_set_cell_item>` **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` z, :ref:`int<class_int>` item, :ref:`int<class_int>` orientation=0 **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_cell_item<class_GridMap_get_cell_item>` **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` z **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_cell_item_orientation<class_GridMap_get_cell_item_orientation>` **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` z **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`resource_changed<class_GridMap_resource_changed>` **(** :ref:`Object<class_object>` resource **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_center_x<class_GridMap_set_center_x>` **(** :ref:`bool<class_bool>` enable **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_center_x<class_GridMap_get_center_x>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_center_y<class_GridMap_set_center_y>` **(** :ref:`bool<class_bool>` enable **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_center_y<class_GridMap_get_center_y>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_center_z<class_GridMap_set_center_z>` **(** :ref:`bool<class_bool>` enable **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_center_z<class_GridMap_get_center_z>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_clip<class_GridMap_set_clip>` **(** :ref:`bool<class_bool>` enabled, :ref:`bool<class_bool>` clipabove=true, :ref:`int<class_int>` floor=0, :ref:`int<class_int>` axis=0 **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`create_area<class_GridMap_create_area>` **(** :ref:`int<class_int>` id, :ref:`AABB<class_aabb>` area **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`AABB<class_aabb>` | :ref:`area_get_bounds<class_GridMap_area_get_bounds>` **(** :ref:`int<class_int>` area **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`area_get_name<class_GridMap_area_get_name>` **(** :ref:`int<class_int>` area **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`area_get_portal_disable_color<class_GridMap_area_get_portal_disable_color>` **(** :ref:`int<class_int>` area **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`area_get_portal_disable_distance<class_GridMap_area_get_portal_disable_distance>` **(** :ref:`int<class_int>` area **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`area_is_exterior_portal<class_GridMap_area_is_exterior_portal>` **(** :ref:`int<class_int>` area **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_exterior_portal<class_GridMap_area_set_exterior_portal>` **(** :ref:`int<class_int>` area, :ref:`bool<class_bool>` enable **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_name<class_GridMap_area_set_name>` **(** :ref:`int<class_int>` area, :ref:`String<class_string>` name **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`area_get_name<class_GridMap_area_get_name>` **(** :ref:`int<class_int>` area **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`area_is_exterior_portal<class_GridMap_area_is_exterior_portal>` **(** :ref:`int<class_int>` area **)** const |
| void | :ref:`area_set_portal_disable_color<class_GridMap_area_set_portal_disable_color>` **(** :ref:`int<class_int>` area, :ref:`Color<class_color>` color **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_portal_disable_distance<class_GridMap_area_set_portal_disable_distance>` **(** :ref:`int<class_int>` area, :ref:`float<class_float>` distance **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`area_get_portal_disable_distance<class_GridMap_area_get_portal_disable_distance>` **(** :ref:`int<class_int>` area **)** const |
| void | :ref:`bake_geometry<class_GridMap_bake_geometry>` **(** **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`area_set_portal_disable_color<class_GridMap_area_set_portal_disable_color>` **(** :ref:`int<class_int>` area, :ref:`Color<class_color>` color **)** |
| void | :ref:`clear<class_GridMap_clear>` **(** **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`area_get_portal_disable_color<class_GridMap_area_get_portal_disable_color>` **(** :ref:`int<class_int>` area **)** const |
| :ref:`int<class_int>` | :ref:`create_area<class_GridMap_create_area>` **(** :ref:`int<class_int>` id, :ref:`AABB<class_aabb>` area **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`erase_area<class_GridMap_erase_area>` **(** :ref:`int<class_int>` area **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_cell_item<class_GridMap_get_cell_item>` **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` z **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_cell_item_orientation<class_GridMap_get_cell_item_orientation>` **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` z **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_cell_size<class_GridMap_get_cell_size>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_center_x<class_GridMap_get_center_x>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_center_y<class_GridMap_get_center_y>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_center_z<class_GridMap_get_center_z>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_octant_size<class_GridMap_get_octant_size>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`MeshLibrary<class_meshlibrary>` | :ref:`get_theme<class_GridMap_get_theme>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_unused_area_id<class_GridMap_get_unused_area_id>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`bake_geometry<class_GridMap_bake_geometry>` **(** **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_use_baked_light<class_GridMap_set_use_baked_light>` **(** :ref:`bool<class_bool>` use **)** |
| :ref:`bool<class_bool>` | :ref:`is_baking_enabled<class_GridMap_is_baking_enabled>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_using_baked_light<class_GridMap_is_using_baked_light>` **(** **)** const |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_GridMap_clear>` **(** **)** |
| void | :ref:`resource_changed<class_GridMap_resource_changed>` **(** :ref:`Object<class_object>` resource **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_bake<class_GridMap_set_bake>` **(** :ref:`bool<class_bool>` enable **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_cell_item<class_GridMap_set_cell_item>` **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` z, :ref:`int<class_int>` item, :ref:`int<class_int>` orientation=0 **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_cell_size<class_GridMap_set_cell_size>` **(** :ref:`float<class_float>` size **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_center_x<class_GridMap_set_center_x>` **(** :ref:`bool<class_bool>` enable **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_center_y<class_GridMap_set_center_y>` **(** :ref:`bool<class_bool>` enable **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_center_z<class_GridMap_set_center_z>` **(** :ref:`bool<class_bool>` enable **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_clip<class_GridMap_set_clip>` **(** :ref:`bool<class_bool>` enabled, :ref:`bool<class_bool>` clipabove=true, :ref:`int<class_int>` floor=0, :ref:`int<class_int>` axis=0 **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_octant_size<class_GridMap_set_octant_size>` **(** :ref:`int<class_int>` size **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_theme<class_GridMap_set_theme>` **(** :ref:`MeshLibrary<class_meshlibrary>` theme **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_use_baked_light<class_GridMap_set_use_baked_light>` **(** :ref:`bool<class_bool>` use **)** |
+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Numeric Constants
@@ -98,90 +98,26 @@ Numeric Constants
Member Function Description
---------------------------
.. _class_GridMap_set_theme:
- void **set_theme** **(** :ref:`MeshLibrary<class_meshlibrary>` theme **)**
.. _class_GridMap_get_theme:
- :ref:`MeshLibrary<class_meshlibrary>` **get_theme** **(** **)** const
.. _class_GridMap_set_bake:
- void **set_bake** **(** :ref:`bool<class_bool>` enable **)**
.. _class_GridMap_is_baking_enabled:
- :ref:`bool<class_bool>` **is_baking_enabled** **(** **)** const
.. _class_GridMap_set_cell_size:
- void **set_cell_size** **(** :ref:`float<class_float>` size **)**
.. _class_GridMap_get_cell_size:
- :ref:`float<class_float>` **get_cell_size** **(** **)** const
.. _class_GridMap_set_octant_size:
- void **set_octant_size** **(** :ref:`int<class_int>` size **)**
.. _class_GridMap_get_octant_size:
- :ref:`int<class_int>` **get_octant_size** **(** **)** const
.. _class_GridMap_set_cell_item:
- void **set_cell_item** **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` z, :ref:`int<class_int>` item, :ref:`int<class_int>` orientation=0 **)**
.. _class_GridMap_get_cell_item:
- :ref:`int<class_int>` **get_cell_item** **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` z **)** const
.. _class_GridMap_get_cell_item_orientation:
- :ref:`int<class_int>` **get_cell_item_orientation** **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` z **)** const
.. _class_GridMap_resource_changed:
- void **resource_changed** **(** :ref:`Object<class_object>` resource **)**
.. _class_GridMap_set_center_x:
- void **set_center_x** **(** :ref:`bool<class_bool>` enable **)**
.. _class_GridMap_get_center_x:
- :ref:`bool<class_bool>` **get_center_x** **(** **)** const
.. _class_GridMap_set_center_y:
- void **set_center_y** **(** :ref:`bool<class_bool>` enable **)**
.. _class_GridMap_get_center_y:
- :ref:`bool<class_bool>` **get_center_y** **(** **)** const
.. _class_GridMap_set_center_z:
- void **set_center_z** **(** :ref:`bool<class_bool>` enable **)**
.. _class_GridMap_get_center_z:
- :ref:`bool<class_bool>` **get_center_z** **(** **)** const
.. _class_GridMap_set_clip:
- void **set_clip** **(** :ref:`bool<class_bool>` enabled, :ref:`bool<class_bool>` clipabove=true, :ref:`int<class_int>` floor=0, :ref:`int<class_int>` axis=0 **)**
.. _class_GridMap_create_area:
- :ref:`int<class_int>` **create_area** **(** :ref:`int<class_int>` id, :ref:`AABB<class_aabb>` area **)**
.. _class_GridMap_area_get_bounds:
- :ref:`AABB<class_aabb>` **area_get_bounds** **(** :ref:`int<class_int>` area **)** const
.. _class_GridMap_area_get_name:
- :ref:`String<class_string>` **area_get_name** **(** :ref:`int<class_int>` area **)** const
.. _class_GridMap_area_get_portal_disable_color:
- :ref:`Color<class_color>` **area_get_portal_disable_color** **(** :ref:`int<class_int>` area **)** const
.. _class_GridMap_area_get_portal_disable_distance:
- :ref:`float<class_float>` **area_get_portal_disable_distance** **(** :ref:`int<class_int>` area **)** const
.. _class_GridMap_area_is_exterior_portal:
- :ref:`bool<class_bool>` **area_is_exterior_portal** **(** :ref:`int<class_int>` area **)** const
.. _class_GridMap_area_set_exterior_portal:
- void **area_set_exterior_portal** **(** :ref:`int<class_int>` area, :ref:`bool<class_bool>` enable **)**
@@ -190,52 +126,116 @@ Member Function Description
- void **area_set_name** **(** :ref:`int<class_int>` area, :ref:`String<class_string>` name **)**
.. _class_GridMap_area_get_name:
.. _class_GridMap_area_set_portal_disable_color:
- :ref:`String<class_string>` **area_get_name** **(** :ref:`int<class_int>` area **)** const
.. _class_GridMap_area_is_exterior_portal:
- :ref:`bool<class_bool>` **area_is_exterior_portal** **(** :ref:`int<class_int>` area **)** const
- void **area_set_portal_disable_color** **(** :ref:`int<class_int>` area, :ref:`Color<class_color>` color **)**
.. _class_GridMap_area_set_portal_disable_distance:
- void **area_set_portal_disable_distance** **(** :ref:`int<class_int>` area, :ref:`float<class_float>` distance **)**
.. _class_GridMap_area_get_portal_disable_distance:
- :ref:`float<class_float>` **area_get_portal_disable_distance** **(** :ref:`int<class_int>` area **)** const
.. _class_GridMap_area_set_portal_disable_color:
- void **area_set_portal_disable_color** **(** :ref:`int<class_int>` area, :ref:`Color<class_color>` color **)**
.. _class_GridMap_area_get_portal_disable_color:
- :ref:`Color<class_color>` **area_get_portal_disable_color** **(** :ref:`int<class_int>` area **)** const
.. _class_GridMap_erase_area:
- void **erase_area** **(** :ref:`int<class_int>` area **)**
.. _class_GridMap_get_unused_area_id:
- :ref:`int<class_int>` **get_unused_area_id** **(** **)** const
.. _class_GridMap_bake_geometry:
- void **bake_geometry** **(** **)**
.. _class_GridMap_set_use_baked_light:
- void **set_use_baked_light** **(** :ref:`bool<class_bool>` use **)**
.. _class_GridMap_is_using_baked_light:
- :ref:`bool<class_bool>` **is_using_baked_light** **(** **)** const
.. _class_GridMap_clear:
- void **clear** **(** **)**
.. _class_GridMap_create_area:
- :ref:`int<class_int>` **create_area** **(** :ref:`int<class_int>` id, :ref:`AABB<class_aabb>` area **)**
.. _class_GridMap_erase_area:
- void **erase_area** **(** :ref:`int<class_int>` area **)**
.. _class_GridMap_get_cell_item:
- :ref:`int<class_int>` **get_cell_item** **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` z **)** const
.. _class_GridMap_get_cell_item_orientation:
- :ref:`int<class_int>` **get_cell_item_orientation** **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` z **)** const
.. _class_GridMap_get_cell_size:
- :ref:`float<class_float>` **get_cell_size** **(** **)** const
.. _class_GridMap_get_center_x:
- :ref:`bool<class_bool>` **get_center_x** **(** **)** const
.. _class_GridMap_get_center_y:
- :ref:`bool<class_bool>` **get_center_y** **(** **)** const
.. _class_GridMap_get_center_z:
- :ref:`bool<class_bool>` **get_center_z** **(** **)** const
.. _class_GridMap_get_octant_size:
- :ref:`int<class_int>` **get_octant_size** **(** **)** const
.. _class_GridMap_get_theme:
- :ref:`MeshLibrary<class_meshlibrary>` **get_theme** **(** **)** const
.. _class_GridMap_get_unused_area_id:
- :ref:`int<class_int>` **get_unused_area_id** **(** **)** const
.. _class_GridMap_is_baking_enabled:
- :ref:`bool<class_bool>` **is_baking_enabled** **(** **)** const
.. _class_GridMap_is_using_baked_light:
- :ref:`bool<class_bool>` **is_using_baked_light** **(** **)** const
.. _class_GridMap_resource_changed:
- void **resource_changed** **(** :ref:`Object<class_object>` resource **)**
.. _class_GridMap_set_bake:
- void **set_bake** **(** :ref:`bool<class_bool>` enable **)**
.. _class_GridMap_set_cell_item:
- void **set_cell_item** **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` z, :ref:`int<class_int>` item, :ref:`int<class_int>` orientation=0 **)**
.. _class_GridMap_set_cell_size:
- void **set_cell_size** **(** :ref:`float<class_float>` size **)**
.. _class_GridMap_set_center_x:
- void **set_center_x** **(** :ref:`bool<class_bool>` enable **)**
.. _class_GridMap_set_center_y:
- void **set_center_y** **(** :ref:`bool<class_bool>` enable **)**
.. _class_GridMap_set_center_z:
- void **set_center_z** **(** :ref:`bool<class_bool>` enable **)**
.. _class_GridMap_set_clip:
- void **set_clip** **(** :ref:`bool<class_bool>` enabled, :ref:`bool<class_bool>` clipabove=true, :ref:`int<class_int>` floor=0, :ref:`int<class_int>` axis=0 **)**
.. _class_GridMap_set_octant_size:
- void **set_octant_size** **(** :ref:`int<class_int>` size **)**
.. _class_GridMap_set_theme:
- void **set_theme** **(** :ref:`MeshLibrary<class_meshlibrary>` theme **)**
.. _class_GridMap_set_use_baked_light:
- void **set_use_baked_light** **(** :ref:`bool<class_bool>` use **)**

16
classes/class_groovejoint2d.rst
View File

@@ -19,13 +19,13 @@ Member Functions
----------------
+----------------------------+------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_length<class_GrooveJoint2D_set_length>` **(** :ref:`float<class_float>` length **)** |
| :ref:`float<class_float>` | :ref:`get_initial_offset<class_GrooveJoint2D_get_initial_offset>` **(** **)** const |
+----------------------------+------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_length<class_GrooveJoint2D_get_length>` **(** **)** const |
+----------------------------+------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_initial_offset<class_GrooveJoint2D_set_initial_offset>` **(** :ref:`float<class_float>` offset **)** |
+----------------------------+------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_initial_offset<class_GrooveJoint2D_get_initial_offset>` **(** **)** const |
| void | :ref:`set_length<class_GrooveJoint2D_set_length>` **(** :ref:`float<class_float>` length **)** |
+----------------------------+------------------------------------------------------------------------------------------------------------------+
Description
@@ -36,11 +36,11 @@ Groove constraint for 2D physics. This is useful for making a body "slide" throu
Member Function Description
---------------------------
.. _class_GrooveJoint2D_set_length:
.. _class_GrooveJoint2D_get_initial_offset:
- void **set_length** **(** :ref:`float<class_float>` length **)**
- :ref:`float<class_float>` **get_initial_offset** **(** **)** const
Set the length of the groove.
Set the final offset of the groove on body A.
.. _class_GrooveJoint2D_get_length:
@@ -54,10 +54,10 @@ Return the length of the groove.
Set the initial offset of the groove on body A.
.. _class_GrooveJoint2D_get_initial_offset:
.. _class_GrooveJoint2D_set_length:
- :ref:`float<class_float>` **get_initial_offset** **(** **)** const
- void **set_length** **(** :ref:`float<class_float>` length **)**
Set the final offset of the groove on body A.
Set the length of the groove.

18
classes/class_hingejoint.rst
View File

@@ -19,18 +19,21 @@ Member Functions
----------------
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_param<class_HingeJoint_set_param>` **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)** |
| :ref:`bool<class_bool>` | :ref:`get_flag<class_HingeJoint_get_flag>` **(** :ref:`int<class_int>` flag **)** const |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_param<class_HingeJoint_get_param>` **(** :ref:`int<class_int>` param **)** const |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_flag<class_HingeJoint_set_flag>` **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` enabled **)** |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_flag<class_HingeJoint_get_flag>` **(** :ref:`int<class_int>` flag **)** const |
| void | :ref:`set_param<class_HingeJoint_set_param>` **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)** |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------+
Numeric Constants
-----------------
- **FLAG_USE_LIMIT** = **0**
- **FLAG_ENABLE_MOTOR** = **1**
- **FLAG_MAX** = **2**
- **PARAM_BIAS** = **0**
- **PARAM_LIMIT_UPPER** = **1**
- **PARAM_LIMIT_LOWER** = **2**
@@ -40,16 +43,13 @@ Numeric Constants
- **PARAM_MOTOR_TARGET_VELOCITY** = **6**
- **PARAM_MOTOR_MAX_IMPULSE** = **7**
- **PARAM_MAX** = **8**
- **FLAG_USE_LIMIT** = **0**
- **FLAG_ENABLE_MOTOR** = **1**
- **FLAG_MAX** = **2**
Member Function Description
---------------------------
.. _class_HingeJoint_set_param:
.. _class_HingeJoint_get_flag:
- void **set_param** **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)**
- :ref:`bool<class_bool>` **get_flag** **(** :ref:`int<class_int>` flag **)** const
.. _class_HingeJoint_get_param:
@@ -59,8 +59,8 @@ Member Function Description
- void **set_flag** **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` enabled **)**
.. _class_HingeJoint_get_flag:
.. _class_HingeJoint_set_param:
- :ref:`bool<class_bool>` **get_flag** **(** :ref:`int<class_int>` flag **)** const
- void **set_param** **(** :ref:`int<class_int>` param, :ref:`float<class_float>` value **)**

200
classes/class_httpclient.rst
View File

@@ -18,22 +18,12 @@ Hyper-text transfer protocol client.
Member Functions
----------------
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Error | :ref:`connect<class_HTTPClient_connect>` **(** :ref:`String<class_string>` host, :ref:`int<class_int>` port, :ref:`bool<class_bool>` use_ssl=false, :ref:`bool<class_bool>` verify_host=true **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_connection<class_HTTPClient_set_connection>` **(** :ref:`StreamPeer<class_streampeer>` connection **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`request<class_HTTPClient_request>` **(** :ref:`int<class_int>` method, :ref:`String<class_string>` url, :ref:`StringArray<class_stringarray>` headers, :ref:`String<class_string>` body="" **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`send_body_text<class_HTTPClient_send_body_text>` **(** :ref:`String<class_string>` body **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`send_body_data<class_HTTPClient_send_body_data>` **(** :ref:`RawArray<class_rawarray>` body **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`close<class_HTTPClient_close>` **(** **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_response<class_HTTPClient_has_response>` **(** **)** const |
| Error | :ref:`connect<class_HTTPClient_connect>` **(** :ref:`String<class_string>` host, :ref:`int<class_int>` port, :ref:`bool<class_bool>` use_ssl=false, :ref:`bool<class_bool>` verify_host=true **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_response_chunked<class_HTTPClient_is_response_chunked>` **(** **)** const |
| :ref:`int<class_int>` | :ref:`get_response_body_length<class_HTTPClient_get_response_body_length>` **(** **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_response_code<class_HTTPClient_get_response_code>` **(** **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -41,22 +31,32 @@ Member Functions
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_dictionary>` | :ref:`get_response_headers_as_dictionary<class_HTTPClient_get_response_headers_as_dictionary>` **(** **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_response_body_length<class_HTTPClient_get_response_body_length>` **(** **)** const |
| :ref:`int<class_int>` | :ref:`get_status<class_HTTPClient_get_status>` **(** **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RawArray<class_rawarray>` | :ref:`read_response_body_chunk<class_HTTPClient_read_response_body_chunk>` **(** **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_read_chunk_size<class_HTTPClient_set_read_chunk_size>` **(** :ref:`int<class_int>` bytes **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_blocking_mode<class_HTTPClient_set_blocking_mode>` **(** :ref:`bool<class_bool>` enabled **)** |
| :ref:`bool<class_bool>` | :ref:`has_response<class_HTTPClient_has_response>` **(** **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_blocking_mode_enabled<class_HTTPClient_is_blocking_mode_enabled>` **(** **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_status<class_HTTPClient_get_status>` **(** **)** const |
| :ref:`bool<class_bool>` | :ref:`is_response_chunked<class_HTTPClient_is_response_chunked>` **(** **)** const |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Error | :ref:`poll<class_HTTPClient_poll>` **(** **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`query_string_from_dict<class_HTTPClient_query_string_from_dict>` **(** :ref:`Dictionary<class_dictionary>` fields **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RawArray<class_rawarray>` | :ref:`read_response_body_chunk<class_HTTPClient_read_response_body_chunk>` **(** **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`request<class_HTTPClient_request>` **(** :ref:`int<class_int>` method, :ref:`String<class_string>` url, :ref:`StringArray<class_stringarray>` headers, :ref:`String<class_string>` body="" **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`send_body_data<class_HTTPClient_send_body_data>` **(** :ref:`RawArray<class_rawarray>` body **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`send_body_text<class_HTTPClient_send_body_text>` **(** :ref:`String<class_string>` body **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_blocking_mode<class_HTTPClient_set_blocking_mode>` **(** :ref:`bool<class_bool>` enabled **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_connection<class_HTTPClient_set_connection>` **(** :ref:`StreamPeer<class_streampeer>` connection **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_read_chunk_size<class_HTTPClient_set_read_chunk_size>` **(** :ref:`int<class_int>` bytes **)** |
+----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Numeric Constants
-----------------
@@ -70,16 +70,6 @@ Numeric Constants
- **METHOD_TRACE** = **6**
- **METHOD_CONNECT** = **7**
- **METHOD_MAX** = **8**
- **STATUS_DISCONNECTED** = **0**
- **STATUS_RESOLVING** = **1**
- **STATUS_CANT_RESOLVE** = **2**
- **STATUS_CONNECTING** = **3**
- **STATUS_CANT_CONNECT** = **4**
- **STATUS_CONNECTED** = **5**
- **STATUS_REQUESTING** = **6**
- **STATUS_BODY** = **7**
- **STATUS_CONNECTION_ERROR** = **8**
- **STATUS_SSL_HANDSHAKE_ERROR** = **9**
- **RESPONSE_CONTINUE** = **100**
- **RESPONSE_SWITCHING_PROTOCOLS** = **101**
- **RESPONSE_PROCESSING** = **102**
@@ -129,6 +119,16 @@ Numeric Constants
- **RESPONSE_HTTP_VERSION_NOT_SUPPORTED** = **505**
- **RESPONSE_INSUFFICIENT_STORAGE** = **507**
- **RESPONSE_NOT_EXTENDED** = **510**
- **STATUS_DISCONNECTED** = **0**
- **STATUS_RESOLVING** = **1**
- **STATUS_CANT_RESOLVE** = **2**
- **STATUS_CONNECTING** = **3**
- **STATUS_CANT_CONNECT** = **4**
- **STATUS_CONNECTED** = **5**
- **STATUS_REQUESTING** = **6**
- **STATUS_BODY** = **7**
- **STATUS_CONNECTION_ERROR** = **8**
- **STATUS_SSL_HANDSHAKE_ERROR** = **9**
Description
-----------
@@ -140,6 +140,12 @@ Can be reused to connect to different hosts and make many requests.
Member Function Description
---------------------------
.. _class_HTTPClient_close:
- void **close** **(** **)**
Cloces the current connection, allows for reusal of :ref:`HTTPClient<class_httpclient>`.
.. _class_HTTPClient_connect:
- Error **connect** **(** :ref:`String<class_string>` host, :ref:`int<class_int>` port, :ref:`bool<class_bool>` use_ssl=false, :ref:`bool<class_bool>` verify_host=true **)**
@@ -150,58 +156,11 @@ The host should not have http:// prepended but will strip the protocol identifie
verify_host will check the SSL identity of the host if set to true.
.. _class_HTTPClient_set_connection:
.. _class_HTTPClient_get_response_body_length:
- void **set_connection** **(** :ref:`StreamPeer<class_streampeer>` connection **)**
- :ref:`int<class_int>` **get_response_body_length** **(** **)** const
Set connection to use, for this client.
.. _class_HTTPClient_request:
- :ref:`int<class_int>` **request** **(** :ref:`int<class_int>` method, :ref:`String<class_string>` url, :ref:`StringArray<class_stringarray>` headers, :ref:`String<class_string>` body="" **)**
Sends a request to the connected host. The url is what is normally behind the hostname, i.e. in ``http://somehost.com/index.php``, url would be "index.php".
Headers are HTTP request headers.
To create a POST request with query strings to push to the server, do:
::
var fields = {"username" : "user", "password" : "pass"}
var queryString = httpClient.query_string_from_dict(fields)
var headers = :ref:`"Content-Type: application/x-www-form-urlencoded", "Content-Length: " + str(queryString.length())<class_"content-type: application/x-www-form-urlencoded", "content-length: " + str(querystring.length())>`
var result = httpClient.request(httpClient.METHOD_POST, "index.php", headers, queryString)
.. _class_HTTPClient_send_body_text:
- :ref:`int<class_int>` **send_body_text** **(** :ref:`String<class_string>` body **)**
Stub function
.. _class_HTTPClient_send_body_data:
- :ref:`int<class_int>` **send_body_data** **(** :ref:`RawArray<class_rawarray>` body **)**
Stub function
.. _class_HTTPClient_close:
- void **close** **(** **)**
Cloces the current connection, allows for reusal of :ref:`HTTPClient<class_httpclient>`.
.. _class_HTTPClient_has_response:
- :ref:`bool<class_bool>` **has_response** **(** **)** const
Return whether this :ref:`HTTPClient<class_httpclient>` has a response available.
.. _class_HTTPClient_is_response_chunked:
- :ref:`bool<class_bool>` **is_response_chunked** **(** **)** const
Return whether this :ref:`HTTPClient<class_httpclient>` has a response that is chunked.
Return the response's body length.
.. _class_HTTPClient_get_response_code:
@@ -225,29 +184,17 @@ Structure: ("key":"value1; value2")
Example: (content-length:12), (Content-Type:application/json; charset=UTF-8)
.. _class_HTTPClient_get_response_body_length:
.. _class_HTTPClient_get_status:
- :ref:`int<class_int>` **get_response_body_length** **(** **)** const
- :ref:`int<class_int>` **get_status** **(** **)** const
Return the response's body length.
Returns a status string like STATUS_REQUESTING. Need to call :ref:`poll<class_HTTPClient_poll>` in order to get status updates.
.. _class_HTTPClient_read_response_body_chunk:
.. _class_HTTPClient_has_response:
- :ref:`RawArray<class_rawarray>` **read_response_body_chunk** **(** **)**
- :ref:`bool<class_bool>` **has_response** **(** **)** const
Reads one chunk from the response.
.. _class_HTTPClient_set_read_chunk_size:
- void **set_read_chunk_size** **(** :ref:`int<class_int>` bytes **)**
Sets the size of the buffer used and maximum bytes to read per iteration. see :ref:`read_response_body_chunk<class_HTTPClient_read_response_body_chunk>`
.. _class_HTTPClient_set_blocking_mode:
- void **set_blocking_mode** **(** :ref:`bool<class_bool>` enabled **)**
If set to true, execution will block until all data is read from the response.
Return whether this :ref:`HTTPClient<class_httpclient>` has a response available.
.. _class_HTTPClient_is_blocking_mode_enabled:
@@ -255,11 +202,11 @@ If set to true, execution will block until all data is read from the response.
Return whether blocking mode is enabled.
.. _class_HTTPClient_get_status:
.. _class_HTTPClient_is_response_chunked:
- :ref:`int<class_int>` **get_status** **(** **)** const
- :ref:`bool<class_bool>` **is_response_chunked** **(** **)** const
Returns a status string like STATUS_REQUESTING. Need to call :ref:`poll<class_HTTPClient_poll>` in order to get status updates.
Return whether this :ref:`HTTPClient<class_httpclient>` has a response that is chunked.
.. _class_HTTPClient_poll:
@@ -279,4 +226,57 @@ Generates a GET/POST application/x-www-form-urlencoded style query string from a
String queryString = httpClient.query_string_from_dict(fields)
returns:= "username=user&password=pass"
.. _class_HTTPClient_read_response_body_chunk:
- :ref:`RawArray<class_rawarray>` **read_response_body_chunk** **(** **)**
Reads one chunk from the response.
.. _class_HTTPClient_request:
- :ref:`int<class_int>` **request** **(** :ref:`int<class_int>` method, :ref:`String<class_string>` url, :ref:`StringArray<class_stringarray>` headers, :ref:`String<class_string>` body="" **)**
Sends a request to the connected host. The url is what is normally behind the hostname, i.e. in ``http://somehost.com/index.php``, url would be "index.php".
Headers are HTTP request headers.
To create a POST request with query strings to push to the server, do:
::
var fields = {"username" : "user", "password" : "pass"}
var queryString = httpClient.query_string_from_dict(fields)
var headers = :ref:`"Content-Type: application/x-www-form-urlencoded", "Content-Length: " + str(queryString.length())<class_"content-type: application/x-www-form-urlencoded", "content-length: " + str(querystring.length())>`
var result = httpClient.request(httpClient.METHOD_POST, "index.php", headers, queryString)
.. _class_HTTPClient_send_body_data:
- :ref:`int<class_int>` **send_body_data** **(** :ref:`RawArray<class_rawarray>` body **)**
Stub function
.. _class_HTTPClient_send_body_text:
- :ref:`int<class_int>` **send_body_text** **(** :ref:`String<class_string>` body **)**
Stub function
.. _class_HTTPClient_set_blocking_mode:
- void **set_blocking_mode** **(** :ref:`bool<class_bool>` enabled **)**
If set to true, execution will block until all data is read from the response.
.. _class_HTTPClient_set_connection:
- void **set_connection** **(** :ref:`StreamPeer<class_streampeer>` connection **)**
Set connection to use, for this client.
.. _class_HTTPClient_set_read_chunk_size:
- void **set_read_chunk_size** **(** :ref:`int<class_int>` bytes **)**
Sets the size of the buffer used and maximum bytes to read per iteration. see :ref:`read_response_body_chunk<class_HTTPClient_read_response_body_chunk>`

69
classes/class_image.rst
View File

@@ -16,6 +16,8 @@ Image datatype.
Member Functions
----------------
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Image<class_image>` | :ref:`Image<class_Image_Image>` **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`bool<class_bool>` mipmaps, :ref:`int<class_int>` format **)** |
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`blit_rect<class_Image_blit_rect>` **(** :ref:`Image<class_image>` src, :ref:`Rect2<class_rect2>` src_rect, :ref:`Vector2<class_vector2>` dest=0 **)** |
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -55,8 +57,6 @@ Member Functions
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`save_png<class_Image_save_png>` **(** :ref:`String<class_string>` path=0 **)** |
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Image<class_image>` | :ref:`Image<class_Image_Image>` **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`bool<class_bool>` mipmaps, :ref:`int<class_int>` format **)** |
+----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Numeric Constants
-----------------
@@ -67,14 +67,6 @@ Numeric Constants
- **COMPRESS_ETC** = **3**
- **FORMAT_GRAYSCALE** = **0**
- **FORMAT_INTENSITY** = **1**
- **FORMAT_GRAYSCALE_ALPHA** = **2**
- **FORMAT_RGB** = **3**
- **FORMAT_RGBA** = **4**
- **FORMAT_INDEXED** = **5**
- **FORMAT_INDEXED_ALPHA** = **6**
- **FORMAT_YUV_422** = **7**
- **FORMAT_YUV_444** = **8**
- **FORMAT_BC1** = **9**
- **FORMAT_BC2** = **10**
- **FORMAT_BC3** = **11**
- **FORMAT_BC4** = **12**
@@ -85,9 +77,20 @@ Numeric Constants
- **FORMAT_PVRTC4_ALPHA** = **17**
- **FORMAT_ETC** = **18**
- **FORMAT_ATC** = **19**
- **FORMAT_GRAYSCALE_ALPHA** = **2**
- **FORMAT_ATC_ALPHA_EXPLICIT** = **20**
- **FORMAT_ATC_ALPHA_INTERPOLATED** = **21**
- **FORMAT_CUSTOM** = **22**
- **FORMAT_RGB** = **3**
- **FORMAT_RGBA** = **4**
- **FORMAT_INDEXED** = **5**
- **FORMAT_INDEXED_ALPHA** = **6**
- **FORMAT_YUV_422** = **7**
- **FORMAT_YUV_444** = **8**
- **FORMAT_BC1** = **9**
- **INTERPOLATE_NEAREST** = **0**
- **INTERPOLATE_BILINEAR** = **1**
- **INTERPOLATE_CUBIC** = **2**
Description
-----------
@@ -97,34 +100,54 @@ Built in native image datatype. Contains image data, which can be converted to a
Member Function Description
---------------------------
.. _class_Image_Image:
- :ref:`Image<class_image>` **Image** **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`bool<class_bool>` mipmaps, :ref:`int<class_int>` format **)**
Create an empty image of a specific size and format.
.. _class_Image_blit_rect:
- void **blit_rect** **(** :ref:`Image<class_image>` src, :ref:`Rect2<class_rect2>` src_rect, :ref:`Vector2<class_vector2>` dest=0 **)**
Copy a "src_rect" :ref:`Rect2<class_rect2>` from "src" :ref:`Image<class_image>` to this :ref:`Image<class_image>` on coordinates "dest".
.. _class_Image_brush_transfer:
- void **brush_transfer** **(** :ref:`Image<class_image>` src, :ref:`Image<class_image>` brush, :ref:`Vector2<class_vector2>` pos=0 **)**
Transfer data from "src" to this :ref:`Image<class_image>` using a "brush" as a mask/brush on coordinates "pos".
.. _class_Image_brushed:
- :ref:`Image<class_image>` **brushed** **(** :ref:`Image<class_image>` src, :ref:`Image<class_image>` brush, :ref:`Vector2<class_vector2>` pos=0 **)**
Return a new :ref:`Image<class_image>` from this :ref:`Image<class_image>` that is created by brushhing see :ref:`brush_transfer<class_Image_brush_transfer>`.
.. _class_Image_compressed:
- :ref:`Image<class_image>` **compressed** **(** :ref:`int<class_int>` format=0 **)**
Return a new compressed :ref:`Image<class_image>` from this :ref:`Image<class_image>` using one of :ref:`Image<class_image>`.COMPRESS\_\*.
.. _class_Image_converted:
- :ref:`Image<class_image>` **converted** **(** :ref:`int<class_int>` format=0 **)**
Return a new :ref:`Image<class_image>` from this :ref:`Image<class_image>` with a different format.
.. _class_Image_decompressed:
- :ref:`Image<class_image>` **decompressed** **(** **)**
Return a new decompressed :ref:`Image<class_image>`.
.. _class_Image_empty:
- :ref:`bool<class_bool>` **empty** **(** **)**
Return whether this :ref:`Image<class_image>` is empty(no data).
.. _class_Image_fix_alpha_edges:
- void **fix_alpha_edges** **(** **)**
@@ -133,50 +156,66 @@ Member Function Description
- :ref:`RawArray<class_rawarray>` **get_data** **(** **)**
Return the raw data of the :ref:`Image<class_image>`.
.. _class_Image_get_format:
- :ref:`int<class_int>` **get_format** **(** **)**
Return the format of the :ref:`Image<class_image>`, one of :ref:`Image<class_image>`.FORMAT\_\*.
.. _class_Image_get_height:
- :ref:`int<class_int>` **get_height** **(** **)**
Return the height of the :ref:`Image<class_image>`.
.. _class_Image_get_pixel:
- :ref:`Color<class_color>` **get_pixel** **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` mipmap_level=0 **)**
Return the color of the pixel in the :ref:`Image<class_image>` on coordinates "x,y" on mipmap level "mipmap_level".
.. _class_Image_get_rect:
- :ref:`Image<class_image>` **get_rect** **(** :ref:`Rect2<class_rect2>` area=0 **)**
Return a new :ref:`Image<class_image>` that is a copy of "area" in this :ref:`Image<class_image>`.
.. _class_Image_get_used_rect:
- :ref:`Rect2<class_rect2>` **get_used_rect** **(** **)**
Return the area of this :ref:`Image<class_image>` that is used/visibly colored/opaque.
.. _class_Image_get_width:
- :ref:`int<class_int>` **get_width** **(** **)**
Return the width of the :ref:`Image<class_image>`.
.. _class_Image_load:
- :ref:`int<class_int>` **load** **(** :ref:`String<class_string>` path=0 **)**
Load an :ref:`Image<class_image>`.
.. _class_Image_put_pixel:
- void **put_pixel** **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`Color<class_color>` color, :ref:`int<class_int>` mipmap_level=0 **)**
Put a pixel of "color" on coordinates "x,y" on mipmap level "mipmap_level".
.. _class_Image_resized:
- :ref:`Image<class_image>` **resized** **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` interpolation=1 **)**
Return a new :ref:`Image<class_image>` from this :ref:`Image<class_image>` that is resized to size "x,y" using :ref:`Image<class_image>`.INTERPOLATE\_\*.
.. _class_Image_save_png:
- :ref:`int<class_int>` **save_png** **(** :ref:`String<class_string>` path=0 **)**
.. _class_Image_Image:
- :ref:`Image<class_image>` **Image** **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`bool<class_bool>` mipmaps, :ref:`int<class_int>` format **)**
Create an empty image of a specific size and format.
Save this :ref:`Image<class_image>` as a png.

133
classes/class_imagetexture.rst
View File

@@ -13,7 +13,7 @@ ImageTexture
Brief Description
-----------------
A :ref:`Texture<class_texture>` based on an :ref:`Image<class_image>`.
Member Functions
----------------
@@ -23,39 +23,44 @@ Member Functions
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`create_from_image<class_ImageTexture_create_from_image>` **(** :ref:`Image<class_image>` image, :ref:`int<class_int>` flags=7 **)** |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_format<class_ImageTexture_get_format>` **(** **)** const |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`load<class_ImageTexture_load>` **(** :ref:`String<class_string>` path **)** |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_data<class_ImageTexture_set_data>` **(** :ref:`Image<class_image>` image **)** |
| void | :ref:`fix_alpha_edges<class_ImageTexture_fix_alpha_edges>` **(** **)** |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Image<class_image>` | :ref:`get_data<class_ImageTexture_get_data>` **(** **)** const |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_storage<class_ImageTexture_set_storage>` **(** :ref:`int<class_int>` mode **)** |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_storage<class_ImageTexture_get_storage>` **(** **)** const |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_lossy_storage_quality<class_ImageTexture_set_lossy_storage_quality>` **(** :ref:`float<class_float>` quality **)** |
| :ref:`int<class_int>` | :ref:`get_format<class_ImageTexture_get_format>` **(** **)** const |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_lossy_storage_quality<class_ImageTexture_get_lossy_storage_quality>` **(** **)** const |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`fix_alpha_edges<class_ImageTexture_fix_alpha_edges>` **(** **)** |
| :ref:`int<class_int>` | :ref:`get_storage<class_ImageTexture_get_storage>` **(** **)** const |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`premultiply_alpha<class_ImageTexture_premultiply_alpha>` **(** **)** |
| void | :ref:`load<class_ImageTexture_load>` **(** :ref:`String<class_string>` path **)** |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`normal_to_xy<class_ImageTexture_normal_to_xy>` **(** **)** |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`shrink_x2_and_keep_size<class_ImageTexture_shrink_x2_and_keep_size>` **(** **)** |
| void | :ref:`premultiply_alpha<class_ImageTexture_premultiply_alpha>` **(** **)** |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_data<class_ImageTexture_set_data>` **(** :ref:`Image<class_image>` image **)** |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_lossy_storage_quality<class_ImageTexture_set_lossy_storage_quality>` **(** :ref:`float<class_float>` quality **)** |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_size_override<class_ImageTexture_set_size_override>` **(** :ref:`Vector2<class_vector2>` size **)** |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_storage<class_ImageTexture_set_storage>` **(** :ref:`int<class_int>` mode **)** |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`shrink_x2_and_keep_size<class_ImageTexture_shrink_x2_and_keep_size>` **(** **)** |
+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Numeric Constants
-----------------
- **STORAGE_RAW** = **0**
- **STORAGE_COMPRESS_LOSSY** = **1**
- **STORAGE_COMPRESS_LOSSLESS** = **2**
- **STORAGE_RAW** = **0** --- :ref:`Image<class_image>` data is stored raw and unaltered.
- **STORAGE_COMPRESS_LOSSY** = **1** --- :ref:`Image<class_image>` data is compressed with a lossy algorithm. You can set the storage quality with :ref:`set_lossy_storage_quality<class_ImageTexture_set_lossy_storage_quality>`.
- **STORAGE_COMPRESS_LOSSLESS** = **2** --- :ref:`Image<class_image>` data is compressed with a lossless algorithm.
Description
-----------
A :ref:`Texture<class_texture>` based on an :ref:`Image<class_image>`. Can be created from an :ref:`Image<class_image>`.
Member Function Description
---------------------------
@@ -64,60 +69,84 @@ Member Function Description
- void **create** **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`int<class_int>` format, :ref:`int<class_int>` flags=7 **)**
Create a new :ref:`ImageTexture<class_imagetexture>` with "width" and "height".
"format" one of :ref:`Image<class_image>`.FORMAT\_\*.
"flags" one or more of :ref:`Texture<class_texture>`.FLAG\_\*.
.. _class_ImageTexture_create_from_image:
- void **create_from_image** **(** :ref:`Image<class_image>` image, :ref:`int<class_int>` flags=7 **)**
.. _class_ImageTexture_get_format:
- :ref:`int<class_int>` **get_format** **(** **)** const
.. _class_ImageTexture_load:
- void **load** **(** :ref:`String<class_string>` path **)**
.. _class_ImageTexture_set_data:
- void **set_data** **(** :ref:`Image<class_image>` image **)**
.. _class_ImageTexture_get_data:
- :ref:`Image<class_image>` **get_data** **(** **)** const
.. _class_ImageTexture_set_storage:
- void **set_storage** **(** :ref:`int<class_int>` mode **)**
.. _class_ImageTexture_get_storage:
- :ref:`int<class_int>` **get_storage** **(** **)** const
.. _class_ImageTexture_set_lossy_storage_quality:
- void **set_lossy_storage_quality** **(** :ref:`float<class_float>` quality **)**
.. _class_ImageTexture_get_lossy_storage_quality:
- :ref:`float<class_float>` **get_lossy_storage_quality** **(** **)** const
Create a new :ref:`ImageTexture<class_imagetexture>` from an :ref:`Image<class_image>` with "flags" from :ref:`Texture<class_texture>`.FLAG\_\*.
.. _class_ImageTexture_fix_alpha_edges:
- void **fix_alpha_edges** **(** **)**
.. _class_ImageTexture_premultiply_alpha:
.. _class_ImageTexture_get_data:
- void **premultiply_alpha** **(** **)**
- :ref:`Image<class_image>` **get_data** **(** **)** const
Return the :ref:`Image<class_image>` of this :ref:`ImageTexture<class_imagetexture>`.
.. _class_ImageTexture_get_format:
- :ref:`int<class_int>` **get_format** **(** **)** const
Return the format of the :ref:`ImageTexture<class_imagetexture>`, one of :ref:`Image<class_image>`.FORMAT\_\*.
.. _class_ImageTexture_get_lossy_storage_quality:
- :ref:`float<class_float>` **get_lossy_storage_quality** **(** **)** const
Return the storage quality for :ref:`ImageTexture<class_imagetexture>`.STORAGE_COMPRESS_LOSSY.
.. _class_ImageTexture_get_storage:
- :ref:`int<class_int>` **get_storage** **(** **)** const
Return the storage type. One of :ref:`ImageTexture<class_imagetexture>`.STORAGE\_\*.
.. _class_ImageTexture_load:
- void **load** **(** :ref:`String<class_string>` path **)**
Load an :ref:`ImageTexure<class_imagetexure>`.
.. _class_ImageTexture_normal_to_xy:
- void **normal_to_xy** **(** **)**
.. _class_ImageTexture_shrink_x2_and_keep_size:
.. _class_ImageTexture_premultiply_alpha:
- void **shrink_x2_and_keep_size** **(** **)**
- void **premultiply_alpha** **(** **)**
.. _class_ImageTexture_set_data:
- void **set_data** **(** :ref:`Image<class_image>` image **)**
Set the :ref:`Image<class_image>` of this :ref:`ImageTexture<class_imagetexture>`.
.. _class_ImageTexture_set_lossy_storage_quality:
- void **set_lossy_storage_quality** **(** :ref:`float<class_float>` quality **)**
Set the storage quality in case of :ref:`ImageTexture<class_imagetexture>`.STORAGE_COMPRESS_LOSSY.
.. _class_ImageTexture_set_size_override:
- void **set_size_override** **(** :ref:`Vector2<class_vector2>` size **)**
.. _class_ImageTexture_set_storage:
- void **set_storage** **(** :ref:`int<class_int>` mode **)**
Set the storage type. One of :ref:`ImageTexture<class_imagetexture>`.STORAGE\_\*.
.. _class_ImageTexture_shrink_x2_and_keep_size:
- void **shrink_x2_and_keep_size** **(** **)**

60
classes/class_immediategeometry.rst
View File

@@ -18,35 +18,55 @@ Brief Description
Member Functions
----------------
+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_sphere<class_ImmediateGeometry_add_sphere>` **(** :ref:`int<class_int>` lats, :ref:`int<class_int>` lons, :ref:`float<class_float>` radius **)** |
+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_vertex<class_ImmediateGeometry_add_vertex>` **(** :ref:`Vector3<class_vector3>` pos **)** |
+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`begin<class_ImmediateGeometry_begin>` **(** :ref:`int<class_int>` primitive, :ref:`Texture<class_texture>` texture **)** |
+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_ImmediateGeometry_clear>` **(** **)** |
+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`end<class_ImmediateGeometry_end>` **(** **)** |
+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_color<class_ImmediateGeometry_set_color>` **(** :ref:`Color<class_color>` color **)** |
+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_normal<class_ImmediateGeometry_set_normal>` **(** :ref:`Vector3<class_vector3>` normal **)** |
+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_tangent<class_ImmediateGeometry_set_tangent>` **(** :ref:`Plane<class_plane>` tangent **)** |
+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_color<class_ImmediateGeometry_set_color>` **(** :ref:`Color<class_color>` color **)** |
+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_uv<class_ImmediateGeometry_set_uv>` **(** :ref:`Vector2<class_vector2>` uv **)** |
+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_uv2<class_ImmediateGeometry_set_uv2>` **(** :ref:`Vector2<class_vector2>` uv **)** |
+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_vertex<class_ImmediateGeometry_add_vertex>` **(** :ref:`Vector3<class_vector3>` pos **)** |
+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_sphere<class_ImmediateGeometry_add_sphere>` **(** :ref:`int<class_int>` lats, :ref:`int<class_int>` lons, :ref:`float<class_float>` radius **)** |
+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`end<class_ImmediateGeometry_end>` **(** **)** |
+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear<class_ImmediateGeometry_clear>` **(** **)** |
+-------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
Member Function Description
---------------------------
.. _class_ImmediateGeometry_add_sphere:
- void **add_sphere** **(** :ref:`int<class_int>` lats, :ref:`int<class_int>` lons, :ref:`float<class_float>` radius **)**
.. _class_ImmediateGeometry_add_vertex:
- void **add_vertex** **(** :ref:`Vector3<class_vector3>` pos **)**
.. _class_ImmediateGeometry_begin:
- void **begin** **(** :ref:`int<class_int>` primitive, :ref:`Texture<class_texture>` texture **)**
.. _class_ImmediateGeometry_clear:
- void **clear** **(** **)**
.. _class_ImmediateGeometry_end:
- void **end** **(** **)**
.. _class_ImmediateGeometry_set_color:
- void **set_color** **(** :ref:`Color<class_color>` color **)**
.. _class_ImmediateGeometry_set_normal:
- void **set_normal** **(** :ref:`Vector3<class_vector3>` normal **)**
@@ -55,10 +75,6 @@ Member Function Description
- void **set_tangent** **(** :ref:`Plane<class_plane>` tangent **)**
.. _class_ImmediateGeometry_set_color:
- void **set_color** **(** :ref:`Color<class_color>` color **)**
.. _class_ImmediateGeometry_set_uv:
- void **set_uv** **(** :ref:`Vector2<class_vector2>` uv **)**
@@ -67,20 +83,4 @@ Member Function Description
- void **set_uv2** **(** :ref:`Vector2<class_vector2>` uv **)**
.. _class_ImmediateGeometry_add_vertex:
- void **add_vertex** **(** :ref:`Vector3<class_vector3>` pos **)**
.. _class_ImmediateGeometry_add_sphere:
- void **add_sphere** **(** :ref:`int<class_int>` lats, :ref:`int<class_int>` lons, :ref:`float<class_float>` radius **)**
.. _class_ImmediateGeometry_end:
- void **end** **(** **)**
.. _class_ImmediateGeometry_clear:
- void **clear** **(** **)**

256
classes/class_input.rst
View File

@@ -20,45 +20,45 @@ A Singleton that deals with inputs.
Member Functions
----------------
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_key_pressed<class_Input_is_key_pressed>` **(** :ref:`int<class_int>` scancode **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_mouse_button_pressed<class_Input_is_mouse_button_pressed>` **(** :ref:`int<class_int>` button **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_joy_button_pressed<class_Input_is_joy_button_pressed>` **(** :ref:`int<class_int>` device, :ref:`int<class_int>` button **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_action_pressed<class_Input_is_action_pressed>` **(** :ref:`String<class_string>` action **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_joy_mapping<class_Input_add_joy_mapping>` **(** :ref:`String<class_string>` mapping, :ref:`bool<class_bool>` update_existing=false **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_joy_mapping<class_Input_remove_joy_mapping>` **(** :ref:`String<class_string>` guid **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_joy_known<class_Input_is_joy_known>` **(** :ref:`int<class_int>` device **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_joy_axis<class_Input_get_joy_axis>` **(** :ref:`int<class_int>` device, :ref:`int<class_int>` axis **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_joy_name<class_Input_get_joy_name>` **(** :ref:`int<class_int>` device **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_joy_guid<class_Input_get_joy_guid>` **(** :ref:`int<class_int>` device **)** const |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_accelerometer<class_Input_get_accelerometer>` **(** **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_mouse_speed<class_Input_get_mouse_speed>` **(** **)** const |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_mouse_button_mask<class_Input_get_mouse_button_mask>` **(** **)** const |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_mouse_mode<class_Input_set_mouse_mode>` **(** :ref:`int<class_int>` mode **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_mouse_mode<class_Input_get_mouse_mode>` **(** **)** const |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`warp_mouse_pos<class_Input_warp_mouse_pos>` **(** :ref:`Vector2<class_vector2>` to **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`action_press<class_Input_action_press>` **(** :ref:`String<class_string>` action **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`action_release<class_Input_action_release>` **(** :ref:`String<class_string>` action **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_joy_mapping<class_Input_add_joy_mapping>` **(** :ref:`String<class_string>` mapping, :ref:`bool<class_bool>` update_existing=false **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_vector3>` | :ref:`get_accelerometer<class_Input_get_accelerometer>` **(** **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`get_joy_axis<class_Input_get_joy_axis>` **(** :ref:`int<class_int>` device, :ref:`int<class_int>` axis **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_joy_guid<class_Input_get_joy_guid>` **(** :ref:`int<class_int>` device **)** const |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_joy_name<class_Input_get_joy_name>` **(** :ref:`int<class_int>` device **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_mouse_button_mask<class_Input_get_mouse_button_mask>` **(** **)** const |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_mouse_mode<class_Input_get_mouse_mode>` **(** **)** const |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_vector2>` | :ref:`get_mouse_speed<class_Input_get_mouse_speed>` **(** **)** const |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_action_pressed<class_Input_is_action_pressed>` **(** :ref:`String<class_string>` action **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_joy_button_pressed<class_Input_is_joy_button_pressed>` **(** :ref:`int<class_int>` device, :ref:`int<class_int>` button **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_joy_known<class_Input_is_joy_known>` **(** :ref:`int<class_int>` device **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_key_pressed<class_Input_is_key_pressed>` **(** :ref:`int<class_int>` scancode **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_mouse_button_pressed<class_Input_is_mouse_button_pressed>` **(** :ref:`int<class_int>` button **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_joy_mapping<class_Input_remove_joy_mapping>` **(** :ref:`String<class_string>` guid **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_custom_mouse_cursor<class_Input_set_custom_mouse_cursor>` **(** :ref:`Texture<class_texture>` image, :ref:`Vector2<class_vector2>` hotspot=Vector2(0,0) **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_mouse_mode<class_Input_set_mouse_mode>` **(** :ref:`int<class_int>` mode **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`warp_mouse_pos<class_Input_warp_mouse_pos>` **(** :ref:`Vector2<class_vector2>` to **)** |
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Signals
-------
@@ -80,102 +80,6 @@ A Singleton that deals with inputs. This includes key presses, mouse buttons and
Member Function Description
---------------------------
.. _class_Input_is_key_pressed:
- :ref:`bool<class_bool>` **is_key_pressed** **(** :ref:`int<class_int>` scancode **)**
Returns true or false depending on whether the key is pressed or not. You can pass KEY\_\*, which are pre-defined constants listed in :ref:`@Global Scope<class_@global scope>`.
.. _class_Input_is_mouse_button_pressed:
- :ref:`bool<class_bool>` **is_mouse_button_pressed** **(** :ref:`int<class_int>` button **)**
Returns true or false depending on whether mouse button is pressed or not. You can pass BUTTON\_\*, which are pre-defined constants listed in :ref:`@Global Scope<class_@global scope>`.
.. _class_Input_is_joy_button_pressed:
- :ref:`bool<class_bool>` **is_joy_button_pressed** **(** :ref:`int<class_int>` device, :ref:`int<class_int>` button **)**
Returns if the joystick button at the given index is currently pressed. (see JOY\_\* constants in :ref:`@Global Scope<class_@global scope>`)
.. _class_Input_is_action_pressed:
- :ref:`bool<class_bool>` **is_action_pressed** **(** :ref:`String<class_string>` action **)**
Returns true or false depending on whether the action event is pressed. Actions and their events can be set in the Project Settings / Input Map tab. Or be set with :ref:`InputMap<class_inputmap>`.
.. _class_Input_add_joy_mapping:
- void **add_joy_mapping** **(** :ref:`String<class_string>` mapping, :ref:`bool<class_bool>` update_existing=false **)**
Add a new mapping entry (in SDL2 format) to the mapping database. Optionally update already connected devices.
.. _class_Input_remove_joy_mapping:
- void **remove_joy_mapping** **(** :ref:`String<class_string>` guid **)**
Removes all mappings from the internal db that match the given uid.
.. _class_Input_is_joy_known:
- :ref:`bool<class_bool>` **is_joy_known** **(** :ref:`int<class_int>` device **)**
Returns if the specified device is known by the system. This means that it sets all button and axis indices exactly as defined in the JOY\_\* constants (see :ref:`@Global Scope<class_@global scope>`). Unknown joysticks are not expected to match these constants, but you can still retrieve events from them.
.. _class_Input_get_joy_axis:
- :ref:`float<class_float>` **get_joy_axis** **(** :ref:`int<class_int>` device, :ref:`int<class_int>` axis **)**
Returns the current value of the joystick axis at given index (see JOY\_\* constants in :ref:`@Global Scope<class_@global scope>`)
.. _class_Input_get_joy_name:
- :ref:`String<class_string>` **get_joy_name** **(** :ref:`int<class_int>` device **)**
Returns the name of the joystick at the specified device index
.. _class_Input_get_joy_guid:
- :ref:`String<class_string>` **get_joy_guid** **(** :ref:`int<class_int>` device **)** const
Returns a SDL2 compatible device guid on platforms that use gamepad remapping. Returns "Default Gamepad" otherwise.
.. _class_Input_get_accelerometer:
- :ref:`Vector3<class_vector3>` **get_accelerometer** **(** **)**
If the device has an accelerometer, this will return the movement.
.. _class_Input_get_mouse_speed:
- :ref:`Vector2<class_vector2>` **get_mouse_speed** **(** **)** const
Returns the mouse speed.
.. _class_Input_get_mouse_button_mask:
- :ref:`int<class_int>` **get_mouse_button_mask** **(** **)** const
Returns mouse buttons as a bitmask. If multiple mouse buttons are pressed at the same time the bits are added together.
.. _class_Input_set_mouse_mode:
- void **set_mouse_mode** **(** :ref:`int<class_int>` mode **)**
Set the mouse mode. See the constants for more information.
.. _class_Input_get_mouse_mode:
- :ref:`int<class_int>` **get_mouse_mode** **(** **)** const
Return the mouse mode. See the constants for more information.
.. _class_Input_warp_mouse_pos:
- void **warp_mouse_pos** **(** :ref:`Vector2<class_vector2>` to **)**
Sets the mouse position to the specified vector.
.. _class_Input_action_press:
- void **action_press** **(** :ref:`String<class_string>` action **)**
@@ -188,10 +92,106 @@ This will simulate pressing the specificed action.
If the specified action is already pressed, this will release it.
.. _class_Input_add_joy_mapping:
- void **add_joy_mapping** **(** :ref:`String<class_string>` mapping, :ref:`bool<class_bool>` update_existing=false **)**
Add a new mapping entry (in SDL2 format) to the mapping database. Optionally update already connected devices.
.. _class_Input_get_accelerometer:
- :ref:`Vector3<class_vector3>` **get_accelerometer** **(** **)**
If the device has an accelerometer, this will return the movement.
.. _class_Input_get_joy_axis:
- :ref:`float<class_float>` **get_joy_axis** **(** :ref:`int<class_int>` device, :ref:`int<class_int>` axis **)**
Returns the current value of the joystick axis at given index (see JOY\_\* constants in :ref:`@Global Scope<class_@global scope>`)
.. _class_Input_get_joy_guid:
- :ref:`String<class_string>` **get_joy_guid** **(** :ref:`int<class_int>` device **)** const
Returns a SDL2 compatible device guid on platforms that use gamepad remapping. Returns "Default Gamepad" otherwise.
.. _class_Input_get_joy_name:
- :ref:`String<class_string>` **get_joy_name** **(** :ref:`int<class_int>` device **)**
Returns the name of the joystick at the specified device index
.. _class_Input_get_mouse_button_mask:
- :ref:`int<class_int>` **get_mouse_button_mask** **(** **)** const
Returns mouse buttons as a bitmask. If multiple mouse buttons are pressed at the same time the bits are added together.
.. _class_Input_get_mouse_mode:
- :ref:`int<class_int>` **get_mouse_mode** **(** **)** const
Return the mouse mode. See the constants for more information.
.. _class_Input_get_mouse_speed:
- :ref:`Vector2<class_vector2>` **get_mouse_speed** **(** **)** const
Returns the mouse speed.
.. _class_Input_is_action_pressed:
- :ref:`bool<class_bool>` **is_action_pressed** **(** :ref:`String<class_string>` action **)**
Returns true or false depending on whether the action event is pressed. Actions and their events can be set in the Project Settings / Input Map tab. Or be set with :ref:`InputMap<class_inputmap>`.
.. _class_Input_is_joy_button_pressed:
- :ref:`bool<class_bool>` **is_joy_button_pressed** **(** :ref:`int<class_int>` device, :ref:`int<class_int>` button **)**
Returns if the joystick button at the given index is currently pressed. (see JOY\_\* constants in :ref:`@Global Scope<class_@global scope>`)
.. _class_Input_is_joy_known:
- :ref:`bool<class_bool>` **is_joy_known** **(** :ref:`int<class_int>` device **)**
Returns if the specified device is known by the system. This means that it sets all button and axis indices exactly as defined in the JOY\_\* constants (see :ref:`@Global Scope<class_@global scope>`). Unknown joysticks are not expected to match these constants, but you can still retrieve events from them.
.. _class_Input_is_key_pressed:
- :ref:`bool<class_bool>` **is_key_pressed** **(** :ref:`int<class_int>` scancode **)**
Returns true or false depending on whether the key is pressed or not. You can pass KEY\_\*, which are pre-defined constants listed in :ref:`@Global Scope<class_@global scope>`.
.. _class_Input_is_mouse_button_pressed:
- :ref:`bool<class_bool>` **is_mouse_button_pressed** **(** :ref:`int<class_int>` button **)**
Returns true or false depending on whether mouse button is pressed or not. You can pass BUTTON\_\*, which are pre-defined constants listed in :ref:`@Global Scope<class_@global scope>`.
.. _class_Input_remove_joy_mapping:
- void **remove_joy_mapping** **(** :ref:`String<class_string>` guid **)**
Removes all mappings from the internal db that match the given uid.
.. _class_Input_set_custom_mouse_cursor:
- void **set_custom_mouse_cursor** **(** :ref:`Texture<class_texture>` image, :ref:`Vector2<class_vector2>` hotspot=Vector2(0,0) **)**
Set a custom mouse cursor image, which is only visible inside the game window. The hotspot can also be specified.
.. _class_Input_set_mouse_mode:
- void **set_mouse_mode** **(** :ref:`int<class_int>` mode **)**
Set the mouse mode. See the constants for more information.
.. _class_Input_warp_mouse_pos:
- void **warp_mouse_pos** **(** :ref:`Vector2<class_vector2>` to **)**
Sets the mouse position to the specified vector.

12
classes/class_inputevent.rst
View File

@@ -33,22 +33,22 @@ Member Functions
Member Variables
----------------
- :ref:`int<class_int>` **type**
- :ref:`int<class_int>` **device**
- :ref:`int<class_int>` **ID**
- :ref:`int<class_int>` **device**
- :ref:`int<class_int>` **type**
Numeric Constants
-----------------
- **NONE** = **0** --- Empty input event.
- **ACTION** = **8**
- **JOYSTICK_MOTION** = **4** --- Joystick motion event.
- **JOYSTICK_BUTTON** = **5** --- Joystick button event.
- **KEY** = **1** --- Key event.
- **MOUSE_MOTION** = **2** --- Mouse motion event.
- **MOUSE_BUTTON** = **3** --- Mouse button event.
- **JOYSTICK_MOTION** = **4** --- Joystick motion event.
- **JOYSTICK_BUTTON** = **5** --- Joystick button event.
- **NONE** = **0** --- Empty input event.
- **SCREEN_TOUCH** = **6**
- **SCREEN_DRAG** = **7**
- **ACTION** = **8**
Description
-----------

12
classes/class_inputeventaction.rst
View File

@@ -33,22 +33,22 @@ Member Functions
Member Variables
----------------
- :ref:`int<class_int>` **type**
- :ref:`int<class_int>` **device**
- :ref:`int<class_int>` **ID**
- :ref:`int<class_int>` **device**
- :ref:`int<class_int>` **type**
Numeric Constants
-----------------
- **NONE** = **0**
- **ACTION** = **8**
- **JOYSTICK_MOTION** = **4**
- **JOYSTICK_BUTTON** = **5**
- **KEY** = **1**
- **MOUSE_MOTION** = **2**
- **MOUSE_BUTTON** = **3**
- **JOYSTICK_MOTION** = **4**
- **JOYSTICK_BUTTON** = **5**
- **NONE** = **0**
- **SCREEN_TOUCH** = **6**
- **SCREEN_DRAG** = **7**
- **ACTION** = **8**
Member Function Description
---------------------------

12
classes/class_inputeventjoystickbutton.rst
View File

@@ -33,25 +33,25 @@ Member Functions
Member Variables
----------------
- :ref:`int<class_int>` **type**
- :ref:`int<class_int>` **device**
- :ref:`int<class_int>` **ID**
- :ref:`int<class_int>` **button_index**
- :ref:`int<class_int>` **device**
- :ref:`bool<class_bool>` **pressed**
- :ref:`float<class_float>` **pressure**
- :ref:`int<class_int>` **type**
Numeric Constants
-----------------
- **NONE** = **0**
- **ACTION** = **8**
- **JOYSTICK_MOTION** = **4**
- **JOYSTICK_BUTTON** = **5**
- **KEY** = **1**
- **MOUSE_MOTION** = **2**
- **MOUSE_BUTTON** = **3**
- **JOYSTICK_MOTION** = **4**
- **JOYSTICK_BUTTON** = **5**
- **NONE** = **0**
- **SCREEN_TOUCH** = **6**
- **SCREEN_DRAG** = **7**
- **ACTION** = **8**
Member Function Description
---------------------------

12
classes/class_inputeventjoystickmotion.rst
View File

@@ -33,24 +33,24 @@ Member Functions
Member Variables
----------------
- :ref:`int<class_int>` **type**
- :ref:`int<class_int>` **device**
- :ref:`int<class_int>` **ID**
- :ref:`int<class_int>` **axis**
- :ref:`int<class_int>` **device**
- :ref:`int<class_int>` **type**
- :ref:`float<class_float>` **value**
Numeric Constants
-----------------
- **NONE** = **0**
- **ACTION** = **8**
- **JOYSTICK_MOTION** = **4**
- **JOYSTICK_BUTTON** = **5**
- **KEY** = **1**
- **MOUSE_MOTION** = **2**
- **MOUSE_BUTTON** = **3**
- **JOYSTICK_MOTION** = **4**
- **JOYSTICK_BUTTON** = **5**
- **NONE** = **0**
- **SCREEN_TOUCH** = **6**
- **SCREEN_DRAG** = **7**
- **ACTION** = **8**
Member Function Description
---------------------------

16
classes/class_inputeventkey.rst
View File

@@ -33,30 +33,30 @@ Member Functions
Member Variables
----------------
- :ref:`int<class_int>` **type**
- :ref:`int<class_int>` **device**
- :ref:`int<class_int>` **ID**
- :ref:`bool<class_bool>` **shift**
- :ref:`bool<class_bool>` **alt**
- :ref:`bool<class_bool>` **control**
- :ref:`int<class_int>` **device**
- :ref:`bool<class_bool>` **echo**
- :ref:`bool<class_bool>` **meta**
- :ref:`bool<class_bool>` **pressed**
- :ref:`bool<class_bool>` **echo**
- :ref:`int<class_int>` **scancode**
- :ref:`bool<class_bool>` **shift**
- :ref:`int<class_int>` **type**
- :ref:`int<class_int>` **unicode**
Numeric Constants
-----------------
- **NONE** = **0**
- **ACTION** = **8**
- **JOYSTICK_MOTION** = **4**
- **JOYSTICK_BUTTON** = **5**
- **KEY** = **1**
- **MOUSE_MOTION** = **2**
- **MOUSE_BUTTON** = **3**
- **JOYSTICK_MOTION** = **4**
- **JOYSTICK_BUTTON** = **5**
- **NONE** = **0**
- **SCREEN_TOUCH** = **6**
- **SCREEN_DRAG** = **7**
- **ACTION** = **8**
Member Function Description
---------------------------

30
classes/class_inputeventmousebutton.rst
View File

@@ -33,36 +33,36 @@ Member Functions
Member Variables
----------------
- :ref:`int<class_int>` **type**
- :ref:`int<class_int>` **device**
- :ref:`int<class_int>` **ID**
- :ref:`bool<class_bool>` **shift**
- :ref:`bool<class_bool>` **alt**
- :ref:`bool<class_bool>` **control**
- :ref:`bool<class_bool>` **meta**
- :ref:`int<class_int>` **button_index**
- :ref:`int<class_int>` **button_mask**
- :ref:`int<class_int>` **x**
- :ref:`int<class_int>` **y**
- :ref:`Vector2<class_vector2>` **pos**
- :ref:`bool<class_bool>` **control**
- :ref:`int<class_int>` **device**
- :ref:`bool<class_bool>` **doubleclick**
- :ref:`Vector2<class_vector2>` **global_pos**
- :ref:`int<class_int>` **global_x**
- :ref:`int<class_int>` **global_y**
- :ref:`Vector2<class_vector2>` **global_pos**
- :ref:`int<class_int>` **button_index**
- :ref:`bool<class_bool>` **meta**
- :ref:`Vector2<class_vector2>` **pos**
- :ref:`bool<class_bool>` **pressed**
- :ref:`bool<class_bool>` **doubleclick**
- :ref:`bool<class_bool>` **shift**
- :ref:`int<class_int>` **type**
- :ref:`int<class_int>` **x**
- :ref:`int<class_int>` **y**
Numeric Constants
-----------------
- **NONE** = **0**
- **ACTION** = **8**
- **JOYSTICK_MOTION** = **4**
- **JOYSTICK_BUTTON** = **5**
- **KEY** = **1**
- **MOUSE_MOTION** = **2**
- **MOUSE_BUTTON** = **3**
- **JOYSTICK_MOTION** = **4**
- **JOYSTICK_BUTTON** = **5**
- **NONE** = **0**
- **SCREEN_TOUCH** = **6**
- **SCREEN_DRAG** = **7**
- **ACTION** = **8**
Member Function Description
---------------------------

30
classes/class_inputeventmousemotion.rst
View File

@@ -33,39 +33,39 @@ Member Functions
Member Variables
----------------
- :ref:`int<class_int>` **type**
- :ref:`int<class_int>` **device**
- :ref:`int<class_int>` **ID**
- :ref:`bool<class_bool>` **shift**
- :ref:`bool<class_bool>` **alt**
- :ref:`bool<class_bool>` **control**
- :ref:`bool<class_bool>` **meta**
- :ref:`int<class_int>` **button_mask**
- :ref:`int<class_int>` **x**
- :ref:`int<class_int>` **y**
- :ref:`Vector2<class_vector2>` **pos**
- :ref:`bool<class_bool>` **control**
- :ref:`int<class_int>` **device**
- :ref:`Vector2<class_vector2>` **global_pos**
- :ref:`int<class_int>` **global_x**
- :ref:`int<class_int>` **global_y**
- :ref:`Vector2<class_vector2>` **global_pos**
- :ref:`bool<class_bool>` **meta**
- :ref:`Vector2<class_vector2>` **pos**
- :ref:`Vector2<class_vector2>` **relative_pos**
- :ref:`int<class_int>` **relative_x**
- :ref:`int<class_int>` **relative_y**
- :ref:`Vector2<class_vector2>` **relative_pos**
- :ref:`bool<class_bool>` **shift**
- :ref:`Vector2<class_vector2>` **speed**
- :ref:`float<class_float>` **speed_x**
- :ref:`float<class_float>` **speed_y**
- :ref:`Vector2<class_vector2>` **speed**
- :ref:`int<class_int>` **type**
- :ref:`int<class_int>` **x**
- :ref:`int<class_int>` **y**
Numeric Constants
-----------------
- **NONE** = **0**
- **ACTION** = **8**
- **JOYSTICK_MOTION** = **4**
- **JOYSTICK_BUTTON** = **5**
- **KEY** = **1**
- **MOUSE_MOTION** = **2**
- **MOUSE_BUTTON** = **3**
- **JOYSTICK_MOTION** = **4**
- **JOYSTICK_BUTTON** = **5**
- **NONE** = **0**
- **SCREEN_TOUCH** = **6**
- **SCREEN_DRAG** = **7**
- **ACTION** = **8**
Member Function Description
---------------------------

20
classes/class_inputeventscreendrag.rst
View File

@@ -33,32 +33,32 @@ Member Functions
Member Variables
----------------
- :ref:`int<class_int>` **type**
- :ref:`int<class_int>` **device**
- :ref:`int<class_int>` **ID**
- :ref:`int<class_int>` **device**
- :ref:`int<class_int>` **index**
- :ref:`float<class_float>` **x**
- :ref:`float<class_float>` **y**
- :ref:`Vector2<class_vector2>` **pos**
- :ref:`Vector2<class_vector2>` **relative_pos**
- :ref:`float<class_float>` **relative_x**
- :ref:`float<class_float>` **relative_y**
- :ref:`Vector2<class_vector2>` **relative_pos**
- :ref:`Vector2<class_vector2>` **speed**
- :ref:`float<class_float>` **speed_x**
- :ref:`float<class_float>` **speed_y**
- :ref:`Vector2<class_vector2>` **speed**
- :ref:`int<class_int>` **type**
- :ref:`float<class_float>` **x**
- :ref:`float<class_float>` **y**
Numeric Constants
-----------------
- **NONE** = **0**
- **ACTION** = **8**
- **JOYSTICK_MOTION** = **4**
- **JOYSTICK_BUTTON** = **5**
- **KEY** = **1**
- **MOUSE_MOTION** = **2**
- **MOUSE_BUTTON** = **3**
- **JOYSTICK_MOTION** = **4**
- **JOYSTICK_BUTTON** = **5**
- **NONE** = **0**
- **SCREEN_TOUCH** = **6**
- **SCREEN_DRAG** = **7**
- **ACTION** = **8**
Member Function Description
---------------------------

16
classes/class_inputeventscreentouch.rst
View File

@@ -33,27 +33,27 @@ Member Functions
Member Variables
----------------
- :ref:`int<class_int>` **type**
- :ref:`int<class_int>` **device**
- :ref:`int<class_int>` **ID**
- :ref:`int<class_int>` **device**
- :ref:`int<class_int>` **index**
- :ref:`float<class_float>` **x**
- :ref:`float<class_float>` **y**
- :ref:`Vector2<class_vector2>` **pos**
- :ref:`bool<class_bool>` **pressed**
- :ref:`int<class_int>` **type**
- :ref:`float<class_float>` **x**
- :ref:`float<class_float>` **y**
Numeric Constants
-----------------
- **NONE** = **0**
- **ACTION** = **8**
- **JOYSTICK_MOTION** = **4**
- **JOYSTICK_BUTTON** = **5**
- **KEY** = **1**
- **MOUSE_MOTION** = **2**
- **MOUSE_BUTTON** = **3**
- **JOYSTICK_MOTION** = **4**
- **JOYSTICK_BUTTON** = **5**
- **NONE** = **0**
- **SCREEN_TOUCH** = **6**
- **SCREEN_DRAG** = **7**
- **ACTION** = **8**
Member Function Description
---------------------------

72
classes/class_inputmap.rst
View File

@@ -19,27 +19,27 @@ Member Functions
----------------
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_action<class_InputMap_has_action>` **(** :ref:`String<class_string>` action **)** const |
| void | :ref:`action_add_event<class_InputMap_action_add_event>` **(** :ref:`String<class_string>` action, :ref:`InputEvent<class_inputevent>` event **)** |
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_action_id<class_InputMap_get_action_id>` **(** :ref:`String<class_string>` action **)** const |
| void | :ref:`action_erase_event<class_InputMap_action_erase_event>` **(** :ref:`String<class_string>` action, :ref:`InputEvent<class_inputevent>` event **)** |
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_action_from_id<class_InputMap_get_action_from_id>` **(** :ref:`int<class_int>` id **)** const |
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_actions<class_InputMap_get_actions>` **(** **)** |
| :ref:`bool<class_bool>` | :ref:`action_has_event<class_InputMap_action_has_event>` **(** :ref:`String<class_string>` action, :ref:`InputEvent<class_inputevent>` event **)** |
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_action<class_InputMap_add_action>` **(** :ref:`String<class_string>` action **)** |
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`erase_action<class_InputMap_erase_action>` **(** :ref:`String<class_string>` action **)** |
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`action_add_event<class_InputMap_action_add_event>` **(** :ref:`String<class_string>` action, :ref:`InputEvent<class_inputevent>` event **)** |
| :ref:`bool<class_bool>` | :ref:`event_is_action<class_InputMap_event_is_action>` **(** :ref:`InputEvent<class_inputevent>` event, :ref:`String<class_string>` action **)** const |
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`action_has_event<class_InputMap_action_has_event>` **(** :ref:`String<class_string>` action, :ref:`InputEvent<class_inputevent>` event **)** |
| :ref:`String<class_string>` | :ref:`get_action_from_id<class_InputMap_get_action_from_id>` **(** :ref:`int<class_int>` id **)** const |
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`action_erase_event<class_InputMap_action_erase_event>` **(** :ref:`String<class_string>` action, :ref:`InputEvent<class_inputevent>` event **)** |
| :ref:`int<class_int>` | :ref:`get_action_id<class_InputMap_get_action_id>` **(** :ref:`String<class_string>` action **)** const |
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_array>` | :ref:`get_action_list<class_InputMap_get_action_list>` **(** :ref:`String<class_string>` action **)** |
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`event_is_action<class_InputMap_event_is_action>` **(** :ref:`InputEvent<class_inputevent>` event, :ref:`String<class_string>` action **)** const |
| :ref:`Array<class_array>` | :ref:`get_actions<class_InputMap_get_actions>` **(** **)** |
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_action<class_InputMap_has_action>` **(** :ref:`String<class_string>` action **)** const |
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`load_from_globals<class_InputMap_load_from_globals>` **(** **)** |
+------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -52,29 +52,23 @@ Singleton that manages actions. InputMap has a list of the actions used in Input
Member Function Description
---------------------------
.. _class_InputMap_has_action:
.. _class_InputMap_action_add_event:
- :ref:`bool<class_bool>` **has_action** **(** :ref:`String<class_string>` action **)** const
- void **action_add_event** **(** :ref:`String<class_string>` action, :ref:`InputEvent<class_inputevent>` event **)**
Whether this InputMap has an action with name "action".
Add an :ref:`InputEvent<class_inputevent>` to action. This :ref:`InputEvent<class_inputevent>` will trigger the action.
.. _class_InputMap_get_action_id:
.. _class_InputMap_action_erase_event:
- :ref:`int<class_int>` **get_action_id** **(** :ref:`String<class_string>` action **)** const
- void **action_erase_event** **(** :ref:`String<class_string>` action, :ref:`InputEvent<class_inputevent>` event **)**
Return the id of an action.
Remove an :ref:`InputEvent<class_inputevent>` from an action.
.. _class_InputMap_get_action_from_id:
.. _class_InputMap_action_has_event:
- :ref:`String<class_string>` **get_action_from_id** **(** :ref:`int<class_int>` id **)** const
- :ref:`bool<class_bool>` **action_has_event** **(** :ref:`String<class_string>` action, :ref:`InputEvent<class_inputevent>` event **)**
Return the action from an id.
.. _class_InputMap_get_actions:
- :ref:`Array<class_array>` **get_actions** **(** **)**
Return an :ref:`Array<class_array>` of all actions in the :ref:`InputMap<class_inputmap>`.
Whether an action has an :ref:`InputEvent<class_inputevent>` associated with it.
.. _class_InputMap_add_action:
@@ -88,23 +82,21 @@ Add an action to the :ref:`InputMap<class_inputmap>`.
Remove an action from the :ref:`InputMap<class_inputmap>`.
.. _class_InputMap_action_add_event:
.. _class_InputMap_event_is_action:
- void **action_add_event** **(** :ref:`String<class_string>` action, :ref:`InputEvent<class_inputevent>` event **)**
- :ref:`bool<class_bool>` **event_is_action** **(** :ref:`InputEvent<class_inputevent>` event, :ref:`String<class_string>` action **)** const
Add an :ref:`InputEvent<class_inputevent>` to action. This :ref:`InputEvent<class_inputevent>` will trigger the action.
.. _class_InputMap_get_action_from_id:
.. _class_InputMap_action_has_event:
- :ref:`String<class_string>` **get_action_from_id** **(** :ref:`int<class_int>` id **)** const
- :ref:`bool<class_bool>` **action_has_event** **(** :ref:`String<class_string>` action, :ref:`InputEvent<class_inputevent>` event **)**
Return the action from an id.
Whether an action has an :ref:`InputEvent<class_inputevent>` associated with it.
.. _class_InputMap_get_action_id:
.. _class_InputMap_action_erase_event:
- :ref:`int<class_int>` **get_action_id** **(** :ref:`String<class_string>` action **)** const
- void **action_erase_event** **(** :ref:`String<class_string>` action, :ref:`InputEvent<class_inputevent>` event **)**
Remove an :ref:`InputEvent<class_inputevent>` from an action.
Return the id of an action.
.. _class_InputMap_get_action_list:
@@ -112,9 +104,17 @@ Remove an :ref:`InputEvent<class_inputevent>` from an action.
Return an :ref:`Array<class_array>` of :ref:`InputEvent<class_inputevent>`s associated with an action.
.. _class_InputMap_event_is_action:
.. _class_InputMap_get_actions:
- :ref:`bool<class_bool>` **event_is_action** **(** :ref:`InputEvent<class_inputevent>` event, :ref:`String<class_string>` action **)** const
- :ref:`Array<class_array>` **get_actions** **(** **)**
Return an :ref:`Array<class_array>` of all actions in the :ref:`InputMap<class_inputmap>`.
.. _class_InputMap_has_action:
- :ref:`bool<class_bool>` **has_action** **(** :ref:`String<class_string>` action **)** const
Whether this InputMap has an action with name "action".
.. _class_InputMap_load_from_globals:

12
classes/class_instanceplaceholder.rst
View File

@@ -18,21 +18,21 @@ Brief Description
Member Functions
----------------
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`replace_by_instance<class_InstancePlaceholder_replace_by_instance>` **(** :ref:`PackedScene<class_packedscene>` custom_scene=NULL **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_instance_path<class_InstancePlaceholder_get_instance_path>` **(** **)** const |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`replace_by_instance<class_InstancePlaceholder_replace_by_instance>` **(** :ref:`PackedScene<class_packedscene>` custom_scene=NULL **)** |
+------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
Member Function Description
---------------------------
.. _class_InstancePlaceholder_replace_by_instance:
- void **replace_by_instance** **(** :ref:`PackedScene<class_packedscene>` custom_scene=NULL **)**
.. _class_InstancePlaceholder_get_instance_path:
- :ref:`String<class_string>` **get_instance_path** **(** **)** const
.. _class_InstancePlaceholder_replace_by_instance:
- void **replace_by_instance** **(** :ref:`PackedScene<class_packedscene>` custom_scene=NULL **)**

20
classes/class_intarray.rst
View File

@@ -16,6 +16,8 @@ Integer Array.
Member Functions
----------------
+----------------------------------+-------------------------------------------------------------------------------------------------------+
| :ref:`IntArray<class_intarray>` | :ref:`IntArray<class_IntArray_IntArray>` **(** :ref:`Array<class_array>` from **)** |
+----------------------------------+-------------------------------------------------------------------------------------------------------+
| void | :ref:`push_back<class_IntArray_push_back>` **(** :ref:`int<class_int>` integer **)** |
+----------------------------------+-------------------------------------------------------------------------------------------------------+
@@ -25,8 +27,6 @@ Member Functions
+----------------------------------+-------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`size<class_IntArray_size>` **(** **)** |
+----------------------------------+-------------------------------------------------------------------------------------------------------+
| :ref:`IntArray<class_intarray>` | :ref:`IntArray<class_IntArray_IntArray>` **(** :ref:`Array<class_array>` from **)** |
+----------------------------------+-------------------------------------------------------------------------------------------------------+
Description
-----------
@@ -36,6 +36,12 @@ Integer Array. Array of integers. Can only contain integers. Optimized for memor
Member Function Description
---------------------------
.. _class_IntArray_IntArray:
- :ref:`IntArray<class_intarray>` **IntArray** **(** :ref:`Array<class_array>` from **)**
Create from a generic array.
.. _class_IntArray_push_back:
- void **push_back** **(** :ref:`int<class_int>` integer **)**
@@ -46,13 +52,13 @@ Append a value to the array.
- void **resize** **(** :ref:`int<class_int>` idx **)**
Resize the array.
Set the size of the :ref:`IntArray<class_intarray>`. If larger than the current size it will reserve some space beforehand, and if it is smaller it will cut off the array.
.. _class_IntArray_set:
- void **set** **(** :ref:`int<class_int>` idx, :ref:`int<class_int>` integer **)**
Set an index in the array.
Change the int at the given index.
.. _class_IntArray_size:
@@ -60,10 +66,4 @@ Set an index in the array.
Return the array size.
.. _class_IntArray_IntArray:
- :ref:`IntArray<class_intarray>` **IntArray** **(** :ref:`Array<class_array>` from **)**
Create from a generic array.

Some files were not shown because too many files have changed in this diff Show More